org.eclipse.swt.widgets

Class Composite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

All Implemented Interfaces:

Drawable

Direct Known Subclasses:

Browser, Canvas, CBanner, CCombo, Combo, CoolBar, CTabFolder, DateTime, ExpandBar, Group, OleClientSite, OleFrame, SashForm, ScrolledComposite, Spinner, TabFolder, Table, TableTree, ToolBar, Tree, ViewForm

public class Composite
extends Scrollable

Instances of this class are controls which are capable of containing other controls.

Styles:

NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, NO_REDRAW_RESIZE, NO_RADIO_GROUP, EMBEDDED, DOUBLE_BUFFERED

Events:

(none)

Note: The NO_BACKGROUND, NO_FOCUS, NO_MERGE_PAINTS, and NO_REDRAW_RESIZE styles are intended for use with Canvas. They can be used with Composite if you are drawing your own, but their behavior is undefined if they are used with subclasses of Composite other than Canvas.

Note: The CENTER style, although undefined for composites, has the same value as EMBEDDED which is used to embed widgets from other widget toolkits into SWT. On some operating systems (GTK, Motif), this may cause the children of this composite to be obscured.

This class may be subclassed by custom control implementors who are building controls that are constructed from aggregates of other controls.

See Also:

Canvas, Composite snippets, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	backgroundMode
(package private) Layout	layout
(package private) int	layoutCount
(package private) WINDOWPOS[]	lpwp
(package private) Control[]	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
Composite() Prevents uninitialized instances from being created outside the package.
Composite(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
(package private) Control[]	_getChildren()
(package private) Control[]	_getTabList()
void	changed(Control[] changed) Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver.
(package private) void	checkBuffered()
(package private) void	checkComposited()
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) Widget[]	computeTabList()
(package private) void	copyArea(GC gc, int x, int y, int width, int height) Copies a rectangular area of the receiver at the specified position using the gc.
(package private) void	createHandle()
void	drawBackground(GC gc, int x, int y, int width, int height, int offsetX, int offsetY) Fills the interior of the rectangle specified by the arguments, with the receiver's background.
(package private) Composite	findDeferredControl()
(package private) Menu[]	findMenus(Control control)
(package private) void	fixChildren(Shell newShell, Shell oldShell, Decorations newDecorations, Decorations oldDecorations, Menu[] menus)
(package private) void	fixTabList(Control control)
int	getBackgroundMode() Returns the receiver's background drawing mode.
Control[]	getChildren() Returns a (possibly empty) array containing the receiver's children.
(package private) int	getChildrenCount()
Layout	getLayout() Returns layout which is associated with the receiver, or null if one has not been set.
boolean	getLayoutDeferred() Returns true if the receiver has deferred the performing of layout, and false otherwise.
Control[]	getTabList() Gets the (possibly empty) tabbing order for the control.
(package private) boolean	hooksKeys()
boolean	isLayoutDeferred() Returns true if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts.
void	layout() If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
void	layout(boolean changed) If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
void	layout(boolean changed, boolean all) If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children.
void	layout(Control[] changed) Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver.
void	layout(Control[] changed, int flags) Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver.
(package private) void	markLayout(boolean changed, boolean all)
(package private) Point	minimumSize(int wHint, int hHint, boolean changed)
(package private) boolean	redrawChildren()
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseParent()
(package private) void	releaseWidget()
(package private) void	removeControl(Control control)
(package private) void	resizeChildren()
(package private) boolean	resizeChildren(boolean defer, WINDOWPOS[] pwp)
(package private) void	resizeEmbeddedHandle(int embeddedHandle, int width, int height)
(package private) void	reskinChildren(int flags)
(package private) void	sendResize()
void	setBackgroundMode(int mode) Sets the background drawing mode to the argument which should be one of the following constants defined in class SWT: INHERIT_NONE, INHERIT_DEFAULT, INHERIT_FORCE.
(package private) void	setBounds(int x, int y, int width, int height, int flags, boolean defer)
boolean	setFocus() Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it.
void	setLayout(Layout layout) Sets the layout which is associated with the receiver to be the argument which may be null.
void	setLayoutDeferred(boolean defer) If the argument is true, causes subsequent layout operations in the receiver or any of its children to be ignored.
(package private) void	setResizeChildren(boolean resize)
(package private) boolean	setTabGroupFocus()
void	setTabList(Control[] tabList) Sets the tabbing order for the specified controls to match the order that they occur in the argument list.
(package private) java.lang.String	toolTipText(NMTTDISPINFO hdr)
(package private) boolean	translateMnemonic(Event event, Control control)
(package private) boolean	translateTraversal(MSG msg)
(package private) void	updateBackgroundColor()
(package private) void	updateBackgroundImage()
(package private) void	updateBackgroundMode()
(package private) void	updateFont(Font oldFont, Font newFont)
(package private) void	updateLayout(boolean all)
(package private) void	updateLayout(boolean resize, boolean all)
(package private) void	updateOrientation()
(package private) void	updateUIState()
(package private) int	widgetStyle()
(package private) LRESULT	WM_ERASEBKGND(int wParam, int lParam)
(package private) LRESULT	WM_GETDLGCODE(int wParam, int lParam)
(package private) LRESULT	WM_GETFONT(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_NCHITTEST(int wParam, int lParam)
(package private) LRESULT	WM_PAINT(int wParam, int lParam)
(package private) LRESULT	WM_PARENTNOTIFY(int wParam, int lParam)
(package private) LRESULT	WM_PRINTCLIENT(int wParam, int lParam)
(package private) LRESULT	WM_SETFONT(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	WM_SYSCOLORCHANGE(int wParam, int lParam)
(package private) LRESULT	WM_SYSCOMMAND(int wParam, int lParam)
(package private) LRESULT	WM_UPDATEUISTATE(int wParam, int lParam)
(package private) LRESULT	wmNCPaint(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmNotify(NMHDR hdr, int wParam, int lParam)

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

callWindowProc, computeTrim, createScrollBar, createWidget, destroyScrollBar, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, scrolledHandle, widgetExtStyle, windowClass, windowProc, WM_HSCROLL, WM_MOUSEWHEEL, WM_VSCROLL, wmScroll, 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, defaultBackground, defaultFont, defaultForeground, deregister, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, enableDrag, enableWidget, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMnemonic, findThemeControl, 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, setBackgroundPixel, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setFont, setForeground, setForegroundPixel, 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_KEYDOWN, WM_KEYUP, WM_KILLFOCUS, WM_LBUTTONDBLCLK, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSEHWHEEL, WM_MOUSELEAVE, WM_MOUSEMOVE, 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_SETCURSOR, WM_SETFOCUS, 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

layout

Layout layout

lpwp

WINDOWPOS[] lpwp

tabList

Control[] tabList

layoutCount

int layoutCount

backgroundMode

int backgroundMode

Constructor Detail

Composite

Composite()

Prevents uninitialized instances from being created outside the package.

Composite

public Composite(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 widget which will be the parent of the new instance (cannot be null)

style - the style of widget 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

See Also:

SWT.NO_BACKGROUND, SWT.NO_FOCUS, SWT.NO_MERGE_PAINTS, SWT.NO_REDRAW_RESIZE, SWT.NO_RADIO_GROUP, SWT.EMBEDDED, SWT.DOUBLE_BUFFERED, Widget.getStyle()

Method Detail

_getChildren

Control[] _getChildren()

_getTabList

Control[] _getTabList()

changed

public void changed(Control[] changed)

Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.

Parameters:

changed - an array of controls that changed state and require a recalculation of size

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the changed array is null any of its controls are null or have been disposed
• ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver

SWTException -

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

Since:

3.1

checkBuffered

void checkBuffered()

Overrides:

checkBuffered in class Control

checkComposited

void checkComposited()

Overrides:

checkComposited in class Control

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 Widget

computeTabList

Widget[] computeTabList()

Overrides:

computeTabList in class Control

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 Control

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"

copyArea

void copyArea(GC gc,
            int x,
            int y,
            int width,
            int height)

Copies a rectangular area of the receiver at the specified position using the gc.

Parameters:

gc - the gc where the rectangle is to be filled

x - the x coordinate of the rectangle to be filled

y - the y coordinate of the rectangle to be filled

width - the width of the rectangle to be filled

height - the height of the rectangle to be filled

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the gc is null
• ERROR_INVALID_ARGUMENT - if the gc 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

createHandle

void createHandle()

Overrides:

createHandle in class Control

drawBackground

public void drawBackground(GC gc,
                  int x,
                  int y,
                  int width,
                  int height,
                  int offsetX,
                  int offsetY)

Fills the interior of the rectangle specified by the arguments, with the receiver's background.

The offsetX and offsetY are used to map from the gc origin to the origin of the parent image background. This is useful to ensure proper alignment of the image background.

Parameters:

gc - the gc where the rectangle is to be filled

x - the x coordinate of the rectangle to be filled

y - the y coordinate of the rectangle to be filled

width - the width of the rectangle to be filled

height - the height of the rectangle to be filled

offsetX - the image background x offset

offsetY - the image background y offset

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the gc is null
• ERROR_INVALID_ARGUMENT - if the gc 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

Since:

3.6

findDeferredControl

Composite findDeferredControl()

findMenus

Menu[] findMenus(Control control)

Overrides:

findMenus in class Control

fixChildren

void fixChildren(Shell newShell,
               Shell oldShell,
               Decorations newDecorations,
               Decorations oldDecorations,
               Menu[] menus)

Overrides:

fixChildren in class Control

fixTabList

void fixTabList(Control control)

getBackgroundMode

public int getBackgroundMode()

Returns the receiver's background drawing mode. This will be one of the following constants defined in class SWT: INHERIT_NONE, INHERIT_DEFAULT, INHERTIT_FORCE.

Returns:

the background mode

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

Since:

3.2

See Also:

SWT

getChildren

public Control[] getChildren()

Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array.

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

Returns:

an array of children

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

See Also:

Control.moveAbove(org.eclipse.swt.widgets.Control), Control.moveBelow(org.eclipse.swt.widgets.Control)

getChildrenCount

int getChildrenCount()

getLayout

public Layout getLayout()

Returns layout which is associated with the receiver, or null if one has not been set.

Returns:

the receiver's layout or null

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

getTabList

public Control[] getTabList()

Gets the (possibly empty) tabbing order for the control.

Returns:

tabList the ordered list of controls representing the tab order

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

See Also:

setTabList(org.eclipse.swt.widgets.Control[])

hooksKeys

boolean hooksKeys()

getLayoutDeferred

public boolean getLayoutDeferred()

Returns true if the receiver has deferred the performing of layout, and false otherwise.

Returns:

the receiver's deferred layout 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

Since:

3.1

See Also:

setLayoutDeferred(boolean), isLayoutDeferred()

isLayoutDeferred

public boolean isLayoutDeferred()

Returns true if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, false is returned.

Returns:

the receiver's deferred layout 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

Since:

3.1

See Also:

setLayoutDeferred(boolean), getLayoutDeferred()

layout

public void layout()

If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing.

This is equivalent to calling layout(true).

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

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

layout

public void layout(boolean changed)

If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is true the layout must not rely on any information it has cached about the immediate children. If it is false the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing.

If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as layout(false)).

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

Parameters:

changed - true if the layout must flush its caches, and false otherwise

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

layout

public void layout(boolean changed,
          boolean all)

If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the changed argument is true the layout must not rely on any information it has cached about its children. If it is false the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is true the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is false, the layout will not cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as layout(false)).

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

Parameters:

changed - true if the layout must flush its caches, and false otherwise

all - true if all children in the receiver's widget tree should be laid out, and false otherwise

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

Since:

3.1

layout

public void layout(Control[] changed)

Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it.

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

Parameters:

changed - a control that has had a state change which requires a recalculation of its size

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the changed array is null any of its controls are null or have been disposed
• ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver

SWTException -

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

Since:

3.1

layout

public void layout(Control[] changed,
          int flags)

Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver.

The parameter flags may be a combination of:

SWT.ALL

all children in the receiver's widget tree should be laid out

SWT.CHANGED

the layout must flush its caches

SWT.DEFER

layout will be deferred

When the changed array is specified, the flags SWT.ALL and SWT.CHANGED have no effect. In this case, the layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it.

When the changed array is not specified, the flag SWT.ALL indicates that the whole widget tree should be laid out. And the flag SWT.CHANGED indicates that the layouts should flush any cached information for all controls that are laid out.

The SWT.DEFER flag always causes the layout to be deferred by calling Composite.setLayoutDeferred(true) and scheduling a call to Composite.setLayoutDeferred(false), which will happen when appropriate (usually before the next event is handled). When this flag is set, the application should not call Composite.setLayoutDeferred(boolean).

Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.

Parameters:

changed - a control that has had a state change which requires a recalculation of its size

flags - the flags specifying how the layout should happen

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if any of the controls in changed is null or has been disposed
• ERROR_INVALID_PARENT - if any control in changed is not in the widget tree of the receiver

SWTException -

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

Since:

3.6

markLayout

void markLayout(boolean changed,
              boolean all)

Overrides:

markLayout in class Control

minimumSize

Point minimumSize(int wHint,
                int hHint,
                boolean changed)

redrawChildren

boolean redrawChildren()

Overrides:

redrawChildren in class Control

releaseParent

void releaseParent()

Overrides:

releaseParent in class Control

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Scrollable

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Control

removeControl

void removeControl(Control control)

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Scrollable

resizeChildren

void resizeChildren()

resizeChildren

boolean resizeChildren(boolean defer,
                     WINDOWPOS[] pwp)

resizeEmbeddedHandle

void resizeEmbeddedHandle(int embeddedHandle,
                        int width,
                        int height)

sendResize

void sendResize()

Overrides:

sendResize in class Control

setBackgroundMode

public void setBackgroundMode(int mode)

Sets the background drawing mode to the argument which should be one of the following constants defined in class SWT: INHERIT_NONE, INHERIT_DEFAULT, INHERIT_FORCE.

Parameters:

mode - the new background mode

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

Since:

3.2

See Also:

SWT

setBounds

void setBounds(int x,
             int y,
             int width,
             int height,
             int flags,
             boolean defer)

Overrides:

setBounds in class Control

setFocus

public boolean setFocus()

Description copied from class: Control

Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it. Focus reassignment will respect applicable platform constraints.

Overrides:

setFocus in class Control

Returns:

true if the control got focus, and false if it was unable to.

See Also:

Control.forceFocus()

setLayout

public void setLayout(Layout layout)

Sets the layout which is associated with the receiver to be the argument which may be null.

Parameters:

layout - the receiver's new layout or null

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

setLayoutDeferred

public void setLayoutDeferred(boolean defer)

If the argument is true, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was true are remembered and when the flag is set to false, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.

Parameters:

defer - the new defer 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

Since:

3.1

See Also:

layout(boolean), layout(Control[])

setTabList

public void setTabList(Control[] tabList)

Sets the tabbing order for the specified controls to match the order that they occur in the argument list.

Parameters:

tabList - the ordered list of controls representing the tab order or null

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if a widget in the tabList is null or has been disposed
• ERROR_INVALID_PARENT - if widget in the tabList 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

setResizeChildren

void setResizeChildren(boolean resize)

setTabGroupFocus

boolean setTabGroupFocus()

Overrides:

setTabGroupFocus in class Widget

toolTipText

java.lang.String toolTipText(NMTTDISPINFO hdr)

translateMnemonic

boolean translateMnemonic(Event event,
                        Control control)

Overrides:

translateMnemonic in class Control

translateTraversal

boolean translateTraversal(MSG msg)

Overrides:

translateTraversal in class Control

updateBackgroundColor

void updateBackgroundColor()

Overrides:

updateBackgroundColor in class Control

updateBackgroundImage

void updateBackgroundImage()

Overrides:

updateBackgroundImage in class Control

updateBackgroundMode

void updateBackgroundMode()

Overrides:

updateBackgroundMode in class Control

updateFont

void updateFont(Font oldFont,
              Font newFont)

Overrides:

updateFont in class Control

updateLayout

void updateLayout(boolean all)

updateLayout

void updateLayout(boolean resize,
                boolean all)

Overrides:

updateLayout in class Control

updateOrientation

void updateOrientation()

Overrides:

updateOrientation in class Control

updateUIState

void updateUIState()

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Scrollable

WM_ERASEBKGND

LRESULT WM_ERASEBKGND(int wParam,
                    int lParam)

Overrides:

WM_ERASEBKGND in class Control

WM_GETDLGCODE

LRESULT WM_GETDLGCODE(int wParam,
                    int lParam)

Overrides:

WM_GETDLGCODE in class Control

WM_GETFONT

LRESULT WM_GETFONT(int wParam,
                 int lParam)

Overrides:

WM_GETFONT in class Control

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_LBUTTONDOWN in class Control

WM_NCHITTEST

LRESULT WM_NCHITTEST(int wParam,
                   int lParam)

Overrides:

WM_NCHITTEST in class Control

WM_PARENTNOTIFY

LRESULT WM_PARENTNOTIFY(int wParam,
                      int lParam)

Overrides:

WM_PARENTNOTIFY in class Control

WM_PAINT

LRESULT WM_PAINT(int wParam,
               int lParam)

Overrides:

WM_PAINT in class Control

WM_PRINTCLIENT

LRESULT WM_PRINTCLIENT(int wParam,
                     int lParam)

Overrides:

WM_PRINTCLIENT in class Control

WM_SETFONT

LRESULT WM_SETFONT(int wParam,
                 int lParam)

Overrides:

WM_SETFONT in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Scrollable

WM_SYSCOLORCHANGE

LRESULT WM_SYSCOLORCHANGE(int wParam,
                        int lParam)

Overrides:

WM_SYSCOLORCHANGE in class Control

WM_SYSCOMMAND

LRESULT WM_SYSCOMMAND(int wParam,
                    int lParam)

Overrides:

WM_SYSCOMMAND in class Control

WM_UPDATEUISTATE

LRESULT WM_UPDATEUISTATE(int wParam,
                       int lParam)

Overrides:

WM_UPDATEUISTATE in class Control

wmNCPaint

LRESULT wmNCPaint(int hwnd,
                int wParam,
                int lParam)

Overrides:

wmNCPaint in class Scrollable

wmNotify

LRESULT wmNotify(NMHDR hdr,
               int wParam,
               int lParam)

Overrides:

wmNotify in class Control