|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.Canvas
org.eclipse.swt.widgets.Decorations
Instances of this class provide the appearance and
behavior of Shells
, but are not top
level shells or dialogs. Class Shell
shares a significant amount of code with this class,
and is a subclass.
IMPORTANT: This class was intended to be abstract and
should never be referenced or instantiated.
Instead, the class Shell
should be used.
Instances are always displayed in one of the maximized, minimized or normal states:
RESIZE
) until it is
no longer maximized.
SWT
provides two "convenience constants"
for the most commonly required style combinations:
SHELL_TRIM
CLOSE | TITLE | MIN | MAX | RESIZE
)
DIALOG_TRIM
TITLE | CLOSE | BORDER
)
IMPORTANT: This class is intended to be subclassed only within the SWT implementation.
getMinimized()
,
getMaximized()
,
Shell
,
SWT
Constructor Summary | |
---|---|
Decorations(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 | |
---|---|
Button |
getDefaultButton()
Returns the receiver's default button if one had previously been set, otherwise returns null. |
Image |
getImage()
Returns the receiver's image if it had previously been set using setImage() . |
boolean |
getMaximized()
Returns true if the receiver is currently
maximized, and false otherwise.
|
Menu |
getMenuBar()
Returns the receiver's menu bar if one had previously been set, otherwise returns null. |
boolean |
getMinimized()
Returns true if the receiver is currently
minimized, and false otherwise.
|
String |
getText()
Returns the receiver's text, which is the string that the window manager will typically display as the receiver's title. |
void |
setDefaultButton(Button button)
If the argument is not null, sets the receiver's default button to the argument, and if the argument is null, sets the receiver's default button to the first button which was set as the receiver's default button (called the saved default button). |
void |
setImage(Image image)
Sets the receiver's image to the argument, which may be null. |
void |
setMaximized(boolean maximized)
Sets the maximized state of the receiver. |
void |
setMenuBar(Menu menu)
Sets the receiver's menu bar to the argument, which may be null. |
void |
setMinimized(boolean minimized)
Sets the minimized stated of the receiver. |
void |
setText(String string)
Sets the receiver's text, which is the string that the window manager will typically display as the receiver's title, to the argument, which must not be null. |
Methods inherited from class org.eclipse.swt.widgets.Canvas |
---|
scroll |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
checkSubclass, getBackgroundMode, getChildren, getLayout, getTabList, layout, layout, setBackgroundMode, setLayout, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Decorations(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 composite control which will be the parent of the new instance (cannot be null)style
- the style of control to construct
IllegalArgumentException
- SWTException
- SWT.BORDER
,
SWT.CLOSE
,
SWT.MIN
,
SWT.MAX
,
SWT.RESIZE
,
SWT.TITLE
,
SWT.NO_TRIM
,
SWT.SHELL_TRIM
,
SWT.DIALOG_TRIM
,
SWT.ON_TOP
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
public Button getDefaultButton()
SWTException
- setDefaultButton(Button)
public Image getImage()
setImage()
. The image is typically
displayed by the window manager when the instance is
marked as iconified, and may also be displayed somewhere
in the trim when the instance is in normal or maximized
states.
Note: This method will return null if called before
setImage()
is called. It does not provide
access to a window manager provided, "default" image
even if one exists.
SWTException
- public boolean getMaximized()
true
if the receiver is currently
maximized, and false otherwise.
SWTException
- setMaximized(boolean)
public Menu getMenuBar()
SWTException
- public boolean getMinimized()
true
if the receiver is currently
minimized, and false otherwise.
SWTException
- setMinimized(boolean)
public String getText()
SWTException
- public void setDefaultButton(Button button)
The default button is the button that is selected when the receiver is active and the user presses ENTER.
button
- the new default button
IllegalArgumentException
- SWTException
- public void setImage(Image image)
image
- the new image (or null)
IllegalArgumentException
- SWTException
- public void setMaximized(boolean maximized)
true
causes the receiver
to switch to the maximized state, and if the argument is
false
and the receiver was previously maximized,
causes the receiver to switch back to either the minimized
or normal states.
Note: The result of intermixing calls to setMaximized(true)
and setMinimized(true)
will vary by platform. Typically,
the behavior will match the platform user's expectations, but not
always. This should be avoided if possible.
maximized
- the new maximized state
SWTException
- setMinimized(boolean)
public void setMenuBar(Menu menu)
menu
- the new menu bar
IllegalArgumentException
- SWTException
- public void setMinimized(boolean minimized)
true
causes the receiver
to switch to the minimized state, and if the argument is
false
and the receiver was previously minimized,
causes the receiver to switch back to either the maximized
or normal states.
Note: The result of intermixing calls to setMaximized(true)
and setMinimized(true)
will vary by platform. Typically,
the behavior will match the platform user's expectations, but not
always. This should be avoided if possible.
minimized
- the new maximized state
SWTException
- setMaximized(boolean)
public void setText(String string)
string
- the new text
IllegalArgumentException
- SWTException
-
|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |