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

All Implemented Interfaces:

Drawable

Direct Known Subclasses:

Shell

public class Decorations
extends Canvas

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:

• When an instance is marked as maximized, the window manager will typically resize it to fill the entire visible area of the display, and the instance is usually put in a state where it can not be resized (even if it has style RESIZE) until it is no longer maximized.
• When an instance is in the normal state (neither maximized or minimized), its appearance is controlled by the style constants which were specified when it was created and the restrictions of the window manager (see below).
• When an instance has been marked as minimized, its contents (client area) will usually not be visible, and depending on the window manager, it may be "iconified" (that is, replaced on the desktop by a small simplified representation of itself), relocated to a distinguished area of the screen, or hidden. Combinations of these changes are also possible.

Note: The styles supported by this class must be treated as HINTs, since the window manager for the desktop on which the instance is visible has ultimate control over the appearance and behavior of decorations. For example, some window managers only support resizable windows and will always assume the RESIZE style, even if it is not set.

Styles:

BORDER, CLOSE, MIN, MAX, NO_TRIM, RESIZE, TITLE, ON_TOP, TOOL

Events:

(none)

Class SWT provides two "convenience constants" for the most commonly required style combinations:

SHELL_TRIM

the result of combining the constants which are required to produce a typical application top level shell: (that is, CLOSE | TITLE | MIN | MAX | RESIZE)

DIALOG_TRIM

the result of combining the constants which are required to produce a typical application dialog shell: (that is, TITLE | CLOSE | BORDER)

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

See Also:

getMinimized(), getMaximized(), Shell, SWT, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Button	defaultButton
(package private) int	hAccel
(package private) Image	image
(package private) Image[]	images
(package private) Image	largeImage
(package private) RECT	maxRect
(package private) Menu	menuBar
(package private) Menu[]	menus
(package private) boolean	moved
(package private) int	nAccel
(package private) int	oldHeight
(package private) int	oldWidth
(package private) int	oldX
(package private) int	oldY
(package private) boolean	opened
(package private) boolean	resized
(package private) Button	saveDefault
(package private) Control	savedFocus
(package private) Image	smallImage
(package private) int	swFlags

Fields inherited from class org.eclipse.swt.widgets.Canvas

caret, ime

Fields inherited from class org.eclipse.swt.widgets.Composite

backgroundMode, layout, layoutCount, lpwp, 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
Decorations() Prevents uninitialized instances from being created outside the package.
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

Methods

Modifier and Type	Method and Description
(package private) void	_setMaximized(boolean maximized)
(package private) void	_setMinimized(boolean minimized)
(package private) void	addMenu(Menu menu)
(package private) void	bringToTop()
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) void	checkBorder()
(package private) void	checkComposited(Composite parent)
(package private) void	checkOpened()
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
(package private) void	closeWidget()
(package private) int	compare(ImageData data1, ImageData data2, int width, int height, int depth)
(package private) Widget	computeTabGroup()
(package private) Control	computeTabRoot()
Rectangle	computeTrim(int x, int y, int width, int height) Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.
(package private) void	createAccelerators()
(package private) void	createHandle()
(package private) void	createWidget()
(package private) void	destroyAccelerators()
void	dispose() Disposes of the operating system resources associated with the receiver and all its descendants.
(package private) Menu	findMenu(int hMenu)
(package private) void	fixDecorations(Decorations newDecorations, Control control, Menu[] menus)
Rectangle	getBounds() Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null), unless the receiver is a shell.
Rectangle	getClientArea() Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").
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().
Image[]	getImages() Returns the receiver's images if they had previously been set using setImages().
Point	getLocation() Returns a point describing the receiver's location relative to its parent (or its display if its parent is null), unless the receiver is a shell.
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.
(package private) java.lang.String	getNameText()
Point	getSize() Returns a point describing the receiver's size.
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() Returns true if the underlying operating system supports this reparenting, otherwise false
(package private) boolean	isTabGroup()
(package private) boolean	isTabItem()
(package private) Decorations	menuShell()
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseWidget()
(package private) void	removeMenu(Menu menu)
(package private) void	reskinChildren(int flags)
(package private) boolean	restoreFocus()
(package private) void	saveFocus()
(package private) void	setBounds(int x, int y, int width, int height, int flags, boolean defer)
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).
(package private) void	setDefaultButton(Button button, boolean save)
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.
(package private) void	setImages(Image image, Image[] images)
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	setOrientation(int orientation) Sets the orientation of the receiver, which must be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
(package private) void	setParent()
(package private) void	setPlacement(int x, int y, int width, int height, int flags)
(package private) void	setSavedFocus(Control control)
(package private) void	setSystemMenu()
void	setText(java.lang.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.
void	setVisible(boolean visible) Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
(package private) void	sort(Image[] images, ImageData[] datas, int width, int height, int depth)
(package private) boolean	translateAccelerator(MSG msg)
(package private) boolean	translateMDIAccelerator(MSG msg)
(package private) boolean	translateMenuAccelerator(MSG msg)
(package private) boolean	traverseDecorations(boolean next)
(package private) boolean	traverseItem(boolean next)
(package private) boolean	traverseReturn()
(package private) CREATESTRUCT	widgetCreateStruct()
(package private) int	widgetExtStyle()
(package private) int	widgetParent()
(package private) int	widgetStyle()
(package private) int	windowProc(int hwnd, int msg, int wParam, int lParam)
(package private) LRESULT	WM_ACTIVATE(int wParam, int lParam)
(package private) LRESULT	WM_CLOSE(int wParam, int lParam)
(package private) LRESULT	WM_HOTKEY(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_MOVE(int wParam, int lParam)
(package private) LRESULT	WM_NCACTIVATE(int wParam, int lParam)
(package private) LRESULT	WM_QUERYOPEN(int wParam, int lParam)
(package private) LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	WM_SYSCOMMAND(int wParam, int lParam)
(package private) LRESULT	WM_WINDOWPOSCHANGING(int wParam, int lParam)

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

clearArea, drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME, windowClass, WM_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INPUTLANGCHANGE, WM_LBUTTONDOWN, WM_WINDOWPOSCHANGED

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

_getChildren, _getTabList, changed, checkBuffered, checkComposited, computeSize, computeTabList, copyArea, drawBackground, findDeferredControl, findMenus, fixChildren, fixTabList, getBackgroundMode, getChildren, getChildrenCount, getLayout, getLayoutDeferred, getTabList, hooksKeys, isLayoutDeferred, layout, layout, layout, layout, layout, markLayout, minimumSize, redrawChildren, releaseParent, removeControl, resizeChildren, resizeChildren, resizeEmbeddedHandle, sendResize, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setResizeChildren, setTabGroupFocus, setTabList, toolTipText, translateMnemonic, translateTraversal, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateLayout, updateLayout, updateOrientation, updateUIState, WM_ERASEBKGND, WM_GETDLGCODE, WM_GETFONT, WM_NCHITTEST, WM_PAINT, WM_PARENTNOTIFY, WM_PRINTCLIENT, WM_SETFONT, WM_SYSCOLORCHANGE, WM_UPDATEUISTATE, wmNCPaint, wmNotify

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

createScrollBar, destroyScrollBar, getHorizontalBar, getScrollbarsMode, getVerticalBar, scrolledHandle, 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, checkGesture, checkHandle, checkMirrored, computeSize, 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, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isShowing, isVisible, mapEvent, 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, setForeground, setForegroundPixel, setLayoutData, setLocation, setLocation, setMenu, setParent, setRadioFocus, setRadioSelection, setRedraw, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, showWidget, sort, subclass, toControl, toControl, toDisplay, toDisplay, topHandle, translateMnemonic, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseMnemonic, traversePage, unsubclass, update, update, updateImages, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CLEAR, 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_IME_CHAR, WM_INITMENUPOPUP, WM_KEYDOWN, WM_KEYUP, 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_NCCALCSIZE, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PALETTECHANGED, WM_PASTE, WM_PRINT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_RBUTTONDBLCLK, WM_RBUTTONDOWN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETREDRAW, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TIMER, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, 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, checkOrientation, checkParent, checkWidget, DeferWindowPos, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, 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

image

Image image

smallImage

Image smallImage

largeImage

Image largeImage

images

Image[] images

menuBar

Menu menuBar

menus

Menu[] menus

savedFocus

Control savedFocus

defaultButton

Button defaultButton

saveDefault

Button saveDefault

swFlags

int swFlags

nAccel

int nAccel

hAccel

int hAccel

moved

boolean moved

resized

boolean resized

opened

boolean opened

oldX

int oldX

oldY

int oldY

oldWidth

int oldWidth

oldHeight

int oldHeight

maxRect

RECT maxRect

Constructor Detail

Decorations

Decorations()

Prevents uninitialized instances from being created outside the package.

Decorations

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

style - the style of control 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
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.BORDER, SWT.CLOSE, SWT.MIN, SWT.MAX, SWT.RESIZE, SWT.TITLE, SWT.NO_TRIM, SWT.SHELL_TRIM, SWT.DIALOG_TRIM, SWT.ON_TOP, SWT.TOOL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

_setMaximized

void _setMaximized(boolean maximized)

_setMinimized

void _setMinimized(boolean minimized)

addMenu

void addMenu(Menu menu)

bringToTop

void bringToTop()

checkStyle

static int checkStyle(int style)

checkBorder

void checkBorder()

Overrides:

checkBorder in class Control

checkComposited

void checkComposited(Composite parent)

checkOpened

void checkOpened()

Overrides:

checkOpened in class Widget

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 Composite

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

Overrides:

callWindowProc in class Scrollable

closeWidget

void closeWidget()

compare

int compare(ImageData data1,
          ImageData data2,
          int width,
          int height,
          int depth)

computeTabGroup

Widget computeTabGroup()

Overrides:

computeTabGroup in class Control

computeTabRoot

Control computeTabRoot()

Overrides:

computeTabRoot in class Control

computeTrim

public Rectangle computeTrim(int x,
                    int y,
                    int width,
                    int height)

Description copied from class: Scrollable

Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area.

In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).

Overrides:

computeTrim in class Scrollable

Parameters:

x - the desired x coordinate of the client area

y - the desired y coordinate of the client area

width - the desired width of the client area

height - the desired height of the client area

Returns:

the required bounds to produce the given client area

See Also:

Scrollable.getClientArea()

createAccelerators

void createAccelerators()

createHandle

void createHandle()

Overrides:

createHandle in class Composite

createWidget

void createWidget()

Overrides:

createWidget in class Scrollable

destroyAccelerators

void destroyAccelerators()

dispose

public void dispose()

Description copied from class: Widget

Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. This method does nothing if the widget is already disposed.

NOTE: This method is not called recursively on the descendants of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the Dispose event.

Overrides:

dispose in class Widget

See Also:

Widget.addDisposeListener(org.eclipse.swt.events.DisposeListener), Widget.removeDisposeListener(org.eclipse.swt.events.DisposeListener), Widget.checkWidget()

findMenu

Menu findMenu(int hMenu)

fixDecorations

void fixDecorations(Decorations newDecorations,
                  Control control,
                  Menu[] menus)

getBounds

public Rectangle getBounds()

Description copied from class: Control

Returns a rectangle describing the receiver's size and location relative to its parent (or its display if its parent is null), unless the receiver is a shell. In this case, the location is relative to the display.

Overrides:

getBounds in class Control

Returns:

the receiver's bounding rectangle

getClientArea

public Rectangle getClientArea()

Description copied from class: Scrollable

Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").

Overrides:

getClientArea in class Scrollable

Returns:

the client area

See Also:

Scrollable.computeTrim(int, int, int, int)

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

See Also:

setDefaultButton(Button)

getImage

public Image getImage()

Returns the receiver's image if it had previously been set using 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.

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

getImages

public Image[] getImages()

Returns the receiver's images if they had previously been set using setImages(). 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:

3.0

getLocation

public Point getLocation()

Description copied from class: Control

Returns a point describing the receiver's location relative to its parent (or its display if its parent is null), unless the receiver is a shell. In this case, the point is relative to the display.

Overrides:

getLocation in class Control

Returns:

the receiver's location

getMaximized

public boolean getMaximized()

Returns true if the receiver is currently maximized, and false otherwise.

Returns:

the maximized 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:

setMaximized(boolean)

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

getMinimized

public boolean getMinimized()

Returns true if the receiver is currently minimized, and false otherwise.

Returns:

the minimized 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:

setMinimized(boolean)

getNameText

java.lang.String getNameText()

Overrides:

getNameText in class Widget

getSize

public Point getSize()

Description copied from class: Control

Returns a point describing the receiver's size. The x coordinate of the result is the width of the receiver. The y coordinate of the result is the height of the receiver.

Overrides:

getSize in class Control

Returns:

the receiver's size

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

isReparentable

public boolean isReparentable()

Description copied from class: Control

Returns true if the underlying operating system supports this reparenting, otherwise false

Overrides:

isReparentable in class Control

Returns:

true if the widget can be reparented, otherwise false

isTabGroup

boolean isTabGroup()

Overrides:

isTabGroup in class Control

isTabItem

boolean isTabItem()

Overrides:

isTabItem in class Control

menuShell

Decorations menuShell()

Overrides:

menuShell in class Control

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Canvas

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

removeMenu

void removeMenu(Menu menu)

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Canvas

restoreFocus

boolean restoreFocus()

saveFocus

void saveFocus()

setBounds

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

Overrides:

setBounds in class Composite

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

setDefaultButton

void setDefaultButton(Button button,
                    boolean save)

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

setImages

void setImages(Image image,
             Image[] images)

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:

3.0

setMaximized

public void setMaximized(boolean maximized)

Sets the maximized state of the receiver. If the argument is 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.

Parameters:

maximized - the new maximized 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:

setMinimized(boolean)

setMenuBar

public void setMenuBar(Menu menu)

Sets the receiver's menu bar to the argument, which may be null.

Parameters:

menu - 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

setMinimized

public void setMinimized(boolean minimized)

Sets the minimized stated of the receiver. If the argument is 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.

Parameters:

minimized - the new maximized 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:

setMaximized(boolean)

setOrientation

public void setOrientation(int orientation)

Description copied from class: Control

Sets the orientation of the receiver, which must be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.

Overrides:

setOrientation in class Control

Parameters:

orientation - new orientation style

setParent

void setParent()

setPlacement

void setPlacement(int x,
                int y,
                int width,
                int height,
                int flags)

setSavedFocus

void setSavedFocus(Control control)

setSystemMenu

void setSystemMenu()

setText

public void setText(java.lang.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.

Parameters:

string - 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

setVisible

public void setVisible(boolean visible)

Description copied from class: Control

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Overrides:

setVisible in class Control

Parameters:

visible - the new visibility state

sort

void sort(Image[] images,
        ImageData[] datas,
        int width,
        int height,
        int depth)

translateAccelerator

boolean translateAccelerator(MSG msg)

Overrides:

translateAccelerator in class Control

translateMenuAccelerator

boolean translateMenuAccelerator(MSG msg)

translateMDIAccelerator

boolean translateMDIAccelerator(MSG msg)

traverseDecorations

boolean traverseDecorations(boolean next)

traverseItem

boolean traverseItem(boolean next)

Overrides:

traverseItem in class Control

traverseReturn

boolean traverseReturn()

Overrides:

traverseReturn in class Control

widgetCreateStruct

CREATESTRUCT widgetCreateStruct()

Overrides:

widgetCreateStruct in class Control

widgetExtStyle

int widgetExtStyle()

Overrides:

widgetExtStyle in class Scrollable

widgetParent

int widgetParent()

Overrides:

widgetParent in class Control

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Composite

windowProc

int windowProc(int hwnd,
             int msg,
             int wParam,
             int lParam)

Overrides:

windowProc in class Canvas

WM_ACTIVATE

LRESULT WM_ACTIVATE(int wParam,
                  int lParam)

Overrides:

WM_ACTIVATE in class Control

WM_CLOSE

LRESULT WM_CLOSE(int wParam,
               int lParam)

Overrides:

WM_CLOSE in class Control

WM_HOTKEY

LRESULT WM_HOTKEY(int wParam,
                int lParam)

Overrides:

WM_HOTKEY in class Control

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

Overrides:

WM_KILLFOCUS in class Canvas

WM_MOVE

LRESULT WM_MOVE(int wParam,
              int lParam)

Overrides:

WM_MOVE in class Control

WM_NCACTIVATE

LRESULT WM_NCACTIVATE(int wParam,
                    int lParam)

Overrides:

WM_NCACTIVATE in class Control

WM_QUERYOPEN

LRESULT WM_QUERYOPEN(int wParam,
                   int lParam)

Overrides:

WM_QUERYOPEN in class Control

WM_SETFOCUS

LRESULT WM_SETFOCUS(int wParam,
                  int lParam)

Overrides:

WM_SETFOCUS in class Canvas

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Canvas

WM_SYSCOMMAND

LRESULT WM_SYSCOMMAND(int wParam,
                    int lParam)

Overrides:

WM_SYSCOMMAND in class Composite

WM_WINDOWPOSCHANGING

LRESULT WM_WINDOWPOSCHANGING(int wParam,
                           int lParam)

Overrides:

WM_WINDOWPOSCHANGING in class Canvas