Class CommandContributionItem

java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.ease.ui.scripts.keywordhandler.CommandContributionItem
All Implemented Interfaces:
org.eclipse.jface.action.IContributionItem
Direct Known Subclasses:
ScriptContributionItem

public class CommandContributionItem extends org.eclipse.jface.action.ContributionItem
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
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static 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

    Constructors
    Constructor
    Description
    CommandContributionItem(org.eclipse.ui.menus.CommandContributionItemParameter contributionParameters)
    Create a CommandContributionItem to place in a ContributionManager.
    CommandContributionItem(org.eclipse.ui.services.IServiceLocator serviceLocator, String id, String commandId, Map parameters, org.eclipse.jface.resource.ImageDescriptor icon, org.eclipse.jface.resource.ImageDescriptor disabledIcon, org.eclipse.jface.resource.ImageDescriptor hoverIcon, String label, String mnemonic, String tooltip, int style)
    Deprecated.
    create the CommandContributionItemParameter
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    void
    fill(org.eclipse.swt.widgets.Composite parent)
     
    void
    fill(org.eclipse.swt.widgets.Menu parent, int index)
     
    void
    fill(org.eclipse.swt.widgets.ToolBar parent, int index)
     
    org.eclipse.core.commands.ParameterizedCommand
    Returns the ParameterizedCommand for this contribution.
    org.eclipse.ui.menus.CommandContributionItemParameter
    Provide info on the rendering data contained in this item.
    boolean
     
    boolean
     
    void
    setIcon(org.eclipse.jface.resource.ImageDescriptor desc)
     
    void
     
    void
    setParent(org.eclipse.jface.action.IContributionManager parent)
     
    void
     
    void
     

    Methods inherited from class org.eclipse.jface.action.ContributionItem

    fill, getId, getParent, isDirty, isDynamic, isGroupMarker, isSeparator, saveWidgetState, setId, setVisible, toString

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • STYLE_PUSH

      public static final int STYLE_PUSH
      A push button tool item or menu item.
      See Also:
    • STYLE_CHECK

      public static final int STYLE_CHECK
      A checked tool item or menu item.
      See Also:
    • STYLE_RADIO

      public static final int STYLE_RADIO
      A radio-button style menu item.
      See Also:
    • STYLE_PULLDOWN

      public static final int STYLE_PULLDOWN
      A ToolBar pulldown item.
      See Also:
    • MODE_FORCE_TEXT

      public static int MODE_FORCE_TEXT
      Mode 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

      public CommandContributionItem(org.eclipse.ui.menus.CommandContributionItemParameter contributionParameters)
      Create a CommandContributionItem to place in a ContributionManager.
      Parameters:
      contributionParameters - parameters necessary to render this contribution item.
      Since:
      3.4
    • CommandContributionItem

      @Deprecated public CommandContributionItem(org.eclipse.ui.services.IServiceLocator serviceLocator, String id, String commandId, Map parameters, org.eclipse.jface.resource.ImageDescriptor icon, org.eclipse.jface.resource.ImageDescriptor disabledIcon, org.eclipse.jface.resource.ImageDescriptor hoverIcon, String label, String mnemonic, String tooltip, int style)
      Deprecated.
      create the CommandContributionItemParameter
      Create a CommandContributionItem to place in a ContributionManager.
      Parameters:
      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_* constants.
  • Method Details

    • getCommand

      public org.eclipse.core.commands.ParameterizedCommand 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

      public void fill(org.eclipse.swt.widgets.Menu parent, int index)
      Specified by:
      fill in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      fill in class org.eclipse.jface.action.ContributionItem
    • fill

      public void fill(org.eclipse.swt.widgets.Composite parent)
      Specified by:
      fill in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      fill in class org.eclipse.jface.action.ContributionItem
    • fill

      public void fill(org.eclipse.swt.widgets.ToolBar parent, int index)
      Specified by:
      fill in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      fill in class org.eclipse.jface.action.ContributionItem
    • update

      public void update()
      Specified by:
      update in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      update in class org.eclipse.jface.action.ContributionItem
    • update

      public void update(String id)
      Specified by:
      update in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      update in class org.eclipse.jface.action.ContributionItem
    • setParent

      public void setParent(org.eclipse.jface.action.IContributionManager parent)
      Specified by:
      setParent in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      setParent in class org.eclipse.jface.action.ContributionItem
    • dispose

      public void dispose()
      Specified by:
      dispose in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      dispose in class org.eclipse.jface.action.ContributionItem
    • setIcon

      public void setIcon(org.eclipse.jface.resource.ImageDescriptor desc)
    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      isEnabled in class org.eclipse.jface.action.ContributionItem
    • isVisible

      public boolean isVisible()
      Specified by:
      isVisible in interface org.eclipse.jface.action.IContributionItem
      Overrides:
      isVisible in class org.eclipse.jface.action.ContributionItem
      Since:
      3.4
    • getData

      public org.eclipse.ui.menus.CommandContributionItemParameter 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 be null, although any of the fields may be null.
      Since:
      3.100
    • setLabel

      public void setLabel(String label)