org.eclipse.swt.widgets
Class MenuItem

java.lang.Object
  |
  +--org.eclipse.swt.widgets.Widget
        |
        +--org.eclipse.swt.widgets.Item
              |
              +--org.eclipse.swt.widgets.MenuItem

public class MenuItem

extends Item

Safe:

Field Summary

(package private) int	accelerator
(package private) int	id
(package private) Menu	menu
(package private) Menu	parent

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

image, text

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

CANVAS, COMCTL32_MAJOR, COMCTL32_MINOR, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, DISPOSED, eventTable, HIDDEN, keys, MAJOR, MINOR, Mnemonic, state, style, values

Constructor Summary

	MenuItem(Menu parent, int style) Enabled: Constructs a new instance of this class given its parent (which must be a Menu) and a style value describing its behavior and appearance.
	MenuItem(Menu parent, int style, int index) Enabled: 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.
(package private)	MenuItem(Menu parent, Menu menu, int style, int index)

Method Summary

void	addArmListener(ArmListener listener) Enabled: 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.
void	addHelpListener(HelpListener listener) Enabled: 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.
void	addSelectionListener(SelectionListener listener) Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener interface.
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
(package private) void	fillAccel(org.eclipse.swt.internal.win32.ACCEL accel)
int	getAccelerator() Enabled: Return the widget accelerator.
Display	getDisplay() Suppressed:
boolean	getEnabled() Enabled: Returns true if the receiver is enabled, and false otherwise.
Menu	getMenu() Enabled: Returns the receiver's cascade menu if it has one or null if it does not.
(package private) String	getNameText()
Menu	getParent() Suppressed: Returns the receiver's parent, which must be a Menu.
boolean	getSelection() Enabled: Returns true if the receiver is selected, and false otherwise.
boolean	isEnabled() Enabled: Returns true if the receiver is enabled and all of the receiver's ancestors are enabled, and false otherwise.
(package private) void	releaseChild()
(package private) void	releaseMenu()
(package private) void	releaseWidget()
void	removeArmListener(ArmListener listener) Enabled: Removes the listener from the collection of listeners who will be notified when the arm events are generated for the control.
void	removeHelpListener(HelpListener listener) Enabled: Removes the listener from the collection of listeners who will be notified when the help events are generated for the control.
void	removeSelectionListener(SelectionListener listener) Enabled: Removes the listener from the collection of listeners who will be notified when the control is selected.
(package private) void	selectRadio()
void	setAccelerator(int accelerator) Enabled: Sets the widget accelerator.
void	setEnabled(boolean enabled) Enabled: Enables the receiver if the argument is true, and disables it otherwise.
void	setImage(Image image) Enabled: Sets the image the receiver will display to the argument.
void	setMenu(Menu menu) Enabled: Sets the receiver's pull down menu to the argument.
(package private) boolean	setRadioSelection(boolean value)
void	setSelection(boolean selected) Enabled: Sets the selection state of the receiver.
void	setText(String string) Enabled: Sets the receiver's text.
(package private) int	widgetStyle()
(package private) org.eclipse.swt.internal.win32.LRESULT	wmCommandChild(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmDrawChild(int wParam, int lParam)
(package private) org.eclipse.swt.internal.win32.LRESULT	wmMeasureChild(int wParam, int lParam)

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

getImage, getText

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

addDisposeListener, addListener, checkBits, checkOrientation, checkParent, checkWidget, destroyWidget, dispose, error, filters, getData, getData, getName, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mbcsToWcs, mbcsToWcs, notifyListeners, postEvent, postEvent, releaseHandle, releaseResources, removeDisposeListener, removeListener, removeListener, sendEvent, sendEvent, sendEvent, sendEvent, setData, setData, setInputState, setKeyState, toString, wcsToMbcs, wcsToMbcs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parent

Menu parent

menu

Menu menu

id

int id

accelerator

int accelerator

Constructor Detail

MenuItem

public MenuItem(Menu parent,
                int style)

Enabled: 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 - a menu control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

See Also:

SWT.CHECK, SWT.CASCADE, SWT.PUSH, SWT.RADIO, SWT.SEPARATOR, Widget.checkSubclass(), Widget.getStyle()

MenuItem

public MenuItem(Menu parent,
                int style,
                int index)

Enabled: 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 - a menu control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

index - the index to store the receiver in its parent

See Also:

SWT.CHECK, SWT.CASCADE, SWT.PUSH, SWT.RADIO, SWT.SEPARATOR, Widget.checkSubclass(), Widget.getStyle()

MenuItem

MenuItem(Menu parent,
         Menu menu,
         int style,
         int index)

Method Detail

addArmListener

public void addArmListener(ArmListener listener)

Enabled: 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 - the listener which should be notified

See Also:

ArmListener, removeArmListener(org.eclipse.swt.events.ArmListener)

addHelpListener

public void addHelpListener(HelpListener listener)

Enabled: 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 - the listener which should be notified

See Also:

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

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Enabled: Adds the listener to the collection of listeners who will be notified when the control is selected, 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.

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

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 Item

checkStyle

static int checkStyle(int style)

fillAccel

void fillAccel(org.eclipse.swt.internal.win32.ACCEL accel)

getAccelerator

public int getAccelerator()

Enabled: Return 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.

Returns:

the accelerator

getDisplay

public Display getDisplay()

Suppressed:

Specified by:

getDisplay in class Widget

Returns:

the receiver's display

getEnabled

public boolean getEnabled()

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

Returns:

the receiver's enabled state

See Also:

isEnabled()

getMenu

public Menu getMenu()

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

the receiver's menu

getNameText

String getNameText()

Overrides:

getNameText in class Item

getParent

public Menu getParent()

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

Returns:

the receiver's parent

getSelection

public boolean getSelection()

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

the selection state

isEnabled

public boolean isEnabled()

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

Returns:

the receiver's enabled state

See Also:

getEnabled()

releaseChild

void releaseChild()

Overrides:

releaseChild in class Widget

releaseMenu

void releaseMenu()

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Item

removeArmListener

public void removeArmListener(ArmListener listener)

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

Parameters:

listener - the listener which should be notified

See Also:

ArmListener, addArmListener(org.eclipse.swt.events.ArmListener)

removeHelpListener

public void removeHelpListener(HelpListener listener)

Enabled: 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 be notified

See Also:

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

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

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

Parameters:

listener - the listener which should be notified

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

selectRadio

void selectRadio()

setAccelerator

public void setAccelerator(int accelerator)

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

Parameters:

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

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

enabled - the new enabled state

setImage

public void setImage(Image image)

Enabled: Sets the image the receiver will display to the argument.

Note: This feature is not available on all window systems (for example, Window NT), in which case, calling this method will silently do nothing.

Overrides:

setImage in class Item

Parameters:

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

setMenu

public void setMenu(Menu menu)

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

Parameters:

menu - the new pull down menu

setRadioSelection

boolean setRadioSelection(boolean value)

setSelection

public void setSelection(boolean selected)

Enabled: 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 - the new selection state

setText

public void setText(String string)

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

Overrides:

setText in class Item

Parameters:

string - the new text

See Also:

setAccelerator(int)

widgetStyle

int widgetStyle()

wmCommandChild

org.eclipse.swt.internal.win32.LRESULT wmCommandChild(int wParam,
                                                      int lParam)

wmDrawChild

org.eclipse.swt.internal.win32.LRESULT wmDrawChild(int wParam,
                                                   int lParam)

wmMeasureChild

org.eclipse.swt.internal.win32.LRESULT wmMeasureChild(int wParam,
                                                      int lParam)