org.eclipse.swt.widgets

Class ExpandItem

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Item

org.eclipse.swt.widgets.ExpandItem

public class ExpandItem
extends Item

Instances of this class represent a selectable user interface object that represents a expandable item in a expand bar.

Styles:

(none)

Events:

(none)

IMPORTANT: This class is not intended to be subclassed.

Since:

3.2

See Also:

ExpandBar, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	BORDER
(package private) static int	CHEVRON_SIZE
(package private) Control	control
(package private) boolean	expanded
(package private) int	height
(package private) boolean	hover
(package private) int	imageHeight
(package private) int	imageWidth
(package private) ExpandBar	parent
(package private) static int	TEXT_INSET
(package private) int	width
(package private) int	x
(package private) int	y

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

image, text

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
ExpandItem(ExpandBar parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
ExpandItem(ExpandBar parent, int style, int index) Constructs a new instance of this class given its parent, a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static ExpandBar	checkNull(ExpandBar control)
(package private) void	destroyWidget() Destroys the widget in the operating system and releases the widget's handle.
private void	drawChevron(int hDC, RECT rect)
(package private) void	drawItem(GC gc, int hTheme, RECT clipRect, boolean drawFocus)
Control	getControl() Returns the control that is shown when the item is expanded.
boolean	getExpanded() Returns true if the receiver is expanded, and false otherwise.
int	getHeaderHeight() Returns the height of the receiver's header
int	getHeight() Gets the height of the receiver.
ExpandBar	getParent() Returns the receiver's parent, which must be a ExpandBar.
(package private) int	getPreferredWidth(int hTheme, int hDC)
(package private) boolean	isHover(int x, int y)
(package private) void	redraw(boolean all)
(package private) void	releaseHandle()
(package private) void	releaseWidget()
(package private) void	setBounds(int x, int y, int width, int height, boolean move, boolean size)
void	setControl(Control control) Sets the control that is shown when the item is expanded.
void	setExpanded(boolean expanded) Sets the expanded state of the receiver.
void	setHeight(int height) Sets the height of the receiver.
void	setImage(Image image) Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
void	setText(java.lang.String string) Sets the receiver's text.

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

checkSubclass, getImage, getNameText, getText

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

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, releaseChildren, releaseParent, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, 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

parent

ExpandBar parent

control

Control control

expanded

boolean expanded

hover

boolean hover

x

int x

y

int y

width

int width

height

int height

imageHeight

int imageHeight

imageWidth

int imageWidth

TEXT_INSET

static final int TEXT_INSET

See Also:

Constant Field Values

BORDER

static final int BORDER

See Also:

Constant Field Values

CHEVRON_SIZE

static final int CHEVRON_SIZE

See Also:

Constant Field Values

Constructor Detail

ExpandItem

public ExpandItem(ExpandBar 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:

Widget.checkSubclass(), Widget.getStyle()

ExpandItem

public ExpandItem(ExpandBar parent,
          int style,
          int index)

Constructs a new instance of this class given its parent, a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

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

index - the zero-relative index to store the receiver in its parent

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null
• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)

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:

Widget.checkSubclass(), Widget.getStyle()

Method Detail

checkNull

static ExpandBar checkNull(ExpandBar control)

drawChevron

private void drawChevron(int hDC,
               RECT rect)

drawItem

void drawItem(GC gc,
            int hTheme,
            RECT clipRect,
            boolean drawFocus)

destroyWidget

void destroyWidget()

Description copied from class: Widget

Destroys the widget in the operating system and releases the widget's handle. If the widget does not have a handle, this method may hide the widget, mark the widget as destroyed or do nothing, depending on the widget.

When a widget is destroyed in the operating system, its descendants are also destroyed by the operating system. This means that it is only necessary to call destroyWidget on the root of the widget tree.

This method is called after releaseWidget().

See also releaseChild(), releaseWidget() and releaseHandle().

Overrides:

destroyWidget in class Widget

See Also:

Widget.dispose()

getControl

public Control getControl()

Returns the control that is shown when the item is expanded. If no control has been set, return null.

Returns:

the control

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

getExpanded

public boolean getExpanded()

Returns true if the receiver is expanded, and false otherwise.

Returns:

the expanded state

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

getHeaderHeight

public int getHeaderHeight()

Returns the height of the receiver's header

Returns:

the height of the header

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

getHeight

public int getHeight()

Gets the height of the receiver.

Returns:

the height

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

getParent

public ExpandBar getParent()

Returns the receiver's parent, which must be a ExpandBar.

Returns:

the receiver's parent

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

getPreferredWidth

int getPreferredWidth(int hTheme,
                    int hDC)

isHover

boolean isHover(int x,
              int y)

redraw

void redraw(boolean all)

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Item

setBounds

void setBounds(int x,
             int y,
             int width,
             int height,
             boolean move,
             boolean size)

setControl

public void setControl(Control control)

Sets the control that is shown when the item is expanded.

Parameters:

control - the new control (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the control has been disposed
• ERROR_INVALID_PARENT - if the control is not in the same widget tree

SWTException -

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

setExpanded

public void setExpanded(boolean expanded)

Sets the expanded state of the receiver.

Parameters:

expanded - the new expanded state

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

setHeight

public void setHeight(int height)

Sets the height of the receiver. This is height of the item when it is expanded, excluding the height of the header.

Parameters:

height - the new height

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

setImage

public void setImage(Image image)

Description copied from class: Item

Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.

Overrides:

setImage in class Item

Parameters:

image - the image to display on the receiver (may be null)

setText

public void setText(java.lang.String string)

Description copied from class: Item

Sets the receiver's text.

Overrides:

setText in class Item

Parameters:

string - the new text