Class CommandContributionItem

    • Field Detail

      • STYLE_PUSH

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

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

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

        public static final int STYLE_PULLDOWN
        A ToolBar pulldown item.
        See Also:
        Constant Field Values
      • 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 Detail

      • CommandContributionItem

        public CommandContributionItem​(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​(IServiceLocator serviceLocator,
                                       String id,
                                       String commandId,
                                       Map parameters,
                                       ImageDescriptor icon,
                                       ImageDescriptor disabledIcon,
                                       ImageDescriptor hoverIcon,
                                       String label,
                                       String mnemonic,
                                       String tooltip,
                                       int style)
        Deprecated.
        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_* contants.
    • Method Detail

      • getCommand

        public 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​(Menu parent,
                         int index)
        Description copied from class: ContributionItem
        The default implementation of this IContributionItem method does nothing. Subclasses may override.
        Specified by:
        fill in interface IContributionItem
        Overrides:
        fill in class ContributionItem
        Parameters:
        parent - the parent menu
        index - the index where the controls are inserted, or -1 to insert at the end
      • fill

        public void fill​(Composite parent)
        Description copied from class: ContributionItem
        The default implementation of this IContributionItem method does nothing. Subclasses may override.
        Specified by:
        fill in interface IContributionItem
        Overrides:
        fill in class ContributionItem
        Parameters:
        parent - the parent control
      • fill

        public void fill​(ToolBar parent,
                         int index)
        Description copied from class: ContributionItem
        The default implementation of this IContributionItem method does nothing. Subclasses may override.
        Specified by:
        fill in interface IContributionItem
        Overrides:
        fill in class ContributionItem
        Parameters:
        parent - the parent tool bar
        index - the index where the controls are inserted, or -1 to insert at the end
      • update

        public void update​(String id)
        Description copied from class: ContributionItem
        The ContributionItem implementation of this method declared on IContributionItem does nothing. Subclasses should override to update their state.
        Specified by:
        update in interface IContributionItem
        Overrides:
        update in class ContributionItem
        Parameters:
        id - the id of the changed property
      • isVisible

        public boolean isVisible()
        Description copied from class: ContributionItem
        The default implementation of this IContributionItem method returns the value recorded in an internal state variable, which is true by default. setVisible should be used to change this setting.
        Specified by:
        isVisible in interface IContributionItem
        Overrides:
        isVisible in class ContributionItem
        Returns:
        true if this item is visible, and false otherwise
        Since:
        3.4
      • getData

        public 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