Top Description Inners Fields Constructors Methods
org.eclipse.swt.widgets

public Class MenuItem

extends Item
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.events.*, org.eclipse.swt.graphics.*, org.eclipse.swt.internal.*, org.eclipse.swt.internal.gtk.*, org.eclipse.swt.internal.gtk3.*, org.eclipse.swt.internal.gtk4.*, org.eclipse.swt.widgets.Menu.*
Instances of this class represent a selectable user interface object that issues notification when pressed and released.
Styles:
CHECK, CASCADE, PUSH, RADIO, SEPARATOR
Events:
Arm, Help, Selection

Note

Only one of the styles CHECK, CASCADE, PUSH, RADIO and SEPARATOR may be specified.

Important Note

This class is not intended to be subclassed.

See Also
Sample code and further information

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
MenuItem.MaskKeysym

Field Summary

Modifier and TypeField and Description
pack-priv int
accelerator

pack-priv long
actionHandle

GTK4 only fields

pack-priv String
actionName

pack-priv long
boxHandle

Feature in Gtk: as of Gtk version 3.10 GtkImageMenuItem is deprecated, meaning that MenuItems in SWT with images can no longer be GtkImageMenuItems after Gtk3.10.

pack-priv Image
defaultDisableImage

pack-priv boolean
enabled

pack-priv long
groupHandle

pack-priv long
imageHandle

pack-priv long
labelHandle

pack-priv long
modelHandle

GTK4 only fields

pack-priv Menu
parent

pack-priv Menu.Section
section

pack-priv long
shortcutHandle

GTK4 only fields

pack-priv String
toolTipText

pack-priv int
userId

Inherited from org.eclipse.swt.widgets.Item:
ELLIPSISimagetextTEXT_LIMIT

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
private void
_setEnabledOrDisabledImage()

private void
_setImage(Image image)

pack-priv void
addAccelerator(long accelGroup)

pack-priv void
addAccelerators(long accelGroup)

public void
addArmListener(ArmListener
the listener which should be notified
listener)

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

public void
addHelpListener(HelpListener
the listener which should be notified
listener)

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

public void
addSelectionListener(SelectionListener
the listener which should be notified when the menu item is selected by the user
listener)

Adds the listener to the collection of listeners who will be notified when the menu item is selected by the user, by sending it one of the messages defined in the SelectionListener interface.

pack-priv void
addShortcut(int accelerator)

pack-priv static int
checkStyle(int style)

protected void
checkSubclass()

Overrides org.eclipse.swt.widgets.Item.checkSubclass.

Checks that this class can be subclassed.
pack-priv void
createHandle(int index)

Overrides org.eclipse.swt.widgets.Widget.createHandle.

pack-priv void
destroyWidget()

Overrides org.eclipse.swt.widgets.Widget.destroyWidget.

private void
disposeDefaultDisabledImage()

pack-priv long
dpiChanged(long object, long arg0)

Overrides org.eclipse.swt.widgets.Widget.dpiChanged.

pack-priv void
fixMenus(Decorations newParent)

public int

Returns:

the accelerator or 0
getAccelerator()

Returns the widget accelerator.

pack-priv long
getAccelGroup()

public boolean

Returns:

the receiver's enabled state
getEnabled()

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

public int

Returns:

the receiver's identifier
getID()

Gets the identifier associated with the receiver.

private MenuItem.MaskKeysym
getMaskKeysym()

public Menu

Returns:

the receiver's menu
getMenu()

Returns the receiver's cascade menu if it has one or null if it does not.

pack-priv String
getNameText()

Overrides org.eclipse.swt.widgets.Item.getNameText.

public Menu

Returns:

the receiver's parent
getParent()

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

public boolean

Returns:

the selection state
getSelection()

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

public String

Returns:

the receiver's tool tip text
getToolTipText()

Returns the receiver's tool tip text, or null if it has not been set.

pack-priv long
gtk3_show_help(long widget, long helpType)

Overrides org.eclipse.swt.widgets.Widget.gtk3_show_help.

pack-priv long
gtk_activate(long widget)

Overrides org.eclipse.swt.widgets.Widget.gtk_activate.

pack-priv long
gtk_select(long item)

Overrides org.eclipse.swt.widgets.Widget.gtk_select.

pack-priv void
hookEvents()

Overrides org.eclipse.swt.widgets.Widget.hookEvents.

public boolean

Returns:

the receiver's enabled state
isEnabled()

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

pack-priv void
releaseChildren(boolean destroy)

Overrides org.eclipse.swt.widgets.Widget.releaseChildren.

pack-priv void
releaseParent()

Overrides org.eclipse.swt.widgets.Widget.releaseParent.

pack-priv void
releaseWidget()

Overrides org.eclipse.swt.widgets.Item.releaseWidget.

pack-priv void
removeAccelerator(long accelGroup)

pack-priv void
removeAccelerators(long accelGroup)

public void
removeArmListener(ArmListener
the listener which should no longer be notified
listener)

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

public void
removeHelpListener(HelpListener
the listener which should no longer be notified
listener)

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

public void
removeSelectionListener(SelectionListener
the listener which should no longer be notified
listener)

Removes the listener from the collection of listeners who will be notified when the control is selected by the user.

pack-priv void
reskinChildren(int flags)

Overrides org.eclipse.swt.widgets.Widget.reskinChildren.

pack-priv void
selectRadio()

public void
setAccelerator(int
an integer that is the bit-wise OR of masks and a key
accelerator)

Sets the widget accelerator.

public void
setEnabled(boolean
the new enabled state
enabled)

Enables the receiver if the argument is true, and disables it otherwise.

public void
setID(int
the new identifier. This must be a non-negative value. System-defined identifiers are negative values.
id)

Sets the identifier associated with the receiver to the argument.

public void
setImage(Image
the image to display on the receiver (may be null)
image)

Overrides org.eclipse.swt.widgets.Item.setImage.

Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
public void
setMenu(Menu
the new pull down menu
menu)

Sets the receiver's pull down menu to the argument.

pack-priv void
setOrientation(boolean create)

Overrides org.eclipse.swt.widgets.Widget.setOrientation.

pack-priv boolean
setRadioSelection(boolean value)

public void
setSelection(boolean
the new selection state
selected)

Sets the selection state of the receiver.

public void
setText(String
the new text
string)

Overrides org.eclipse.swt.widgets.Item.setText.

Sets the receiver's text.
public void
setToolTipText(String
the new tool tip text (or null)
toolTip)

Sets the receiver's tool tip text to the argument, which may be null indicating that the default tool tip for the control will be shown.

pack-priv void
updateAccelerator(long accelGroup, boolean add)

pack-priv boolean
updateAcceleratorText(boolean show)

Inherited from org.eclipse.swt.widgets.Item:
getImagegetTextupdateTextDirection

Field Detail

acceleratorback to summary
pack-priv int accelerator
actionHandleback to summary
pack-priv long actionHandle

GTK4 only fields

actionNameback to summary
pack-priv String actionName
boxHandleback to summary
pack-priv long boxHandle

Feature in Gtk: as of Gtk version 3.10 GtkImageMenuItem is deprecated, meaning that MenuItems in SWT with images can no longer be GtkImageMenuItems after Gtk3.10. The solution to this is to create a GtkMenuItem, add a GtkBox as its child, and pack that box with a GtkLabel and GtkImage. This reproduces the functionality of a GtkImageMenuItem and allows SWT to retain image support for MenuItems. For more information see: https://developer.gnome.org/gtk3/stable/GtkImageMenuItem.html#GtkImageMenuItem.description Bug 470298

defaultDisableImageback to summary
pack-priv Image defaultDisableImage
enabledback to summary
pack-priv boolean enabled
groupHandleback to summary
pack-priv long groupHandle
imageHandleback to summary
pack-priv long imageHandle
labelHandleback to summary
pack-priv long labelHandle
modelHandleback to summary
pack-priv long modelHandle

GTK4 only fields

parentback to summary
pack-priv Menu parent
sectionback to summary
pack-priv Menu.Section section
shortcutHandleback to summary
pack-priv long shortcutHandle

GTK4 only fields

toolTipTextback to summary
pack-priv String toolTipText
userIdback to summary
pack-priv int userId

Constructor Detail

MenuItemback to summary
public MenuItem(Menu parent, int style)

Constructs a new instance of this class given its parent (which must be a Menu) and a style value describing its behavior and appearance. The item is added to the end of the items maintained by its parent.

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:Menu

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

style:int

the style of control to construct

Exceptions
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#CHECK, SWT#CASCADE, SWT#PUSH, SWT#RADIO, SWT#SEPARATOR, Widget#checkSubclass, Widget#getStyle
MenuItemback to summary
public MenuItem(Menu parent, int style, int index)

Constructs a new instance of this class given its parent (which must be a Menu), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent.

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:Menu

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

style:int

the style of control to construct

index:int

the zero-relative index to store the receiver in its parent

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the parent is null
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)
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#CHECK, SWT#CASCADE, SWT#PUSH, SWT#RADIO, SWT#SEPARATOR, Widget#checkSubclass, Widget#getStyle

Method Detail

_setEnabledOrDisabledImageback to summary
private void _setEnabledOrDisabledImage()
_setImageback to summary
private void _setImage(Image image)
addAcceleratorback to summary
pack-priv void addAccelerator(long accelGroup)
addAcceleratorsback to summary
pack-priv void addAccelerators(long accelGroup)
addArmListenerback to summary
public void addArmListener(ArmListener listener)

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

Parameters
listener:ArmListener

the listener which should be notified

Exceptions
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
ArmListener, removeArmListener
addHelpListenerback to summary
public void addHelpListener(HelpListener listener)

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

Parameters
listener:HelpListener

the listener which should be notified

Exceptions
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
addSelectionListenerback to summary
public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the menu item is selected by the user, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the stateMask field of the event object is valid. widgetDefaultSelected is not called.

When the SWT.RADIO style bit is set, the widgetSelected method is also called when the receiver loses selection because another item in the same radio group was selected by the user. During widgetSelected the application can use getSelection() to determine the current selected state of the receiver.

Parameters
listener:SelectionListener

the listener which should be notified when the menu item is selected by the user

Exceptions
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
SelectionListener, removeSelectionListener, SelectionEvent
addShortcutback to summary
pack-priv void addShortcut(int accelerator)
checkStyleback to summary
pack-priv static int checkStyle(int style)
checkSubclassback to summary
protected void checkSubclass()

Overrides org.eclipse.swt.widgets.Item.checkSubclass.

Doc from org.eclipse.swt.widgets.Widget.checkSubclass.

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 Note

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.

Annotations
@Override
createHandleback to summary
pack-priv void createHandle(int index)

Overrides org.eclipse.swt.widgets.Widget.createHandle.

Annotations
@Override
destroyWidgetback to summary
pack-priv void destroyWidget()

Overrides org.eclipse.swt.widgets.Widget.destroyWidget.

Annotations
@Override
disposeDefaultDisabledImageback to summary
private void disposeDefaultDisabledImage()
dpiChangedback to summary
pack-priv long dpiChanged(long object, long arg0)

Overrides org.eclipse.swt.widgets.Widget.dpiChanged.

Annotations
@Override
fixMenusback to summary
pack-priv void fixMenus(Decorations newParent)
getAcceleratorback to summary
public int getAccelerator()

Returns the widget accelerator. An accelerator is the bit-wise OR of zero or more modifier masks and a key. Examples: SWT.CONTROL | SWT.SHIFT | 'T', SWT.ALT | SWT.F2. The default value is zero, indicating that the menu item does not have an accelerator.

Returns:int

the accelerator or 0

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getAccelGroupback to summary
pack-priv long getAccelGroup()
getEnabledback to summary
public boolean getEnabled()

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

Returns:boolean

the receiver's enabled state

Exceptions
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
getIDback to summary
public int getID()

Gets the identifier associated with the receiver.

Returns:int

the receiver's identifier

Exceptions
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
getMaskKeysymback to summary
private MenuItem.MaskKeysym getMaskKeysym()
getMenuback to summary
public Menu getMenu()

Returns the receiver's cascade menu if it has one or null if it does not. Only CASCADE menu items can have a pull down menu. The sequence of key strokes, button presses and/or button releases that are used to request a pull down menu is platform specific.

Returns:Menu

the receiver's menu

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getNameTextback to summary
pack-priv String getNameText()

Overrides org.eclipse.swt.widgets.Item.getNameText.

Annotations
@Override
getParentback to summary
public Menu getParent()

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

Returns:Menu

the receiver's parent

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getSelectionback to summary
public boolean getSelection()

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

When the receiver is of type CHECK or RADIO, it is selected when it is checked.

Returns:boolean

the selection state

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getToolTipTextback to summary
public String getToolTipText()

Returns the receiver's tool tip text, or null if it has not been set.

Returns:String

the receiver's tool tip text

Exceptions
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.104
gtk3_show_helpback to summary
pack-priv long gtk3_show_help(long widget, long helpType)

Overrides org.eclipse.swt.widgets.Widget.gtk3_show_help.

Annotations
@Override
gtk_activateback to summary
pack-priv long gtk_activate(long widget)

Overrides org.eclipse.swt.widgets.Widget.gtk_activate.

Annotations
@Override
gtk_selectback to summary
pack-priv long gtk_select(long item)

Overrides org.eclipse.swt.widgets.Widget.gtk_select.

Annotations
@Override
hookEventsback to summary
pack-priv void hookEvents()

Overrides org.eclipse.swt.widgets.Widget.hookEvents.

Annotations
@Override
isEnabledback to summary
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 item is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Returns:boolean

the receiver's enabled state

Exceptions
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
releaseChildrenback to summary
pack-priv void releaseChildren(boolean destroy)

Overrides org.eclipse.swt.widgets.Widget.releaseChildren.

Annotations
@Override
releaseParentback to summary
pack-priv void releaseParent()

Overrides org.eclipse.swt.widgets.Widget.releaseParent.

Annotations
@Override
releaseWidgetback to summary
pack-priv void releaseWidget()

Overrides org.eclipse.swt.widgets.Item.releaseWidget.

Annotations
@Override
removeAcceleratorback to summary
pack-priv void removeAccelerator(long accelGroup)
removeAcceleratorsback to summary
pack-priv void removeAccelerators(long accelGroup)
removeArmListenerback to summary
public void removeArmListener(ArmListener listener)

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

Parameters
listener:ArmListener

the listener which should no longer be notified

Exceptions
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
ArmListener, addArmListener
removeHelpListenerback to summary
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:HelpListener

the listener which should no longer be notified

Exceptions
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
removeSelectionListenerback to summary
public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control is selected by the user.

Parameters
listener:SelectionListener

the listener which should no longer be notified

Exceptions
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
SelectionListener, addSelectionListener
reskinChildrenback to summary
pack-priv void reskinChildren(int flags)

Overrides org.eclipse.swt.widgets.Widget.reskinChildren.

Annotations
@Override
selectRadioback to summary
pack-priv void selectRadio()
setAcceleratorback to summary
public void setAccelerator(int accelerator)

Sets the widget accelerator. An accelerator is the bit-wise OR of zero or more modifier masks and a key. Examples: SWT.MOD1 | SWT.MOD2 | 'T', SWT.MOD3 | SWT.F2. SWT.CONTROL | SWT.SHIFT | 'T', SWT.ALT | SWT.F2. The default value is zero, indicating that the menu item does not have an accelerator.

Parameters
accelerator:int

an integer that is the bit-wise OR of masks and a key

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setEnabledback to summary
public void setEnabled(boolean enabled)

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

Parameters
enabled:boolean

the new enabled state

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setIDback to summary
public void setID(int id)

Sets the identifier associated with the receiver to the argument.

Parameters
id:int

the new identifier. This must be a non-negative value. System-defined identifiers are negative values.

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
  • ERROR_INVALID_ARGUMENT - if called with an negative-valued argument.
Since
3.7
setImageback to summary
public void setImage(Image image)

Overrides org.eclipse.swt.widgets.Item.setImage.

Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.

Note

This operation is a HINT and is not supported on platforms that do not have this concept (for example, Windows NT). Some platforms (such as GTK3) support images alongside check boxes.

Parameters
image:Image

the image to display on the receiver (may be null)

Annotations
@Override
Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setMenuback to summary
public void setMenu(Menu menu)

Sets the receiver's pull down menu to the argument. Only CASCADE menu items can have a pull down menu. The sequence of key strokes, button presses and/or button releases that are used to request a pull down menu is platform specific.

Note

Disposing of a menu item that has a pull down menu will dispose of the menu. To avoid this behavior, set the menu to null before the menu item is disposed.

Parameters
menu:Menu

the new pull down menu

Exceptions
IllegalArgumentException:
  • ERROR_MENU_NOT_DROP_DOWN - if the menu is not a drop down menu
  • ERROR_MENUITEM_NOT_CASCADE - if the menu item is not a CASCADE
  • 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
setOrientationback to summary
pack-priv void setOrientation(boolean create)

Overrides org.eclipse.swt.widgets.Widget.setOrientation.

Annotations
@Override
setRadioSelectionback to summary
pack-priv boolean setRadioSelection(boolean value)
setSelectionback to summary
public void setSelection(boolean selected)

Sets the selection state of the receiver.

When the receiver is of type CHECK or RADIO, it is selected when it is checked.

Parameters
selected:boolean

the new selection state

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setTextback to summary
public void setText(String string)

Overrides org.eclipse.swt.widgets.Item.setText.

Sets the receiver's text. The string may include the mnemonic character and accelerator text.

Mnemonics are indicated by an '&' that causes the next character to be the mnemonic. When the user presses a key sequence that matches the mnemonic, a selection event occurs. On most platforms, the mnemonic appears underlined but may be emphasised in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.

Accelerator text is indicated by the '\t' character. On platforms that support accelerator text, the text that follows the '\t' character is displayed to the user, typically indicating the key stroke that will cause the item to become selected. On most platforms, the accelerator text appears right aligned in the menu. Setting the accelerator text does not install the accelerator key sequence. The accelerator key sequence is installed using #setAccelerator.

Parameters
string:String

the new text

Annotations
@Override
Exceptions
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
See Also
setAccelerator
setToolTipTextback to summary
public void setToolTipText(String toolTip)

Sets the receiver's tool tip text to the argument, which may be null indicating that the default tool tip for the control will be shown. For a menu item that has a default tool tip, setting the tool tip text to an empty string replaces the default, causing no tool tip text to be shown.

The mnemonic indicator (character '&') is not displayed in a tool tip. To display a single '&' in the tool tip, the character '&' can be escaped by doubling it in the string.

Note

Tooltips are currently not shown for top-level menu items in the shell menubar on Windows, Mac, and Ubuntu Unity desktop.

Note

This operation is a hint and behavior is platform specific, on Windows for CJK-style mnemonics of the form " (&C)" at the end of the tooltip text are not shown in tooltip.

Parameters
toolTip:String

the new tool tip text (or null)

Exceptions
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.104
updateAcceleratorback to summary
pack-priv void updateAccelerator(long accelGroup, boolean add)
updateAcceleratorTextback to summary
pack-priv boolean updateAcceleratorText(boolean show)
org.eclipse.swt.widgets back to summary

private Class MenuItem.MaskKeysym

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv int
keysym

pack-priv int
mask

Constructor Summary

AccessConstructor and Description
private
MaskKeysym()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keysymback to summary
pack-priv int keysym
maskback to summary
pack-priv int mask

Constructor Detail

MaskKeysymback to summary
private MaskKeysym()