Eclipse Platform
2.1

org.eclipse.jface.action
Class ActionContributionItem

java.lang.Object
  |
  +--org.eclipse.jface.action.ContributionItem
        |
        +--org.eclipse.jface.action.ActionContributionItem
All Implemented Interfaces:
IContributionItem

public class ActionContributionItem
extends ContributionItem

A contribution item which delegates to an action.

This class may be instantiated; it is not intended to be subclassed.


Constructor Summary
ActionContributionItem(IAction action)
          Creates a new contribution item from the given action.
 
Method Summary
 boolean equals(Object o)
          Compares this action contribution item with another object.
 void fill(Composite parent)
          The ActionContributionItem implementation of this IContributionItem method creates an SWT Button for the action using the action's style.
 void fill(Menu parent, int index)
          The ActionContributionItem implementation of this IContributionItem method creates an SWT MenuItem for the action using the action's style.
 void fill(ToolBar parent, int index)
          The ActionContributionItem implementation of this , IContributionItem method creates an SWT ToolItem for the action using the action's style.
 IAction getAction()
          Returns the action associated with this contribution item.
static boolean getUseColorIconsInToolbars()
          Returns whether color icons should be used in toolbars.
 int hashCode()
           
 boolean isDynamic()
          The action item implementation of this IContributionItem method returns true for menu items and false for everything else.
 boolean isEnabled()
          The default implementation of this IContributionItem method returns true.
protected  boolean isEnabledAllowed()
          Returns true if this item is allowed to enable, false otherwise.
static void setUseColorIconsInToolbars(boolean useColorIcons)
          Sets whether color icons should be used in toolbars.
 void update()
          The action item implementation of this IContributionItem method calls update(null).
 void update(String propertyName)
          Synchronizes the UI with the given property.
 
Methods inherited from class org.eclipse.jface.action.ContributionItem
dispose, getId, getParent, isDirty, isGroupMarker, isSeparator, isVisible, setParent, setVisible, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActionContributionItem

public ActionContributionItem(IAction action)
Creates a new contribution item from the given action. The id of the action is used as the id of the item.
Parameters:
action - the action
Method Detail

getUseColorIconsInToolbars

public static boolean getUseColorIconsInToolbars()
Returns whether color icons should be used in toolbars.
Returns:
true if color icons should be used in toolbars, false otherwise

setUseColorIconsInToolbars

public static void setUseColorIconsInToolbars(boolean useColorIcons)
Sets whether color icons should be used in toolbars.
Parameters:
useColorIcons - true if color icons should be used in toolbars, false otherwise

equals

public boolean equals(Object o)
Compares this action contribution item with another object. Two action contribution items are equal if they refer to the identical Action.
Overrides:
equals in class Object

fill

public void fill(Composite parent)
The ActionContributionItem implementation of this IContributionItem method creates an SWT Button for the action using the action's style. If the action's checked property has been set, the button is created and primed to the value of the checked property.
Overrides:
fill in class ContributionItem
Following copied from interface: org.eclipse.jface.action.IContributionItem
Parameters:
parent - the parent control

fill

public void fill(Menu parent,
                 int index)
The ActionContributionItem implementation of this IContributionItem method creates an SWT MenuItem for the action using the action's style. If the action's checked property has been set, a button is created and primed to the value of the checked property. If the action's menu creator property has been set, a cascading submenu is created.
Overrides:
fill in class ContributionItem
Following copied from interface: org.eclipse.jface.action.IContributionItem
Parameters:
parent - the parent menu
index - the index where the controls are inserted, or -1 to insert at the end

fill

public void fill(ToolBar parent,
                 int index)
The ActionContributionItem implementation of this , IContributionItem method creates an SWT ToolItem for the action using the action's style. If the action's checked property has been set, a button is created and primed to the value of the checked property. If the action's menu creator property has been set, a drop-down tool item is created.
Overrides:
fill in class ContributionItem
Following copied from interface: org.eclipse.jface.action.IContributionItem
Parameters:
parent - the parent tool bar
index - the index where the controls are inserted, or -1 to insert at the end

getAction

public IAction getAction()
Returns the action associated with this contribution item.
Returns:
the action

hashCode

public int hashCode()
Overrides:
hashCode in class Object

isEnabled

public boolean isEnabled()
Description copied from class: ContributionItem
The default implementation of this IContributionItem method returns true. Subclasses may override.
Overrides:
isEnabled in class ContributionItem
Following copied from interface: org.eclipse.jface.action.IContributionItem
Returns:
true if this item is enabled

isDynamic

public boolean isDynamic()
The action item implementation of this IContributionItem method returns true for menu items and false for everything else.
Overrides:
isDynamic in class ContributionItem
Following copied from interface: org.eclipse.jface.action.IContributionItem
Returns:
true if this item is dynamic, and false for normal items

isEnabledAllowed

protected boolean isEnabledAllowed()
Returns true if this item is allowed to enable, false otherwise.
Returns:
if this item is allowed to be enabled
Since:
2.0

update

public final void update()
The action item implementation of this IContributionItem method calls update(null).
Overrides:
update in class ContributionItem

update

public void update(String propertyName)
Synchronizes the UI with the given property.
Overrides:
update in class ContributionItem
Parameters:
propertyName - the name of the property, or null meaning all applicable properties

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.