public class Composite extends Scrollable
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.
| Modifier and Type | Field and Description |
|---|---|
(package private) int |
backgroundMode |
(package private) Layout |
layout |
(package private) int |
layoutCount |
(package private) Control[] |
tabList |
horizontalBar, scrolledHandle, verticalBaraccessible, background, backgroundImage, cursor, font, foreground, height, layoutData, menu, parent, region, toolTipText, width, x, yCANVAS, CLICK, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, handle, HIDDEN, jniRef, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MOVED, PARENT_BACKGROUND, RELEASED, RESIZED, state, style, THEME_BACKGROUND| 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.
|
| Modifier and Type | Method and Description |
|---|---|
(package private) Control[] |
_getChildren() |
(package private) Control[] |
_getTabList() |
(package private) void |
addChild(Control control) |
(package private) int |
backgoundProperty() |
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) 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) Control[] |
computeTabList() |
(package private) void |
createHandle() |
(package private) void |
createHandle(boolean scrolled,
boolean menubar) |
(package private) int |
defaultBackground() |
(package private) void |
enableWidget(boolean enabled) |
(package private) Composite |
findDeferredControl() |
(package private) Menu[] |
findMenus(Control control) |
(package private) void |
fixScrollbarVisibility() |
(package private) void |
fixTabList(Control control) |
int |
getBackgroundMode()
Returns the receiver's background drawing mode.
|
(package private) int |
getCaretHandle() |
Control[] |
getChildren()
Returns a (possibly empty) array containing the receiver's children.
|
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. |
(package private) Point |
getLocation(Control child) |
Control[] |
getTabList()
Gets the (possibly empty) tabbing order for the control.
|
(package private) void |
HandlePreviewKeyDown(int sender,
int e) |
(package private) void |
HandlePreviewMouseDown(int sender,
int e) |
(package private) void |
HandlePreviewTextInput(int sender,
int e) |
(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. |
(package private) boolean |
isTabGroup() |
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.
|
(package private) void |
markLayout(boolean changed,
boolean all) |
(package private) Point |
minimumSize(int wHint,
int hHint,
boolean changed) |
(package private) void |
OnRender(int drawingContext) |
(package private) int |
parentingHandle() |
(package private) void |
releaseChildren(boolean destroy) |
(package private) void |
releaseWidget() |
(package private) void |
removeChild(Control control) |
(package private) void |
removeControl(Control control) |
(package private) void |
resized() |
void |
setAlpha(int alpha)
WARNING: THIS API IS UNDER CONSTRUCTION AND SHOULD NOT BE USED
|
(package private) void |
setBackgroundBrush(int brush) |
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) int |
setBounds(int x,
int y,
int width,
int height,
int flags) |
(package private) void |
setClipping() |
boolean |
setFocus()
Causes the receiver to have the keyboard focus,
such that all keyboard events will be delivered to it.
|
(package private) void |
setFont(int font,
double size) |
(package private) void |
setForegroundBrush(int brush) |
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) 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) boolean |
translateMnemonic(Event event,
Control control) |
(package private) boolean |
translateTraversal(int msg) |
(package private) int |
traversalCode(int key,
int event) |
(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 resize,
boolean all) |
clientHandle, computeTrim, createScrollBar, createWidget, deregister, findScrollViewer, getClientArea, getHorizontalBar, getScrollBarHandle, getVerticalBar, HandlePreviewMouseWheel, register, releaseHandle, topHandleaddControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, addWidget, backgroundHandle, backgroundProperty, borderHandle, checkBackground, checkBorder, checkBuffered, computeSize, computeSize, computeTabGroup, computeTabRoot, defaultFont, defaultForeground, destroyWidget, dragDetect, dragDetect, dragDetect, dragDetect, dragHandler, drawGripper, findBackgroundControl, findImageControl, findMnemonic, findThemeControl, fixFocus, forceFocus, getAccessible, getAlpha, getBackground, getBackgroundColor, getBackgroundImage, getBorderWidth, getBounds, getClipboardText, getCursor, getDragDetect, getEnabled, getFont, getForeground, getForegroundColor, getLayoutData, getLocation, getMenu, getMonitor, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTransform, getVisible, getWidgetControl, HandleContextMenuOpening, HandleLeftChanged, HandleLostKeyboardFocus, HandleMouseEnter, HandleMouseLeave, HandlePreviewGotKeyboardFocus, HandlePreviewKeyUp, HandlePreviewMouseMove, HandlePreviewMouseUp, HandleSizeChanged, HandleTopChanged, hasFocus, hookEvents, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabItem, isVisible, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, pack, pack, print, redraw, redraw, redraw, releaseParent, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, sendFocusEvent, setBackground, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEffect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setTransform, setVisible, sort, sortAscending, toControl, toControl, toDisplay, toDisplay, translateMnemonic, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update, updateImages, widgetParent_addListener, addDisposeListener, addListener, checkBits, checkEvent, checkOpened, checkOrientation, checkParent, checkWidget, createDotNetString, createJavaString, dispose, dragOverride, dumpObjectType, dumpVisualTree, error, filters, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, hasItems, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, mnemonicMatch, notifyListeners, postEvent, postEvent, release, removeDisposeListener, removeListener, removeListener, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendMouseEvent, setClipping, setData, setData, setInputState, setKeyState, setNameScope, showMenu, toString, updateLayoutint layoutCount
int backgroundMode
Composite()
public Composite(Composite parent, int style)
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.
parent - a widget which will be the parent of the new instance (cannot be null)style - the style of widget to constructIllegalArgumentException - SWTException - 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()static int checkStyle(int style)
int getCaretHandle()
Control[] _getChildren()
Control[] _getTabList()
int backgoundProperty()
public void changed(Control[] changed)
changed - an array of controls that changed state and require a recalculation of sizeIllegalArgumentException - SWTException - protected void checkSubclass()
Widget
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.
checkSubclass in class WidgetControl[] computeTabList()
computeTabList in class Controlpublic Point computeSize(int wHint, int hHint, boolean changed)
Control
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.
computeSize in class ControlwHint - 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 otherwiseLayout,
Control.getBorderWidth(),
Control.getBounds(),
Control.getSize(),
Control.pack(boolean),
"computeTrim, getClientArea for controls that implement them"void createHandle()
createHandle in class Widgetvoid createHandle(boolean scrolled, boolean menubar)
int defaultBackground()
defaultBackground in class Controlvoid enableWidget(boolean enabled)
enableWidget in class ControlComposite findDeferredControl()
void fixScrollbarVisibility()
fixScrollbarVisibility in class Scrollablevoid fixTabList(Control control)
public int getBackgroundMode()
SWT:
INHERIT_NONE, INHERIT_DEFAULT,
INHERTIT_FORCE.SWTException - SWTpublic Control[] getChildren()
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.
SWTException - Control.moveAbove(org.eclipse.swt.widgets.Control),
Control.moveBelow(org.eclipse.swt.widgets.Control)public Layout getLayout()
SWTException - Point getLocation(Control child)
public Control[] getTabList()
SWTException - setTabList(org.eclipse.swt.widgets.Control[])boolean hooksKeys()
public boolean getLayoutDeferred()
true if the receiver has deferred
the performing of layout, and false otherwise.SWTException - setLayoutDeferred(boolean),
isLayoutDeferred()void HandlePreviewKeyDown(int sender, int e)
HandlePreviewKeyDown in class Controlvoid HandlePreviewMouseDown(int sender, int e)
HandlePreviewMouseDown in class Controlvoid HandlePreviewTextInput(int sender, int e)
HandlePreviewTextInput in class Controlpublic boolean isLayoutDeferred()
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.SWTException - setLayoutDeferred(boolean),
getLayoutDeferred()boolean isTabGroup()
isTabGroup in class Controlpublic void layout()
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.
SWTException - public void layout(boolean changed)
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.
changed - true if the layout must flush its caches, and false otherwiseSWTException - public void layout(boolean changed, boolean all)
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.
changed - true if the layout must flush its caches, and false otherwiseall - true if all children in the receiver's widget tree should be laid out, and false otherwiseSWTException - public void layout(Control[] changed)
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.
changed - a control that has had a state change which requires a recalculation of its sizeIllegalArgumentException - SWTException - void OnRender(int drawingContext)
void markLayout(boolean changed, boolean all)
markLayout in class ControlPoint minimumSize(int wHint, int hHint, boolean changed)
int parentingHandle()
void releaseChildren(boolean destroy)
releaseChildren in class Scrollablevoid releaseWidget()
releaseWidget in class Controlvoid removeChild(Control control)
void removeControl(Control control)
public void setAlpha(int alpha)
void setBackgroundBrush(int brush)
public void setBackgroundMode(int mode)
SWT:
INHERIT_NONE, INHERIT_DEFAULT,
INHERIT_FORCE.mode - the new background modeSWTException - SWTint setBounds(int x, int y, int width, int height, int flags)
void setClipping()
setClipping in class Controlpublic boolean setFocus()
ControlsetFocus in class Controltrue if the control got focus, and false if it was unable to.Control.forceFocus()void setForegroundBrush(int brush)
setForegroundBrush in class Controlpublic void setLayout(Layout layout)
layout - the receiver's new layout or nullSWTException - public void setLayoutDeferred(boolean defer)
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.defer - the new defer stateSWTException - layout(boolean),
layout(Control[])public void setTabList(Control[] tabList)
tabList - the ordered list of controls representing the tab order or nullIllegalArgumentException - SWTException - boolean setTabGroupFocus()
setTabGroupFocus in class Controlboolean translateMnemonic(Event event, Control control)
translateMnemonic in class Controlint traversalCode(int key, int event)
traversalCode in class Controlboolean translateTraversal(int msg)
translateTraversal in class Controlvoid updateBackgroundColor()
updateBackgroundColor in class Controlvoid updateBackgroundImage()
updateBackgroundImage in class Controlvoid updateBackgroundMode()
updateBackgroundMode in class Controlvoid updateFont(Font oldFont, Font newFont)
updateFont in class Controlvoid updateLayout(boolean resize, boolean all)
updateLayout in class Control