|
 |
|
| |
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:
-
Adaptable
-
Direct Known Subclasses:
-
Browser,
Canvas,
CBanner,
CCombo,
Combo,
CoolBar,
CTabFolder,
DateTime,
ExpandBar,
Group,
SashForm,
ScrolledComposite,
Spinner,
TabFolder,
Table,
ToolBar,
Tree,
ViewForm
- public class Composite
- extends
Scrollable
Instances of this class are controls which are capable
of containing other controls.
-
Styles:
- NO_FOCUS
-
Events:
- (none)
This class may be subclassed by custom control implementors
who are building controls that are constructed from aggregates
of other controls.
|
Constructor Summary
|
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
|
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. |
Point
|
computeSize
(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
Object
|
getAdapter
(
Class adapter)
Implementation of the Adaptable interface. |
int
|
getBackgroundMode
()
Returns the receiver's background drawing mode. |
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. |
Control[]
|
getTabList
()
Gets the (possibly empty) tabbing order for the control. |
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
|
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. |
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
|
setTabList
(
Control[] tabList)
Sets the tabbing order for the specified controls to
match the order that they occur in the argument list. |
|
Methods inherited from class org.eclipse.swt.widgets.
Control
|
addControlListener,
addFocusListener,
addKeyListener,
addMouseListener,
addTraverseListener,
computeSize,
forceFocus,
getBackground,
getBackgroundImage,
getBorderWidth,
getBounds,
getCursor,
getEnabled,
getFont,
getForeground,
getLayoutData,
getLocation,
getMenu,
getMonitor,
getParent,
getShell,
getSize,
getToolTipText,
getVisible,
isEnabled,
isFocusControl,
isVisible,
moveAbove,
moveBelow,
pack,
pack,
redraw,
removeControlListener,
removeFocusListener,
removeKeyListener,
removeMouseListener,
removeTraverseListener,
setBackground,
setBackgroundImage,
setBounds,
setBounds,
setCursor,
setEnabled,
setFont,
setForeground,
setLayoutData,
setLocation,
setLocation,
setMenu,
setRedraw,
setSize,
setSize,
setToolTipText,
setVisible,
toControl,
toControl,
toDisplay,
toDisplay
|
|
Methods inherited from class org.eclipse.swt.widgets.
Widget
|
addDisposeListener,
addListener,
checkSubclass,
checkWidget,
dispose,
getData,
getData,
getDisplay,
getStyle,
isDisposed,
notifyListeners,
removeDisposeListener,
removeListener,
setData,
setData,
toString
|
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:
-
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_FOCUS,
Widget.getStyle()
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)
getAdapter
public
Object getAdapter(
Class adapter)
-
Description copied from class:
Widget
- Implementation of the
Adaptable interface.
IMPORTANT: This method is not part of the RWT
public API. It is marked public only so that it can be shared
within the packages provided by RWT. It should never be accessed
from application code.
-
-
Specified by:
-
getAdapter
in interface
Adaptable
-
Overrides:
-
getAdapter
in class
Control
-
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
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
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
-
See Also:
-
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
-
See Also:
-
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
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:
-
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
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"
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:
-
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:
- 1.0
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:
- 1.1
-
See Also:
-
SWT
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:
- 1.1
-
See Also:
-
SWT
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()
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:
-
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
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[])
Copyright (c) Innoopract Informationssysteme GmbH and others 2002, 2008. All rights reserved.
|
|
|
