Package org.eclipse.jface.action
Class MenuManager
java.lang.Object
org.eclipse.jface.action.ContributionManager
org.eclipse.jface.action.MenuManager
- All Implemented Interfaces:
IContributionItem
,IContributionManager
,IMenuManager
A menu manager is a contribution manager which realizes itself and its items
in a menu control; either as a menu bar, a sub-menu, or a context menu.
This class may be instantiated; it may also be subclassed.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The key under which theMenuManager
is added to the data properties of theMenu
created by the manager.protected boolean
Indicates this item is visible in its manager;true
by default. -
Constructor Summary
ConstructorDescriptionCreates a menu manager.MenuManager
(String text) Creates a menu manager with the given text.MenuManager
(String text, String id) Creates a menu manager with the given text and id.MenuManager
(String text, ImageDescriptor image, String id) Creates a menu manager with the given text, image, and id. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addMenuListener
(IMenuListener listener) Adds a menu listener to this menu.createContextMenu
(Control parent) Creates and returns an SWT context menu control for this menu, and installs all registered contributions.createMenuBar
(Decorations parent) Creates and returns an SWT menu bar control for this menu, for use in the givenDecorations
, and installs all registered contributions.createMenuBar
(Shell parent) Deprecated.void
dispose()
Disposes of this menu manager and frees all allocated SWT resources.protected void
doItemFill
(IContributionItem ci, int index) Call anIContributionItem
's fill method with the implementation's widget.void
Fills the given composite control with controls representing this contribution item.void
Fills the given cool bar with controls representing this contribution item.void
Fills the given menu with controls representing this contribution item.void
Fills the given tool bar with controls representing this contribution item.findMenuUsingPath
(String path) Finds the manager for the menu at the given path.findUsingPath
(String path) Finds the contribution item at the given path.getId()
Returns the menu id.Returns the image for this menu as an image descriptor.getMenu()
Returns the SWT menu control for this menu manager.protected Item
getMenuItem
(int index) Get an item from the implementation's widget.protected int
Get the menu item count for the implementation's widget.protected Item[]
Get all the items from the implementation's widget.Returns the text shown in the menu, potentially with a shortcut appended.TheContributionManager
implementation of this method declared onIContributionManager
returns the current overrides.Returns the parent contribution manager of this manger.boolean
Returns whether all items should be removed when the menu is about to show, but before notifying menu listeners.boolean
Returns whether this contribution item is dynamic.boolean
Returns whether this menu should be enabled or not.boolean
Returns whether this contribution item is a group marker.boolean
Returns whether this contribution item is a separator.boolean
Deprecated.this method is no longer a part of theIContributionItem
API.boolean
Returns whether this contribution item is visibile within its manager.void
TheMenuManager
implementation of thisContributionManager
method also propagates the dirty flag up the parent chain.protected boolean
Returns whether the menu control is created and not disposed.void
removeMenuListener
(IMenuListener listener) Removes the given menu listener from this menu.void
Saves any state information of the control(s) owned by this contribution item.void
setActionDefinitionId
(String definitionId) Sets the action definition id of this action.void
setImageDescriptor
(ImageDescriptor imageDescriptor) void
setMenuText
(String menuText) void
setOverrides
(IContributionManagerOverrides newOverrides) Sets the overrides for this contribution managervoid
setParent
(IContributionManager manager) Sets the parent manager of this itemvoid
setRemoveAllWhenShown
(boolean removeAll) Sets whether all items should be removed when the menu is about to show, but before notifying menu listeners.void
setVisible
(boolean visible) Sets whether this contribution item is visibile within its manager.toString()
void
update()
Updates any SWT controls cached by this contribution item with any changes which have been made to this contribution item since the last update.void
update
(boolean force) TheMenuManager
implementation of thisIContributionManager
updates this menu, but not any of its submenus.protected void
update
(boolean force, boolean recursive) Incrementally builds the menu from the contribution items.void
Updates any SWT controls cached by this contribution item with changes for the the given property.void
updateAll
(boolean force) Incrementally builds the menu from the contribution items, and does so recursively for all submenus.Methods inherited from class org.eclipse.jface.action.ContributionManager
add, add, allowItem, appendToGroup, appendToGroup, dumpStatistics, find, getItems, getSize, hasDynamicItems, indexOf, indexOf, insert, insertAfter, insertAfter, insertBefore, insertBefore, internalSetItems, isDirty, isEmpty, itemAdded, itemRemoved, prependToGroup, prependToGroup, remove, remove, removeAll, replaceItem, setDirty
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.jface.action.IContributionItem
isDirty
Methods inherited from interface org.eclipse.jface.action.IContributionManager
add, add, appendToGroup, appendToGroup, find, getItems, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, prependToGroup, prependToGroup, remove, remove, removeAll
-
Field Details
-
MANAGER_KEY
The key under which theMenuManager
is added to the data properties of theMenu
created by the manager.- Since:
- 3.12
- See Also:
-
visible
protected boolean visibleIndicates this item is visible in its manager;true
by default.- Since:
- 3.3
-
-
Constructor Details
-
MenuManager
public MenuManager()Creates a menu manager. The text and id arenull
. Typically used for creating a context menu, where it doesn't need to be referred to by id. -
MenuManager
Creates a menu manager with the given text. The id of the menu isnull
. Typically used for creating a sub-menu, where it doesn't need to be referred to by id.- Parameters:
text
- the text for the menu, ornull
if none
-
MenuManager
Creates a menu manager with the given text and id. Typically used for creating a sub-menu, where it needs to be referred to by id.- Parameters:
text
- the text for the menu, ornull
if noneid
- the menu id, ornull
if it is to have no id
-
MenuManager
Creates a menu manager with the given text, image, and id. Typically used for creating a sub-menu, where it needs to be referred to by id.- Parameters:
text
- the text for the menu, ornull
if noneimage
- the image for the menu, ornull
if noneid
- the menu id, ornull
if it is to have no id- Since:
- 3.4
-
-
Method Details
-
addMenuListener
Description copied from interface:IMenuManager
Adds a menu listener to this menu. Has no effect if an identical listener is already registered.- Specified by:
addMenuListener
in interfaceIMenuManager
- Parameters:
listener
- a menu listener
-
createContextMenu
Creates and returns an SWT context menu control for this menu, and installs all registered contributions. Does not create a new control if one already exists.Note that the menu is not expected to be dynamic.
- Parameters:
parent
- the parent control- Returns:
- the menu control
-
createMenuBar
Creates and returns an SWT menu bar control for this menu, for use in the givenDecorations
, and installs all registered contributions. Does not create a new control if one already exists.- Parameters:
parent
- the parent decorations- Returns:
- the menu control
- Since:
- 2.1
-
createMenuBar
Deprecated.usecreateMenuBar(Decorations)
instead.Creates and returns an SWT menu bar control for this menu, for use in the givenShell
, and installs all registered contributions. Does not create a new control if one already exists. This implementation simply calls thecreateMenuBar(Decorations)
method- Parameters:
parent
- the parent decorations- Returns:
- the menu control
-
dispose
public void dispose()Disposes of this menu manager and frees all allocated SWT resources. Notifies all contribution items of the dispose.- Specified by:
dispose
in interfaceIContributionItem
-
fill
Description copied from interface:IContributionItem
Fills the given composite control with controls representing this contribution item. Used byStatusLineManager
.- Specified by:
fill
in interfaceIContributionItem
- Parameters:
parent
- the parent control
-
fill
Description copied from interface:IContributionItem
Fills the given cool bar with controls representing this contribution item. Used byCoolBarManager
.- Specified by:
fill
in interfaceIContributionItem
- Parameters:
parent
- the parent cool barindex
- the index where the controls are inserted, or-1
to insert at the end
-
fill
Description copied from interface:IContributionItem
Fills the given menu with controls representing this contribution item. Used byMenuManager
.- Specified by:
fill
in interfaceIContributionItem
- Parameters:
parent
- the parent menuindex
- the index where the controls are inserted, or-1
to insert at the end
-
fill
Description copied from interface:IContributionItem
Fills the given tool bar with controls representing this contribution item. Used byToolBarManager
.- Specified by:
fill
in interfaceIContributionItem
- Parameters:
parent
- the parent tool barindex
- the index where the controls are inserted, or-1
to insert at the end
-
findMenuUsingPath
Description copied from interface:IMenuManager
Finds the manager for the menu at the given path. A path consists of contribution item ids separated by the separator character. The path separator character is'/'
.Convenience for
findUsingPath(path)
which extracts anIMenuManager
if possible.- Specified by:
findMenuUsingPath
in interfaceIMenuManager
- Parameters:
path
- the path string- Returns:
- the menu contribution item, or
null
if there is no such contribution item or if the item does not have an associated menu manager
-
findUsingPath
Description copied from interface:IMenuManager
Finds the contribution item at the given path. A path consists of contribution item ids separated by the separator character. The path separator character is'/'
.- Specified by:
findUsingPath
in interfaceIMenuManager
- Parameters:
path
- the path string- Returns:
- the contribution item, or
null
if there is no such contribution item
-
getId
Returns the menu id. The menu id is used when creating a contribution item for adding this menu as a sub menu of another.- Specified by:
getId
in interfaceIContributionItem
- Returns:
- the menu id
-
getMenu
Returns the SWT menu control for this menu manager.- Returns:
- the menu control
-
getMenuText
Returns the text shown in the menu, potentially with a shortcut appended.- Returns:
- the menu text
-
getImageDescriptor
Returns the image for this menu as an image descriptor.- Returns:
- the image, or
null
if this menu has no image - Since:
- 3.4
-
getOverrides
Description copied from class:ContributionManager
TheContributionManager
implementation of this method declared onIContributionManager
returns the current overrides. If there is no overrides it lazily creates one which overrides no item state.- Specified by:
getOverrides
in interfaceIContributionManager
- Overrides:
getOverrides
in classContributionManager
- Returns:
- the overrides for the items of this manager
-
getParent
Returns the parent contribution manager of this manger.- Returns:
- the parent contribution manager
- Since:
- 2.0
-
getRemoveAllWhenShown
public boolean getRemoveAllWhenShown()Description copied from interface:IMenuManager
Returns whether all items should be removed when the menu is about to show, but before notifying menu listeners. The default isfalse
.- Specified by:
getRemoveAllWhenShown
in interfaceIMenuManager
- Returns:
true
if all items should be removed when shown,false
if not
-
isDynamic
public boolean isDynamic()Description copied from interface:IContributionItem
Returns whether this contribution item is dynamic. A dynamic contribution item contributes items conditionally, dependent on some internal state.- Specified by:
isDynamic
in interfaceIContributionItem
- Returns:
true
if this item is dynamic, andfalse
for normal items
-
isEnabled
public boolean isEnabled()Returns whether this menu should be enabled or not. Used to enable the menu item containing this menu when it is realized as a sub-menu.The default implementation of this framework method returns
true
. Subclasses may reimplement.- Specified by:
isEnabled
in interfaceIContributionItem
- Specified by:
isEnabled
in interfaceIMenuManager
- Returns:
true
if enabled, andfalse
if disabled
-
isGroupMarker
public boolean isGroupMarker()Description copied from interface:IContributionItem
Returns whether this contribution item is a group marker. This information is used when adding items to a group.- Specified by:
isGroupMarker
in interfaceIContributionItem
- Returns:
true
if this item is a group marker, andfalse
for normal items- See Also:
-
isSeparator
public boolean isSeparator()Description copied from interface:IContributionItem
Returns whether this contribution item is a separator. This information is used to enable hiding of unnecessary separators.- Specified by:
isSeparator
in interfaceIContributionItem
- Returns:
true
if this item is a separator, andfalse
for normal items- See Also:
-
isSubstituteFor
Deprecated.this method is no longer a part of theIContributionItem
API.Check if the contribution is item is a subsitute for ourselves- Parameters:
item
- the contribution item- Returns:
true
if give item is a substitution for ourselves
-
isVisible
public boolean isVisible()Description copied from interface:IContributionItem
Returns whether this contribution item is visibile within its manager.- Specified by:
isVisible
in interfaceIContributionItem
- Returns:
true
if this item is visible, andfalse
otherwise
-
markDirty
public void markDirty()TheMenuManager
implementation of thisContributionManager
method also propagates the dirty flag up the parent chain.- Specified by:
markDirty
in interfaceIContributionManager
- Overrides:
markDirty
in classContributionManager
- Since:
- 3.1
-
removeMenuListener
Description copied from interface:IMenuManager
Removes the given menu listener from this menu. Has no effect if an identical listener is not registered.- Specified by:
removeMenuListener
in interfaceIMenuManager
- Parameters:
listener
- the menu listener
-
saveWidgetState
public void saveWidgetState()Description copied from interface:IContributionItem
Saves any state information of the control(s) owned by this contribution item. The contribution manager calls this method before disposing of the controls.- Specified by:
saveWidgetState
in interfaceIContributionItem
-
setOverrides
Sets the overrides for this contribution manager- Overrides:
setOverrides
in classContributionManager
- Parameters:
newOverrides
- the overrides for the items of this manager- Since:
- 2.0
-
setParent
Description copied from interface:IContributionItem
Sets the parent manager of this item- Specified by:
setParent
in interfaceIContributionItem
- Parameters:
manager
- the parent contribution manager
-
setRemoveAllWhenShown
public void setRemoveAllWhenShown(boolean removeAll) Description copied from interface:IMenuManager
Sets whether all items should be removed when the menu is about to show, but before notifying menu listeners.- Specified by:
setRemoveAllWhenShown
in interfaceIMenuManager
- Parameters:
removeAll
-true
if all items should be removed when shown,false
if not
-
setVisible
public void setVisible(boolean visible) Description copied from interface:IContributionItem
Sets whether this contribution item is visibile within its manager.- Specified by:
setVisible
in interfaceIContributionItem
- Parameters:
visible
-true
if this item should be visible, andfalse
otherwise
-
setActionDefinitionId
Sets the action definition id of this action. This simply allows the menu item text to include a short cut if available. It can be used to notify a user of a key combination that will open a quick menu.- Parameters:
definitionId
- the command definition id- Since:
- 3.4
-
update
public void update()Description copied from interface:IContributionItem
Updates any SWT controls cached by this contribution item with any changes which have been made to this contribution item since the last update. Called by contribution manager update methods.- Specified by:
update
in interfaceIContributionItem
-
update
public void update(boolean force) TheMenuManager
implementation of thisIContributionManager
updates this menu, but not any of its submenus.- Specified by:
update
in interfaceIContributionManager
- Parameters:
force
-true
means update even if not dirty, andfalse
for normal incremental updating- See Also:
-
getMenuItems
Get all the items from the implementation's widget.- Returns:
- the menu items
- Since:
- 3.4
-
getMenuItem
Get an item from the implementation's widget.- Parameters:
index
- of the item- Returns:
- the menu item
- Since:
- 3.4
-
getMenuItemCount
protected int getMenuItemCount()Get the menu item count for the implementation's widget.- Returns:
- the number of items
- Since:
- 3.4
-
doItemFill
Call anIContributionItem
's fill method with the implementation's widget. The default is to use theMenu
widget.
fill(Menu menu, int index)
- Parameters:
ci
- AnIContributionItem
whosefill()
method should be called.index
- The position thefill()
method should start inserting at.- Since:
- 3.4
-
update
protected void update(boolean force, boolean recursive) Incrementally builds the menu from the contribution items. This method leaves out double separators and separators in the first or last position.- Parameters:
force
-true
means update even if not dirty, andfalse
for normal incremental updatingrecursive
-true
means recursively update all submenus, andfalse
means just this menu
-
update
Description copied from interface:IContributionItem
Updates any SWT controls cached by this contribution item with changes for the the given property.- Specified by:
update
in interfaceIContributionItem
- Parameters:
property
- the id of the changed property
-
updateAll
public void updateAll(boolean force) Description copied from interface:IMenuManager
Incrementally builds the menu from the contribution items, and does so recursively for all submenus.- Specified by:
updateAll
in interfaceIMenuManager
- Parameters:
force
-true
means update even if not dirty, andfalse
for normal incremental updating
-
setMenuText
- Parameters:
menuText
- The text (label) of the menu.- Since:
- 3.10
-
setImageDescriptor
- Parameters:
imageDescriptor
- The image descriptor to set.- Since:
- 3.10
-
toString
-
createMenuBar(Decorations)
instead.