org.eclipse.swt.widgets

Class Menu

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Menu

public class Menu
extends Widget

Instances of this class are user interface objects that contain menu items.

Styles:

BAR, DROP_DOWN, POP_UP, NO_RADIO_GROUP

LEFT_TO_RIGHT, RIGHT_TO_LEFT

Events:

Help, Hide, Show

Note: Only one of BAR, DROP_DOWN and POP_UP may be specified. Only one of LEFT_TO_RIGHT or RIGHT_TO_LEFT may be specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

Menu snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	background
(package private) Image	backgroundImage
(package private) MenuItem	cascade
(package private) int	foreground
int	handle the handle to the OS resource (Warning: This field is platform dependent) IMPORTANT: This field is not part of the SWT public API.
(package private) boolean	hasLocation
(package private) int	hBrush
(package private) int	hwndCB
(package private) static int	ID_PPC
(package private) static int	ID_SPBB
(package private) static int	ID_SPBM
(package private) static int	ID_SPMB
(package private) static int	ID_SPMM
(package private) static int	ID_SPSOFTKEY0
(package private) static int	ID_SPSOFTKEY1
(package private) int	id0
(package private) int	id1
(package private) ImageList	imageList
(package private) Decorations	parent
(package private) int	x
(package private) int	y

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
Menu(Control parent) Constructs a new instance of this class given its parent, and sets the style for the instance so that the instance will be a popup menu on the given parent's shell.
Menu(Decorations parent, int style) Constructs a new instance of this class given its parent (which must be a Decorations) and a style value describing its behavior and appearance.
Menu(Decorations parent, int style, int handle)
Menu(Menu parentMenu) Constructs a new instance of this class given its parent (which must be a Menu) and sets the style for the instance so that the instance will be a drop-down menu on the given parent's parent.
Menu(MenuItem parentItem) Constructs a new instance of this class given its parent (which must be a MenuItem) and sets the style for the instance so that the instance will be a drop-down menu on the given parent's parent menu.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	_setOrientation(int orientation)
(package private) void	_setVisible(boolean visible)
void	addHelpListener(HelpListener listener) Adds the listener to the collection of listeners who will be notified when help events are generated for the control, by sending it one of the messages defined in the HelpListener interface.
void	addMenuListener(MenuListener listener) Adds the listener to the collection of listeners who will be notified when menus are hidden or shown, by sending it one of the messages defined in the MenuListener interface.
(package private) static Control	checkNull(Control control)
(package private) static Menu	checkNull(Menu menu)
(package private) static MenuItem	checkNull(MenuItem item)
(package private) static int	checkStyle(int style)
(package private) void	createHandle()
(package private) void	createItem(MenuItem item, int index)
(package private) void	createWidget()
(package private) int	defaultBackground()
(package private) int	defaultForeground()
(package private) void	destroyAccelerators()
(package private) void	destroyItem(MenuItem item)
(package private) void	destroyWidget() Destroys the widget in the operating system and releases the widget's handle.
(package private) void	fixMenus(Decorations newParent)
(package private) Color	getBackground() Returns the receiver's background color.
(package private) Image	getBackgroundImage() Returns the receiver's background image.
(package private) 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 menu or a shell.
MenuItem	getDefaultItem() Returns the default menu item or null if none has been previously set.
boolean	getEnabled() Returns true if the receiver is enabled, and false otherwise.
(package private) Color	getForeground() Returns the foreground color that the receiver will use to draw.
MenuItem	getItem(int index) Returns the item at the given, zero-relative index in the receiver.
int	getItemCount() Returns the number of items contained in the receiver.
MenuItem[]	getItems() Returns a (possibly empty) array of MenuItems which are the items in the receiver.
(package private) int	GetMenuItemCount(int handle)
(package private) java.lang.String	getNameText()
int	getOrientation() Returns the orientation of the receiver, which will be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
Decorations	getParent() Returns the receiver's parent, which must be a Decorations.
MenuItem	getParentItem() Returns the receiver's parent item, which must be a MenuItem or null when the receiver is a root.
Menu	getParentMenu() Returns the receiver's parent item, which must be a Menu or null when the receiver is a root.
Shell	getShell() Returns the receiver's shell.
boolean	getVisible() Returns true if the receiver is visible, and false otherwise.
(package private) int	imageIndex(Image image)
int	indexOf(MenuItem item) Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item.
boolean	isEnabled() Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise.
boolean	isVisible() Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.
(package private) void	redraw()
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseHandle()
(package private) void	releaseParent()
(package private) void	releaseWidget()
void	removeHelpListener(HelpListener listener) Removes the listener from the collection of listeners who will be notified when the help events are generated for the control.
void	removeMenuListener(MenuListener listener) Removes the listener from the collection of listeners who will be notified when the menu events are generated for the control.
(package private) void	reskinChildren(int flags)
(package private) void	setBackground(Color color) Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
(package private) void	setBackgroundImage(Image image) Sets the receiver's background image to the image specified by the argument, or to the default system color for the control if the argument is null.
void	setDefaultItem(MenuItem item) Sets the default menu item to the argument or removes the default emphasis when the argument is null.
void	setEnabled(boolean enabled) Enables the receiver if the argument is true, and disables it otherwise.
(package private) void	setForeground(Color color) Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
void	setLocation(int x, int y) Sets the location of the receiver, which must be a popup, to the point specified by the arguments which are relative to the display.
void	setLocation(Point location) Sets the location of the receiver, which must be a popup, to the point specified by the argument which is relative to the display.
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.
void	setVisible(boolean visible) Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
(package private) void	update()
(package private) void	updateBackground()
(package private) void	updateForeground()

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

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, removeDisposeListener, removeListener, removeListener, reskin, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, 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

handle

public int handle

the handle to the OS resource (Warning: This field is platform dependent)

IMPORTANT: This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

x

int x

y

int y

hBrush

int hBrush

hwndCB

int hwndCB

id0

int id0

id1

int id1

foreground

int foreground

background

int background

backgroundImage

Image backgroundImage

hasLocation

boolean hasLocation

cascade

MenuItem cascade

parent

Decorations parent

imageList

ImageList imageList

ID_PPC

static final int ID_PPC

See Also:

Constant Field Values

ID_SPMM

static final int ID_SPMM

See Also:

Constant Field Values

ID_SPBM

static final int ID_SPBM

See Also:

Constant Field Values

ID_SPMB

static final int ID_SPMB

See Also:

Constant Field Values

ID_SPBB

static final int ID_SPBB

See Also:

Constant Field Values

ID_SPSOFTKEY0

static final int ID_SPSOFTKEY0

See Also:

Constant Field Values

ID_SPSOFTKEY1

static final int ID_SPSOFTKEY1

See Also:

Constant Field Values

Constructor Detail

Menu

public Menu(Control parent)

Constructs a new instance of this class given its parent, and sets the style for the instance so that the instance will be a popup menu on the given parent's shell.

After constructing a menu, it can be set into its parent using parent.setMenu(menu). In this case, the parent may be any control in the same widget tree as the parent.

Parameters:

parent - a control which will be the parent of the new instance (cannot be null)

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.POP_UP, Widget.checkSubclass(), Widget.getStyle()

Menu

public Menu(Decorations parent,
    int style)

Constructs a new instance of this class given its parent (which must be a Decorations) 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.

After constructing a menu or menuBar, it can be set into its parent using parent.setMenu(menu) or parent.setMenuBar(menuBar).

Parameters:

parent - a decorations control which will be the parent of the new instance (cannot be null)

style - the style of menu 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.BAR, SWT.DROP_DOWN, SWT.POP_UP, SWT.NO_RADIO_GROUP, SWT.LEFT_TO_RIGHT, SWT.RIGHT_TO_LEFT, Widget.checkSubclass(), Widget.getStyle()

Menu

public Menu(Menu parentMenu)

Constructs a new instance of this class given its parent (which must be a Menu) and sets the style for the instance so that the instance will be a drop-down menu on the given parent's parent.

After constructing a drop-down menu, it can be set into its parentMenu using parentMenu.setMenu(menu).

Parameters:

parentMenu - a menu which will be the parent of the new instance (cannot be null)

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.DROP_DOWN, Widget.checkSubclass(), Widget.getStyle()

Menu

public Menu(MenuItem parentItem)

Constructs a new instance of this class given its parent (which must be a MenuItem) and sets the style for the instance so that the instance will be a drop-down menu on the given parent's parent menu.

After constructing a drop-down menu, it can be set into its parentItem using parentItem.setMenu(menu).

Parameters:

parentItem - a menu item which will be the parent of the new instance (cannot be null)

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.DROP_DOWN, Widget.checkSubclass(), Widget.getStyle()

Menu

Menu(Decorations parent,
    int style,
    int handle)

Method Detail

_setVisible

void _setVisible(boolean visible)

addHelpListener

public void addHelpListener(HelpListener listener)

Adds the listener to the collection of listeners who will be notified when help events are generated for the control, by sending it one of the messages defined in the HelpListener interface.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

HelpListener, removeHelpListener(org.eclipse.swt.events.HelpListener)

addMenuListener

public void addMenuListener(MenuListener listener)

Adds the listener to the collection of listeners who will be notified when menus are hidden or shown, by sending it one of the messages defined in the MenuListener interface.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

MenuListener, removeMenuListener(org.eclipse.swt.events.MenuListener)

checkNull

static Control checkNull(Control control)

checkNull

static Menu checkNull(Menu menu)

checkNull

static MenuItem checkNull(MenuItem item)

checkStyle

static int checkStyle(int style)

createHandle

void createHandle()

createItem

void createItem(MenuItem item,
              int index)

createWidget

void createWidget()

defaultBackground

int defaultBackground()

defaultForeground

int defaultForeground()

destroyAccelerators

void destroyAccelerators()

destroyItem

void destroyItem(MenuItem item)

destroyWidget

void destroyWidget()

Description copied from class: Widget

Destroys the widget in the operating system and releases the widget's handle. If the widget does not have a handle, this method may hide the widget, mark the widget as destroyed or do nothing, depending on the widget.

When a widget is destroyed in the operating system, its descendants are also destroyed by the operating system. This means that it is only necessary to call destroyWidget on the root of the widget tree.

This method is called after releaseWidget().

See also releaseChild(), releaseWidget() and releaseHandle().

Overrides:

destroyWidget in class Widget

See Also:

Widget.dispose()

fixMenus

void fixMenus(Decorations newParent)

getBackground

Color getBackground()

Returns the receiver's background color.

Returns:

the background color

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.3

getBackgroundImage

Image getBackgroundImage()

Returns the receiver's background image.

Returns:

the background 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

Since:

3.3

getBounds

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 menu or a shell. In this case, the location is relative to the display.

Note that the bounds of a menu or menu item are undefined when the menu is not visible. This is because most platforms compute the bounds of a menu dynamically just before it is displayed.

Returns:

the receiver's bounding rectangle

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.1

getDefaultItem

public MenuItem getDefaultItem()

Returns the default menu item or null if none has been previously set.

Returns:

the default menu item.

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

getEnabled

public boolean getEnabled()

Returns true if the receiver is enabled, and false otherwise. A disabled menu is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Returns:

the receiver's enabled 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:

isEnabled()

getForeground

Color getForeground()

Returns the foreground color that the receiver will use to draw.

Returns:

the receiver's foreground color

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

getItem

public MenuItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:

index - the index of the item to return

Returns:

the item at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver.

Returns:

the number of items

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

getItems

public MenuItem[] getItems()

Returns a (possibly empty) array of MenuItems which are the items in the receiver.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

Returns:

the items in the receiver

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

GetMenuItemCount

int GetMenuItemCount(int handle)

getNameText

java.lang.String getNameText()

Overrides:

getNameText in class Widget

getOrientation

public int getOrientation()

Returns the orientation of the receiver, which will be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.

Returns:

the orientation style

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

getParent

public Decorations getParent()

Returns the receiver's parent, which must be a Decorations.

Returns:

the receiver's parent

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

getParentItem

public MenuItem getParentItem()

Returns the receiver's parent item, which must be a MenuItem or null when the receiver is a root.

Returns:

the receiver's parent item

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

getParentMenu

public Menu getParentMenu()

Returns the receiver's parent item, which must be a Menu or null when the receiver is a root.

Returns:

the receiver's parent item

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

getShell

public Shell getShell()

Returns the receiver's shell. For all controls other than shells, this simply returns the control's nearest ancestor shell. Shells return themselves, even if they are children of other shells.

Returns:

the receiver's shell

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:

getParent()

getVisible

public boolean getVisible()

Returns true if the receiver is visible, and false otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Returns:

the receiver's visibility 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

imageIndex

int imageIndex(Image image)

indexOf

public int indexOf(MenuItem item)

Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

Parameters:

item - the search item

Returns:

the index of the item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item 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

isEnabled

public boolean isEnabled()

Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise. A disabled menu is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Returns:

the receiver's enabled 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:

getEnabled()

isVisible

public boolean isVisible()

Returns true if the receiver is visible and all of the receiver's ancestors are visible and false otherwise.

Returns:

the receiver's visibility 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:

getVisible()

redraw

void redraw()

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Widget

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Widget

releaseParent

void releaseParent()

Overrides:

releaseParent in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

removeHelpListener

public void removeHelpListener(HelpListener listener)

Removes the listener from the collection of listeners who will be notified when the help events are generated for the control.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

HelpListener, addHelpListener(org.eclipse.swt.events.HelpListener)

removeMenuListener

public void removeMenuListener(MenuListener listener)

Removes the listener from the collection of listeners who will be notified when the menu events are generated for the control.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener 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

See Also:

MenuListener, addMenuListener(org.eclipse.swt.events.MenuListener)

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Widget

setBackground

void setBackground(Color color)

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument 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.3

setBackgroundImage

void setBackgroundImage(Image image)

Sets the receiver's background image to the image specified by the argument, or to the default system color for the control if the argument is null. The background image is tiled to fill the available space.

Parameters:

image - the new image (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed
• ERROR_INVALID_ARGUMENT - if the argument is not a bitmap

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.3

setForeground

void setForeground(Color color)

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument 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.3

setDefaultItem

public void setDefaultItem(MenuItem item)

Sets the default menu item to the argument or removes the default emphasis when the argument is null.

Parameters:

item - the default menu item or null

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the menu item 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

setEnabled

public void setEnabled(boolean enabled)

Enables the receiver if the argument is true, and disables it otherwise. A disabled menu is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Parameters:

enabled - the new enabled 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

setLocation

public void setLocation(int x,
               int y)

Sets the location of the receiver, which must be a popup, to the point specified by the arguments which are relative to the display.

Note that this is different from most widgets where the location of the widget is relative to the parent.

Note that the platform window manager ultimately has control over the location of popup menus.

Parameters:

x - the new x coordinate for the receiver

y - the new y coordinate for the receiver

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

setLocation

public void setLocation(Point location)

Sets the location of the receiver, which must be a popup, to the point specified by the argument which is relative to the display.

Note that this is different from most widgets where the location of the widget is relative to the parent.

Note that the platform window manager ultimately has control over the location of popup menus.

Parameters:

location - the new location for the receiver

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point 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.1

setOrientation

public 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.

Parameters:

orientation - new orientation style

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

_setOrientation

void _setOrientation(int orientation)

setVisible

public void setVisible(boolean visible)

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.

Parameters:

visible - the new visibility 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

update

void update()

updateBackground

void updateBackground()

updateForeground

void updateForeground()