Class ObjectPluginAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.ui.internal.PluginAction

org.eclipse.ui.internal.ObjectPluginAction

All Implemented Interfaces:

EventListener, IAction, ISelectionChangedListener, INullSelectionListener, IPartListener2, IPluginContribution, ISelectionListener

public class ObjectPluginAction
extends PluginAction
implements IPartListener2

An object action extension in a popup menu.

For backward compatibility, the delegate object can implement either IActionDelegate or IObjectActionDelegate.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATT_OVERRIDE_ACTION_ID	The configuration element attribute for the identifier of the action which this action is intended to override (i.e., replace).

Fields inherited from interface IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

Constructors

Constructor	Description
ObjectPluginAction(IConfigurationElement actionElement, String id, int style)	Constructs a new ObjectPluginAction.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes this plugin action.
String	getOverrideActionId()	Returns the action identifier this action overrides.
protected void	initDelegate()	Initialize the action delegate by calling its lifecycle method.
void	partActivated(IWorkbenchPartReference partRef)	Notifies this listener that the given part has been activated.
void	partBroughtToTop(IWorkbenchPartReference partRef)	Notifies this listener that the given part has been brought to the top.
void	partClosed(IWorkbenchPartReference partRef)	Notifies this listener that the given part has been closed.
void	partDeactivated(IWorkbenchPartReference partRef)	Notifies this listener that the given part has been deactivated.
void	partHidden(IWorkbenchPartReference partRef)	Notifies this listener that the given part is hidden or obscured by another part.
void	partInputChanged(IWorkbenchPartReference partRef)	Notifies this listener that the given part's input was changed.
void	partOpened(IWorkbenchPartReference partRef)	Notifies this listener that the given part has been opened.
void	partVisible(IWorkbenchPartReference partRef)	Notifies this listener that the given part is visible.
void	setActivePart(IWorkbenchPart targetPart)	Sets the active part for the delegate.

Methods inherited from class PluginAction

createDelegate, disposeDelegate, getConfigElement, getDelegate, getLocalId, getMenuCreator, getPluginId, getSelection, isOkToCreateDelegate, refreshEnablement, run, runWithEvent, selectionChanged, selectionChanged, selectionChanged, validateDelegate

Methods inherited from class Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class Object

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

Field Details

ATT_OVERRIDE_ACTION_ID

public static final String ATT_OVERRIDE_ACTION_ID

The configuration element attribute for the identifier of the action which this action is intended to override (i.e., replace).

See Also:

• Constant Field Values

Constructor Details

ObjectPluginAction

public ObjectPluginAction(IConfigurationElement actionElement,
 String id,
 int style)

Constructs a new ObjectPluginAction.

Parameters:

actionElement - The configuration element used to construct this action; must not be null.

id - The identifier for this action; must not be null.

style - The style bits

Method Details

partActivated

public void partActivated(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part has been activated.

Specified by:

partActivated in interface IPartListener2

Parameters:

partRef - the part that was activated

See Also:

• IWorkbenchPage.activate(IWorkbenchPart)

partBroughtToTop

public void partBroughtToTop(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part has been brought to the top.

These events occur when an editor is brought to the top in the editor area, or when a view is brought to the top in a page book with multiple views. They are normally only sent when a part is brought to the top programmatically (via IPerspective.bringToTop). When a part is activated by the user clicking on it, only partActivated is sent.

Specified by:

partBroughtToTop in interface IPartListener2

Parameters:

partRef - the part that was surfaced

See Also:

• IWorkbenchPage.bringToTop(IWorkbenchPart)

partClosed

public void partClosed(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part has been closed.

Note that if other perspectives in the same page share the view, this notification is not sent. It is only sent when the view is being removed from the page entirely (it is being disposed).

Specified by:

partClosed in interface IPartListener2

Parameters:

partRef - the part that was closed

See Also:

• IWorkbenchPage.hideView(IViewPart)

partDeactivated

public void partDeactivated(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part has been deactivated.

Specified by:

partDeactivated in interface IPartListener2

Parameters:

partRef - the part that was deactivated

See Also:

• IWorkbenchPage.activate(IWorkbenchPart)

partHidden

public void partHidden(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part is hidden or obscured by another part.

Specified by:

partHidden in interface IPartListener2

Parameters:

partRef - the part that is hidden or obscured by another part

partInputChanged

public void partInputChanged(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part's input was changed.

Specified by:

partInputChanged in interface IPartListener2

Parameters:

partRef - the part whose input was changed

partOpened

public void partOpened(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part has been opened.

Note that if other perspectives in the same page share the view, this notification is not sent. It is only sent when the view is being newly opened in the page (it is being created).

Specified by:

partOpened in interface IPartListener2

Parameters:

partRef - the part that was opened

See Also:

• IWorkbenchPage.showView(String)

partVisible

public void partVisible(IWorkbenchPartReference partRef)

Description copied from interface: IPartListener2

Notifies this listener that the given part is visible.

Specified by:

partVisible in interface IPartListener2

Parameters:

partRef - the part that is visible

initDelegate

protected void initDelegate()

Description copied from class: PluginAction

Initialize the action delegate by calling its lifecycle method. Subclasses may override but must call this implementation first.

Overrides:

initDelegate in class PluginAction

setActivePart

public void setActivePart(IWorkbenchPart targetPart)

Sets the active part for the delegate.

This method will be called every time the action appears in a popup menu. The targetPart may change with each invocation.

Parameters:

targetPart - the new part target

getOverrideActionId

public String getOverrideActionId()

Returns the action identifier this action overrides.

Overrides:

getOverrideActionId in class PluginAction

Returns:

the action identifier to override or null

dispose

public void dispose()

Description copied from class: PluginAction

Disposes this plugin action.

Overrides:

dispose in class PluginAction