org.eclipse.swt.widgets

Class ExpandBar

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.swt.widgets.ExpandBar

All Implemented Interfaces:

Drawable

public class ExpandBar
extends Composite

Instances of this class support the layout of selectable expand bar items.

The item children that may be added to instances of this class must be of type ExpandItem.

Styles:

V_SCROLL

Events:

Expand, Collapse

IMPORTANT: This class is not intended to be subclassed.

Since:

3.2

See Also:

ExpandItem, ExpandEvent, ExpandListener, ExpandAdapter, ExpandBar snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ExpandItem	focusItem
(package private) int	hFont
(package private) int	itemCount
(package private) ExpandItem[]	items
(package private) int	spacing
(package private) int	yCurrentScroll

Fields inherited from class org.eclipse.swt.widgets.Composite

backgroundMode, layout, layoutCount, lpwp, tabList

Fields inherited from class org.eclipse.swt.widgets.Scrollable

horizontalBar, verticalBar

Fields inherited from class org.eclipse.swt.widgets.Control

accessible, background, backgroundImage, cursor, drawCount, font, foreground, handle, layoutData, menu, parent, region, toolTipText

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
ExpandBar(Composite parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExpandListener(ExpandListener listener) Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the ExpandListener interface.
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
(package private) void	createHandle()
(package private) void	createItem(ExpandItem item, int style, int index)
(package private) void	createWidget()
(package private) int	defaultBackground()
(package private) void	destroyItem(ExpandItem item)
(package private) void	drawThemeBackground(int hDC, int hwnd, RECT rect)
(package private) void	drawWidget(GC gc, RECT clipRect)
(package private) Control	findBackgroundControl()
(package private) Control	findThemeControl()
(package private) int	getBandHeight()
ExpandItem	getItem(int index) Returns the item at the given, zero-relative index in the receiver.
int	getItemCount() Returns the number of items contained in the receiver.
ExpandItem[]	getItems() Returns an array of ExpandItems which are the items in the receiver.
int	getSpacing() Returns the receiver's spacing.
int	indexOf(ExpandItem item) Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item.
(package private) boolean	isAppThemed()
(package private) void	layoutItems(int index, boolean setScrollbar)
(package private) void	releaseChildren(boolean destroy)
void	removeExpandListener(ExpandListener listener) Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.
(package private) void	reskinChildren(int flags)
(package private) void	setBackgroundPixel(int pixel)
void	setFont(Font font) Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.
(package private) void	setForegroundPixel(int pixel)
(package private) void	setScrollbar()
void	setSpacing(int spacing) Sets the receiver's spacing.
(package private) void	showFocus(boolean up)
(package private) void	showItem(ExpandItem item)
(package private) TCHAR	windowClass()
(package private) int	windowProc()
(package private) LRESULT	WM_KEYDOWN(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONUP(int wParam, int lParam)
(package private) LRESULT	WM_MOUSELEAVE(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEMOVE(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEWHEEL(int wParam, int lParam)
(package private) LRESULT	WM_PAINT(int wParam, int lParam)
(package private) LRESULT	WM_PRINTCLIENT(int wParam, int lParam)
(package private) LRESULT	WM_SETCURSOR(int wParam, int lParam)
(package private) LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	wmScroll(ScrollBar bar, boolean update, int hwnd, int msg, int wParam, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Composite

_getChildren, _getTabList, changed, checkBuffered, checkComposited, computeTabList, copyArea, drawBackground, findDeferredControl, findMenus, fixChildren, fixTabList, getBackgroundMode, getChildren, getChildrenCount, getLayout, getLayoutDeferred, getTabList, hooksKeys, isLayoutDeferred, layout, layout, layout, layout, layout, markLayout, minimumSize, redrawChildren, releaseParent, releaseWidget, removeControl, resizeChildren, resizeChildren, resizeEmbeddedHandle, sendResize, setBackgroundMode, setBounds, setFocus, setLayout, setLayoutDeferred, setResizeChildren, setTabGroupFocus, setTabList, toolTipText, translateMnemonic, translateTraversal, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateLayout, updateLayout, updateOrientation, updateUIState, widgetStyle, WM_ERASEBKGND, WM_GETDLGCODE, WM_GETFONT, WM_NCHITTEST, WM_PARENTNOTIFY, WM_SETFONT, WM_SYSCOLORCHANGE, WM_SYSCOMMAND, WM_UPDATEUISTATE, wmNCPaint, wmNotify

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, createScrollBar, destroyScrollBar, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, scrolledHandle, widgetExtStyle, WM_HSCROLL, WM_VSCROLL, wmScrollWheel

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, borderHandle, checkBackground, checkBorder, checkGesture, checkHandle, checkMirrored, computeSize, computeTabGroup, computeTabRoot, defaultFont, defaultForeground, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, enableDrag, enableWidget, fillBackground, fillImageBackground, fillThemeBackground, findBrush, findCursor, findImageControl, findMnemonic, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, mapEvent, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, register, releaseHandle, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBackgroundImage, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRadioFocus, setRadioSelection, setRedraw, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, subclass, toControl, toControl, toDisplay, toDisplay, topHandle, translateAccelerator, translateMnemonic, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, unsubclass, update, update, updateImages, widgetCreateStruct, widgetParent, windowProc, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CHAR, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_GESTURE, WM_GETMINMAXINFO, WM_GETOBJECT, WM_HELP, WM_HOTKEY, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, WM_KEYUP, WM_LBUTTONDBLCLK, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSEHWHEEL, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PALETTECHANGED, WM_PASTE, WM_PRINT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TIMER, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmColorChild, wmCommandChild, wmDrawChild, wmMeasureChild, wmNotifyChild, wmScrollChild

Methods inherited from class org.eclipse.swt.widgets.Widget

_addListener, addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, removeDisposeListener, removeListener, removeListener, reskin, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

items

ExpandItem[] items

itemCount

int itemCount

focusItem

ExpandItem focusItem

spacing

int spacing

yCurrentScroll

int yCurrentScroll

hFont

int hFont

Constructor Detail

ExpandBar

public ExpandBar(Composite parent,
         int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.V_SCROLL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

addExpandListener

public void addExpandListener(ExpandListener listener)

Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the ExpandListener interface.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

ExpandListener, removeExpandListener(org.eclipse.swt.events.ExpandListener)

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

Overrides:

callWindowProc in class Scrollable

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Overrides:

checkSubclass in class Composite

checkStyle

static int checkStyle(int style)

computeSize

public Point computeSize(int wHint,
                int hHint,
                boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

Overrides:

computeSize in class Composite

Parameters:

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

changed - true if the control's contents have changed, and false otherwise

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(boolean), "computeTrim, getClientArea for controls that implement them"

createHandle

void createHandle()

Overrides:

createHandle in class Composite

createItem

void createItem(ExpandItem item,
              int style,
              int index)

createWidget

void createWidget()

Overrides:

createWidget in class Scrollable

defaultBackground

int defaultBackground()

Overrides:

defaultBackground in class Control

destroyItem

void destroyItem(ExpandItem item)

drawThemeBackground

void drawThemeBackground(int hDC,
                       int hwnd,
                       RECT rect)

Overrides:

drawThemeBackground in class Control

drawWidget

void drawWidget(GC gc,
              RECT clipRect)

findBackgroundControl

Control findBackgroundControl()

Overrides:

findBackgroundControl in class Control

findThemeControl

Control findThemeControl()

Overrides:

findThemeControl in class Control

getBandHeight

int getBandHeight()

getItem

public ExpandItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:

index - the index of the item to return

Returns:

the item at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver.

Returns:

the number of items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

public ExpandItem[] getItems()

Returns an array of ExpandItems which are the items in the receiver.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

Returns:

the items in the receiver

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSpacing

public int getSpacing()

Returns the receiver's spacing.

Returns:

the spacing

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

indexOf

public int indexOf(ExpandItem item)

Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

Parameters:

item - the search item

Returns:

the index of the item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

isAppThemed

boolean isAppThemed()

layoutItems

void layoutItems(int index,
               boolean setScrollbar)

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Composite

removeExpandListener

public void removeExpandListener(ExpandListener listener)

Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

ExpandListener, addExpandListener(org.eclipse.swt.events.ExpandListener)

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Composite

setBackgroundPixel

void setBackgroundPixel(int pixel)

Overrides:

setBackgroundPixel in class Control

setFont

public void setFont(Font font)

Description copied from class: Control

Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.

Overrides:

setFont in class Control

Parameters:

font - the new font (or null)

setForegroundPixel

void setForegroundPixel(int pixel)

Overrides:

setForegroundPixel in class Control

setScrollbar

void setScrollbar()

setSpacing

public void setSpacing(int spacing)

Sets the receiver's spacing. Spacing specifies the number of pixels allocated around each item.

Parameters:

spacing - the spacing around each item

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

showItem

void showItem(ExpandItem item)

showFocus

void showFocus(boolean up)

windowClass

TCHAR windowClass()

Overrides:

windowClass in class Scrollable

windowProc

int windowProc()

Overrides:

windowProc in class Scrollable

WM_KEYDOWN

LRESULT WM_KEYDOWN(int wParam,
                 int lParam)

Overrides:

WM_KEYDOWN in class Control

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_LBUTTONDOWN in class Composite

WM_LBUTTONUP

LRESULT WM_LBUTTONUP(int wParam,
                   int lParam)

Overrides:

WM_LBUTTONUP in class Control

WM_MOUSELEAVE

LRESULT WM_MOUSELEAVE(int wParam,
                    int lParam)

Overrides:

WM_MOUSELEAVE in class Control

WM_MOUSEMOVE

LRESULT WM_MOUSEMOVE(int wParam,
                   int lParam)

Overrides:

WM_MOUSEMOVE in class Control

WM_MOUSEWHEEL

LRESULT WM_MOUSEWHEEL(int wParam,
                    int lParam)

Overrides:

WM_MOUSEWHEEL in class Scrollable

WM_PAINT

LRESULT WM_PAINT(int wParam,
               int lParam)

Overrides:

WM_PAINT in class Composite

WM_PRINTCLIENT

LRESULT WM_PRINTCLIENT(int wParam,
                     int lParam)

Overrides:

WM_PRINTCLIENT in class Composite

WM_SETCURSOR

LRESULT WM_SETCURSOR(int wParam,
                   int lParam)

Overrides:

WM_SETCURSOR in class Control

WM_SETFOCUS

LRESULT WM_SETFOCUS(int wParam,
                  int lParam)

Overrides:

WM_SETFOCUS in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Composite

wmScroll

LRESULT wmScroll(ScrollBar bar,
               boolean update,
               int hwnd,
               int msg,
               int wParam,
               int lParam)

Overrides:

wmScroll in class Scrollable