Package org.eclipse.swt.widgets
Class Decorations
- java.lang.Object
-
- org.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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> T
getAdapter(java.lang.Class<T> adapter)
Implementation of theAdaptable
interface.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 usingsetImage()
.Image[]
getImages()
Returns the receiver's images if they had previously been set usingsetImages()
.Menu
getMenuBar()
Returns the receiver's menu bar if one had previously been set, otherwise returns null.java.lang.String
getText()
Returns the receiver's text, which is the string that the window manager will typically display as the receiver's title.boolean
isReparentable()
Returnstrue
if the underlying operating system supports this reparenting, otherwisefalse
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
setImages(Image[] images)
Sets the receiver's images to the argument, which may be an empty array.void
setMenuBar(Menu menuBar)
Sets the receiver's menu bar to the argument, which may be null.void
setText(java.lang.String text)
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
addPaintListener, removePaintListener
-
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
-
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getVerticalBar
-
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addTouchListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, isEnabled, isFocusControl, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCursor, setData, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setSize, setSize, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, update
-
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, toString
-
-
-
-
Method Detail
-
getAdapter
public <T> T getAdapter(java.lang.Class<T> adapter)
Description copied from class:Widget
Implementation of theAdaptable
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 interfaceAdaptable
- Overrides:
getAdapter
in classCanvas
- Parameters:
adapter
- the lookup class- Returns:
- an object that can be cast to the given class or
null
if there is no adapter associated with the given class.
-
setImages
public void setImages(Image[] images)
Sets the receiver's images to the argument, which may be an empty array. Images are 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. Depending where the icon is displayed, the platform chooses the icon with the "best" attributes. It is expected that the array will contain the same icon rendered at different sizes, with different depth and transparency attributes.- Parameters:
images
- the new image array- Throws:
java.lang.IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the array of images is null
- ERROR_INVALID_ARGUMENT - if one of the images is null or 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:
- 1.3
-
getImages
public Image[] getImages()
Returns the receiver's images if they had previously been set usingsetImages()
. Images are 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. Depending where the icon is displayed, the platform chooses the icon with the "best" attributes. It is expected that the array will contain the same icon rendered at different sizes, with different depth and transparency attributes.Note: This method will return an empty array if called before
setImages()
is called. It does not provide access to a window manager provided, "default" image even if one exists.- Returns:
- the images
- 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.3
-
setImage
public void setImage(Image image)
Sets the receiver's image to the argument, which may be null. 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.- Parameters:
image
- the new image (or null)- Throws:
java.lang.IllegalArgumentException
-- ERROR_INVALID_ARGUMENT - if the image 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
-
getImage
public Image getImage()
Returns the receiver's image if it had previously been set usingsetImage()
. 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.- Returns:
- the image
- 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
-
setText
public void setText(java.lang.String text)
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.- Parameters:
text
- the new text- Throws:
java.lang.IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the text is null
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:
- 2.2
-
getText
public java.lang.String getText()
Returns the receiver's text, which is the string that the window manager will typically display as the receiver's title. If the text has not previously been set, returns an empty string.- Returns:
- the text
- 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:
- 2.2
-
setMenuBar
public void setMenuBar(Menu menuBar)
Sets the receiver's menu bar to the argument, which may be null.- Parameters:
menuBar
- the new menu bar- Throws:
java.lang.IllegalArgumentException
-- ERROR_INVALID_ARGUMENT - if the menu has been disposed
- ERROR_INVALID_PARENT - if the menu 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
-
getMenuBar
public Menu getMenuBar()
Returns the receiver's menu bar if one had previously been set, otherwise returns null.- Returns:
- the menu bar 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
-
isReparentable
public boolean isReparentable()
Description copied from class:Control
Returnstrue
if the underlying operating system supports this reparenting, otherwisefalse
- Overrides:
isReparentable
in classControl
- Returns:
true
if the widget can be reparented, otherwisefalse
-
setDefaultButton
public 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). If no default button had previously been set, or the saved default button was disposed, the receiver's default button will be set to null.The default button is the button that is selected when the receiver is active and the user presses ENTER.
- Parameters:
button
- the new default button- Throws:
java.lang.IllegalArgumentException
-- ERROR_INVALID_ARGUMENT - if the button 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
- Since:
- 2.2
-
getDefaultButton
public Button getDefaultButton()
Returns the receiver's default button if one had previously been set, otherwise returns null.- Returns:
- the default button 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
- Since:
- 2.2
- See Also:
setDefaultButton(Button)
-
-