Package org.eclipse.ui.menus
Class CommandContributionItem
java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.ui.menus.CommandContributionItem
- All Implemented Interfaces:
IContributionItem
A contribution item which delegates to a command. It can be used in
AbstractContributionFactory.createContributionItems(IServiceLocator, IContributionRoot)
.
It currently supports placement in menus and toolbars.
This class may be instantiated; it is not intended to be subclassed.
- Since:
- 3.3
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic int
Mode bit: Show text on tool items or buttons, even if an image is present.static final int
A checked tool item or menu item.static final int
A ToolBar pulldown item.static final int
A push button tool item or menu item.static final int
A radio-button style menu item. -
Constructor Summary
ConstructorDescriptionCommandContributionItem
(CommandContributionItemParameter contributionParameters) Create a CommandContributionItem to place in a ContributionManager.CommandContributionItem
(IServiceLocator serviceLocator, String id, String commandId, Map parameters, ImageDescriptor icon, ImageDescriptor disabledIcon, ImageDescriptor hoverIcon, String label, String mnemonic, String tooltip, int style) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
dispose()
The default implementation of thisIContributionItem
method does nothing.void
The default implementation of thisIContributionItem
method does nothing.void
The default implementation of thisIContributionItem
method does nothing.void
The default implementation of thisIContributionItem
method does nothing.Returns the ParameterizedCommand for this contribution.getData()
Provide info on the rendering data contained in this item.boolean
The default implementation of thisIContributionItem
method returnstrue
.boolean
The default implementation of thisIContributionItem
method returns the value recorded in an internal state variable, which istrue
by default.void
setParent
(IContributionManager parent) Sets the parent manager of this itemvoid
update()
The default implementation of thisIContributionItem
method does nothing.void
TheContributionItem
implementation of this method declared onIContributionItem
does nothing.Methods inherited from class org.eclipse.jface.action.ContributionItem
fill, getId, getParent, isDirty, isDynamic, isGroupMarker, isSeparator, saveWidgetState, setId, setVisible, toString
-
Field Details
-
STYLE_PUSH
public static final int STYLE_PUSHA push button tool item or menu item.- See Also:
-
STYLE_CHECK
public static final int STYLE_CHECKA checked tool item or menu item.- See Also:
-
STYLE_RADIO
public static final int STYLE_RADIOA radio-button style menu item.- See Also:
-
STYLE_PULLDOWN
public static final int STYLE_PULLDOWNA ToolBar pulldown item.- See Also:
-
MODE_FORCE_TEXT
public static int MODE_FORCE_TEXTMode bit: Show text on tool items or buttons, even if an image is present. If this mode bit is not set, text is only shown on tool items if there is no image present.- Since:
- 3.4
-
-
Constructor Details
-
CommandContributionItem
@Deprecated public CommandContributionItem(IServiceLocator serviceLocator, String id, String commandId, Map parameters, ImageDescriptor icon, ImageDescriptor disabledIcon, ImageDescriptor hoverIcon, String label, String mnemonic, String tooltip, int style) Deprecated.create theCommandContributionItemParameter
Create a CommandContributionItem to place in a ContributionManager.- Parameters:
serviceLocator
- a service locator that is most appropriate for this contribution. Typically the localIWorkbenchWindow
orIWorkbenchPartSite
will be sufficient.id
- The id for this item. May benull
. Items without an id cannot be referenced later.commandId
- A command id for a defined command. Must not benull
.parameters
- A map of strings to strings which represent parameter names to values. The parameter names must match those in the command definition.icon
- An icon for this item. May benull
.disabledIcon
- A disabled icon for this item. May benull
.hoverIcon
- A hover icon for this item. May benull
.label
- A label for this item. May benull
.mnemonic
- A mnemonic for this item to be applied to the label. May benull
.tooltip
- A tooltip for this item. May benull
. Tooltips are currently only valid for toolbar contributions.style
- The style of this menu contribution. See the STYLE_* contants.
-
Method Details
-
getCommand
Returns the ParameterizedCommand for this contribution.NOTE: The returned object should be treated as 'read-only', do not execute this instance or attempt to modify its state.
- Returns:
- The parameterized command for this contribution.
- Since:
- 3.5
-
fill
Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
fill
in interfaceIContributionItem
- Overrides:
fill
in classContributionItem
- Parameters:
parent
- the parent menuindex
- the index where the controls are inserted, or-1
to insert at the end
-
fill
Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
fill
in interfaceIContributionItem
- Overrides:
fill
in classContributionItem
- Parameters:
parent
- the parent control
-
fill
Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
fill
in interfaceIContributionItem
- Overrides:
fill
in classContributionItem
- Parameters:
parent
- the parent tool barindex
- the index where the controls are inserted, or-1
to insert at the end
-
update
public void update()Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
update
in interfaceIContributionItem
- Overrides:
update
in classContributionItem
-
update
Description copied from class:ContributionItem
TheContributionItem
implementation of this method declared onIContributionItem
does nothing. Subclasses should override to update their state.- Specified by:
update
in interfaceIContributionItem
- Overrides:
update
in classContributionItem
- Parameters:
id
- the id of the changed property
-
setParent
Description copied from interface:IContributionItem
Sets the parent manager of this item- Specified by:
setParent
in interfaceIContributionItem
- Overrides:
setParent
in classContributionItem
- Parameters:
parent
- the parent contribution manager
-
dispose
public void dispose()Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method does nothing. Subclasses may override.- Specified by:
dispose
in interfaceIContributionItem
- Overrides:
dispose
in classContributionItem
-
isEnabled
public boolean isEnabled()Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method returnstrue
. Subclasses may override.- Specified by:
isEnabled
in interfaceIContributionItem
- Overrides:
isEnabled
in classContributionItem
- Returns:
true
if this item is enabled
-
isVisible
public boolean isVisible()Description copied from class:ContributionItem
The default implementation of thisIContributionItem
method returns the value recorded in an internal state variable, which istrue
by default.setVisible
should be used to change this setting.- Specified by:
isVisible
in interfaceIContributionItem
- Overrides:
isVisible
in classContributionItem
- Returns:
true
if this item is visible, andfalse
otherwise- Since:
- 3.4
-
getData
Provide info on the rendering data contained in this item.- Returns:
- a
CommandContributionItemParameter
. Valid fields are serviceLocator, id, style, icon, disabledIcon, hoverIcon, label, helpContextId, mnemonic, tooltip. The Object will never benull
, although any of the fields may benull
. - Since:
- 3.100
-
CommandContributionItemParameter