Package org.eclipse.ui.internal

Class ActionDescriptor

java.lang.Object

org.eclipse.ui.internal.ActionDescriptor

All Implemented Interfaces:

IPluginContribution

public class ActionDescriptor
extends Object
implements IPluginContribution

When 'action' tag is found in the registry, an object of this class is created. It creates the appropriate action object and captures information that is later used to add this action object into menu/tool bar. This class is reused for global (workbench) menu/tool bar, popup menu actions, as well as view's pulldown and local tool bar.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STYLE_PULLDOWN	Pulldown style constant.
static final String	STYLE_PUSH	Push style constant.
static final String	STYLE_RADIO	Radio style constant.
static final String	STYLE_TOGGLE	Toggle style constant.
static final int	T_EDITOR	Editor constant.
static final int	T_POPUP	Popup constant.
static final int	T_VIEW	View constant.
static final int	T_WORKBENCH	Workbench constant.
static final int	T_WORKBENCH_PULLDOWN	Workbench pulldown constant.

Constructor Summary

Constructors

Constructor	Description
ActionDescriptor(IConfigurationElement actionElement, int targetType)	Creates a new descriptor with the specified target.
ActionDescriptor(IConfigurationElement actionElement, int targetType, Object target)	Creates a new descriptor with the target and destination workbench part it will go into.

Method Summary

Modifier and Type	Method	Description
PluginAction	getAction()	Returns the action object held in this descriptor.
String	getId()	Returns action's id as defined in the registry.
String	getLocalId()
String	getMenuGroup()	Returns named slot (group) in the menu where this action should be added.
String	getMenuPath()	Returns menu path where this action should be added.
int	getMode()
String	getPluginId()
String	getToolbarGroupId()	Returns the named slot (group) in the tool bar where this action should be added.
String	getToolbarId()	Returns id of the tool bar where this action should be added.
String	toString()	For debugging only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

T_POPUP

public static final int T_POPUP

Popup constant. Value 0x1.

See Also:

• Constant Field Values

T_VIEW

public static final int T_VIEW

View constant. Value 0x2.

See Also:

• Constant Field Values

T_WORKBENCH

public static final int T_WORKBENCH

Workbench constant. Value 0x3.

See Also:

• Constant Field Values

T_EDITOR

public static final int T_EDITOR

Editor constant. Value 0x4.

See Also:

• Constant Field Values

T_WORKBENCH_PULLDOWN

public static final int T_WORKBENCH_PULLDOWN

Workbench pulldown constant. Value 0x5.

See Also:

• Constant Field Values

STYLE_PUSH

public static final String STYLE_PUSH

Push style constant. Value push.

See Also:

• Constant Field Values

STYLE_RADIO

public static final String STYLE_RADIO

Radio style constant. Value radio.

See Also:

• Constant Field Values

STYLE_TOGGLE

public static final String STYLE_TOGGLE

Toggle style constant. Value toggle.

See Also:

• Constant Field Values

STYLE_PULLDOWN

public static final String STYLE_PULLDOWN

Pulldown style constant. Value pulldown.

See Also:

• Constant Field Values

Constructor Details

ActionDescriptor

public ActionDescriptor(IConfigurationElement actionElement,
 int targetType)

Creates a new descriptor with the specified target.

Parameters:

actionElement - the configuration element

targetType - the type of action

ActionDescriptor

public ActionDescriptor(IConfigurationElement actionElement,
 int targetType,
 Object target)

Creates a new descriptor with the target and destination workbench part it will go into.

Parameters:

actionElement - the configuration element

targetType - the type of action

target - the target object

Method Details

getAction

public PluginAction getAction()

Returns the action object held in this descriptor.

Returns:

the action

getId

public String getId()

Returns action's id as defined in the registry.

Returns:

the id

getMenuGroup

public String getMenuGroup()

Returns named slot (group) in the menu where this action should be added.

Returns:

the menu group

getMenuPath

public String getMenuPath()

Returns menu path where this action should be added. If null, the action will not be added into the menu.

Returns:

the menubar path

getToolbarGroupId

public String getToolbarGroupId()

Returns the named slot (group) in the tool bar where this action should be added.

Returns:

the toolbar group id

getToolbarId

public String getToolbarId()

Returns id of the tool bar where this action should be added. If null, action will not be added to the tool bar.

Returns:

the toolbar id

toString

public String toString()

For debugging only.

Overrides:

toString in class Object

getLocalId

public String getLocalId()

Specified by:

getLocalId in interface IPluginContribution

Returns:

the local id of the contribution. Must not be null. This should correspond to the extension-specific identifier for a given contribution.

getPluginId

public String getPluginId()

Specified by:

getPluginId in interface IPluginContribution

Returns:

the id of the originating plugin. Can be null if this contribution did not originate from a plugin.

getMode

public int getMode()