|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.swt.widgets.Widget | +--org.eclipse.swt.widgets.Menu
Instances of this class are user interface objects that contain menu items.
Note: Only one of BAR, DROP_DOWN and POP_UP may be specified.
IMPORTANT: This class is not intended to be subclassed.
Field Summary | |
int |
handle
|
Constructor Summary | |
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(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 | |
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. |
MenuItem |
getDefaultItem()
Returns the default menu item or null if none has been previously set. |
Display |
getDisplay()
Returns the Display that is associated with
the receiver. |
boolean |
getEnabled()
Returns true if the receiver is enabled, and
false otherwise. |
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 an array of MenuItem s which are the items
in the receiver. |
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. |
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. |
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. |
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. |
void |
setLocation(int x,
int y)
Sets the receiver's location to the point specified by the arguments which are relative to the display. |
void |
setVisible(boolean visible)
Marks the receiver as visible if the argument is true ,
and marks it invisible otherwise. |
Methods inherited from class org.eclipse.swt.widgets.Widget |
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public int handle
Constructor Detail |
public Menu(Control parent)
parent
- a control which will be the parent of the new instance (cannot be null)
IllegalArgumentException
- SWTException
- SWT.POP_UP
,
Widget.checkSubclass()
,
Widget.getStyle()
public Menu(Decorations parent, int style)
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.
parent
- a decorations control which will be the parent of the new instance (cannot be null)style
- the style of menu to construct
IllegalArgumentException
- SWTException
- SWT.BAR
,
SWT.DROP_DOWN
,
SWT.POP_UP
,
Widget.checkSubclass()
,
Widget.getStyle()
public Menu(Menu parentMenu)
Menu
) and sets the style
for the instance so that the instance will be a drop-down
menu on the given parent's parent.
IllegalArgumentException
- SWTException
- SWT.DROP_DOWN
,
Widget.checkSubclass()
,
Widget.getStyle()
public Menu(MenuItem parentItem)
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.
IllegalArgumentException
- SWTException
- SWT.DROP_DOWN
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
public void addHelpListener(HelpListener listener)
HelpListener
interface.
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- HelpListener
,
removeHelpListener(org.eclipse.swt.events.HelpListener)
public void addMenuListener(MenuListener listener)
MenuListener
interface.
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- MenuListener
,
removeMenuListener(org.eclipse.swt.events.MenuListener)
public MenuItem getDefaultItem()
SWTException
- public Display getDisplay()
Widget
Display
that is associated with
the receiver.
A widget's display is either provided when it is created
(for example, top level Shell
s) or is the
same as its parent's display.
getDisplay
in class Widget
public boolean getEnabled()
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.
SWTException
- isEnabled()
public MenuItem getItem(int index)
index
- the index of the item to return
IllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public MenuItem[] getItems()
MenuItem
s 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.
SWTException
- public Decorations getParent()
Decorations
.
SWTException
- public MenuItem getParentItem()
MenuItem
or null when the receiver is a
root.
SWTException
- public Menu getParentMenu()
Menu
or null when the receiver is a
root.
SWTException
- public Shell getShell()
SWTException
- getParent()
public boolean getVisible()
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.
SWTException
- public int indexOf(MenuItem item)
item
- the search item
IllegalArgumentException
- SWTException
- public boolean isEnabled()
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.
SWTException
- getEnabled()
public boolean isVisible()
true
if the receiver is visible and all
of the receiver's ancestors are visible and false
otherwise.
SWTException
- getVisible()
public void removeHelpListener(HelpListener listener)
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- HelpListener
,
addHelpListener(org.eclipse.swt.events.HelpListener)
public void removeMenuListener(MenuListener listener)
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- MenuListener
,
addMenuListener(org.eclipse.swt.events.MenuListener)
public void setDefaultItem(MenuItem item)
null
.
item
- the default menu item or null
IllegalArgumentException
- SWTException
- public void setEnabled(boolean enabled)
true
,
and disables it otherwise. A disabled control is typically
not selectable from the user interface and draws with an
inactive or "grayed" look.
enabled
- the new enabled state
SWTException
- public void setLocation(int x, int y)
Note: This is different from most widgets where the location of the widget is relative to the parent.
x
- the new x coordinate for the receivery
- the new y coordinate for the receiver
SWTException
- public void setVisible(boolean visible)
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.
visible
- the new visibility state
SWTException
-
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |