public class MenuItem extends Item
Note: Only one of the styles CHECK, CASCADE, PUSH, RADIO and SEPARATOR may be specified.
IMPORTANT: This class is not intended to be subclassed.
Constructor and Description |
---|
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. |
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. |
Modifier and Type | Method and Description |
---|---|
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. |
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. |
void |
addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will
be notified when the menu item is selected, by sending
it one of the messages defined in the
SelectionListener
interface. |
int |
getAccelerator()
Returns the widget accelerator.
|
<T> T |
getAdapter(java.lang.Class<T> adapter)
Implementation of the
Adaptable interface. |
boolean |
getEnabled()
Returns
true if the receiver is enabled, and
false otherwise. |
int |
getID()
Gets the identifier associated with the receiver.
|
Menu |
getMenu()
Returns the receiver's cascade menu if it has one or null
if it does not.
|
Menu |
getParent()
Returns the receiver's parent, which must be a
Menu . |
boolean |
getSelection()
Returns
true if the receiver is selected,
and false otherwise. |
boolean |
isEnabled()
Returns
true if the receiver is enabled and all
of the receiver's ancestors are enabled, and false
otherwise. |
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.
|
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 |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will
be notified when the control is selected.
|
void |
setAccelerator(int accelerator)
Sets the widget accelerator.
|
void |
setEnabled(boolean enabled)
Enables the receiver if the argument is
true ,
and disables it otherwise. |
void |
setID(int id)
Sets the identifier associated with the receiver to the argument.
|
void |
setImage(Image image)
Sets the image the receiver will display to the argument.
|
void |
setMenu(Menu menu)
Sets the receiver's pull down menu to the argument.
|
void |
setSelection(boolean selection)
Sets the selection state of the receiver.
|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
public MenuItem(Menu parent, int style)
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.
parent
- a menu control which will be the parent of the new instance (cannot be null)style
- the style of control to constructjava.lang.IllegalArgumentException
- SWTException
- SWT.CHECK
,
SWT.CASCADE
,
SWT.PUSH
,
SWT.RADIO
,
SWT.SEPARATOR
,
Widget.checkSubclass()
,
Widget.getStyle()
public MenuItem(Menu parent, int style, int index)
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.
parent
- a menu control which will be the parent of the new instance (cannot be null)style
- the style of control to constructindex
- the zero-relative index to store the receiver in its parentjava.lang.IllegalArgumentException
- SWTException
- SWT.CHECK
,
SWT.CASCADE
,
SWT.PUSH
,
SWT.RADIO
,
SWT.SEPARATOR
,
Widget.checkSubclass()
,
Widget.getStyle()
public Menu getParent()
Menu
.SWTException
- public void setMenu(Menu menu)
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.
menu
- the new pull down menujava.lang.IllegalArgumentException
- CASCADE
SWTException
- public Menu getMenu()
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.SWTException
- public void setID(int id)
id
- the new identifier. This must be a non-negative value. System-defined identifiers are negative values.SWTException
- public int getID()
SWTException
- public void setImage(Image image)
Note: This operation is a hint and is not supported on platforms that do not have this concept (for example, Windows NT).
setImage
in class Item
image
- the image to displaySWTException
- public void setAccelerator(int accelerator)
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.accelerator
- an integer that is the bit-wise OR of masks and a key
SWTException
- public int getAccelerator()
SWT.CONTROL | SWT.SHIFT | 'T', SWT.ALT | SWT.F2
.
The default value is zero, indicating that the menu item does
not have an accelerator.SWTException
- public void setEnabled(boolean enabled)
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.enabled
- the new enabled stateSWTException
- public boolean getEnabled()
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.SWTException
- isEnabled()
public boolean isEnabled()
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.SWTException
- getEnabled()
public boolean getSelection()
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.
SWTException
- public void setSelection(boolean selection)
When the receiver is of type CHECK
or RADIO
,
it is selected when it is checked.
selection
- the new selection stateSWTException
- public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
When widgetSelected
is called, the stateMask field of the event object is valid.
widgetDefaultSelected
is not called.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
public void addHelpListener(HelpListener listener)
HelpListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- HelpListener
,
removeHelpListener(org.eclipse.swt.events.HelpListener)
public void removeHelpListener(HelpListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- HelpListener
,
addHelpListener(org.eclipse.swt.events.HelpListener)
public void addArmListener(ArmListener listener)
ArmListener
interface.listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- SWTException
- ArmListener
,
removeArmListener(org.eclipse.swt.events.ArmListener)
public void removeArmListener(ArmListener listener)
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- SWTException
- ArmListener
,
addArmListener(org.eclipse.swt.events.ArmListener)
public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
getAdapter
in class Widget
adapter
- the lookup classnull
if
there is no adapter associated with the given class.
Copyright (c) EclipseSource and others 2002, 2017.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0