public class CommandContributionItem extends ContributionItem
AbstractContributionFactory.createContributionItems(IServiceLocator,
IContributionRoot)
.
It currently supports placement in menus and toolbars.
This class may be instantiated; it is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
static int |
MODE_FORCE_TEXT
Mode bit: Show text on tool items or buttons, even if an image is
present.
|
static int |
STYLE_CHECK
A checked tool item or menu item.
|
static int |
STYLE_PULLDOWN
A ToolBar pulldown item.
|
static int |
STYLE_PUSH
A push button tool item or menu item.
|
static int |
STYLE_RADIO
A radio-button style menu item.
|
Constructor and Description |
---|
CommandContributionItem(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.
create the
CommandContributionItemParameter |
Modifier and Type | Method and Description |
---|---|
void |
dispose()
The default implementation of this
IContributionItem
method does nothing. |
void |
fill(Composite parent)
The default implementation of this
IContributionItem
method does nothing. |
void |
fill(Menu parent,
int index)
The default implementation of this
IContributionItem
method does nothing. |
void |
fill(ToolBar parent,
int index)
The default implementation of this
IContributionItem
method does nothing. |
ParameterizedCommand |
getCommand()
Returns the ParameterizedCommand for this contribution.
|
CommandContributionItemParameter |
getData()
Provide info on the rendering data contained in this item.
|
boolean |
isEnabled()
The default implementation of this
IContributionItem
method returns true . |
boolean |
isVisible()
The default implementation of this
IContributionItem
method returns the value recorded in an internal state variable,
which is true by default. |
void |
setParent(IContributionManager parent)
Sets the parent manager of this item
|
void |
update()
The default implementation of this
IContributionItem
method does nothing. |
void |
update(String id)
The
ContributionItem implementation of this
method declared on IContributionItem does nothing. |
fill, getId, getParent, isDirty, isDynamic, isGroupMarker, isSeparator, saveWidgetState, setId, setVisible, toString
public static final int STYLE_PUSH
public static final int STYLE_CHECK
public static final int STYLE_RADIO
public static final int STYLE_PULLDOWN
public static int MODE_FORCE_TEXT
public CommandContributionItem(CommandContributionItemParameter contributionParameters)
contributionParameters
- parameters necessary to render this contribution item.@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)
CommandContributionItemParameter
serviceLocator
- a service locator that is most appropriate for this contribution.
Typically the local IWorkbenchWindow
or IWorkbenchPartSite
will be sufficient.id
- The id for this item. May be null
. Items without an id
cannot be referenced later.commandId
- A command id for a defined command. Must not be null
.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 be null
.disabledIcon
- A disabled icon for this item. May be null
.hoverIcon
- A hover icon for this item. May be null
.label
- A label for this item. May be null
.mnemonic
- A mnemonic for this item to be applied to the label. May be
null
.tooltip
- A tooltip for this item. May be null
. Tooltips are
currently only valid for toolbar contributions.style
- The style of this menu contribution. See the STYLE_* contants.public ParameterizedCommand getCommand()
NOTE: The returned object should be treated as 'read-only', do not execute this instance or attempt to modify its state.
public void fill(Menu parent, int index)
ContributionItem
IContributionItem
method does nothing. Subclasses may override.fill
in interface IContributionItem
fill
in class ContributionItem
parent
- the parent menuindex
- the index where the controls are inserted,
or -1
to insert at the endpublic void fill(Composite parent)
ContributionItem
IContributionItem
method does nothing. Subclasses may override.fill
in interface IContributionItem
fill
in class ContributionItem
parent
- the parent controlpublic void fill(ToolBar parent, int index)
ContributionItem
IContributionItem
method does nothing. Subclasses may override.fill
in interface IContributionItem
fill
in class ContributionItem
parent
- the parent tool barindex
- the index where the controls are inserted,
or -1
to insert at the endpublic void update()
ContributionItem
IContributionItem
method does nothing. Subclasses may override.update
in interface IContributionItem
update
in class ContributionItem
public void update(String id)
ContributionItem
ContributionItem
implementation of this
method declared on IContributionItem
does nothing.
Subclasses should override to update their state.update
in interface IContributionItem
update
in class ContributionItem
id
- the id of the changed propertypublic void setParent(IContributionManager parent)
IContributionItem
setParent
in interface IContributionItem
setParent
in class ContributionItem
parent
- the parent contribution managerpublic void dispose()
ContributionItem
IContributionItem
method does nothing. Subclasses may override.dispose
in interface IContributionItem
dispose
in class ContributionItem
public boolean isEnabled()
ContributionItem
IContributionItem
method returns true
. Subclasses may override.isEnabled
in interface IContributionItem
isEnabled
in class ContributionItem
true
if this item is enabledpublic boolean isVisible()
ContributionItem
IContributionItem
method returns the value recorded in an internal state variable,
which is true
by default. setVisible
should be used to change this setting.isVisible
in interface IContributionItem
isVisible
in class ContributionItem
true
if this item is visible, and
false
otherwisepublic CommandContributionItemParameter getData()
CommandContributionItemParameter
. Valid fields are
serviceLocator, id, style, icon, disabledIcon, hoverIcon, label,
helpContextId, mnemonic, tooltip. The Object will never be
null
, although any of the fields may be
null
.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.