|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.actions.PartEventAction
public abstract class PartEventAction
The abstract superclass for actions that listen to part activation and
open/close events. This implementation tracks the active part (see
getActivePart) and provides a convenient place to monitor
part lifecycle events that could affect the availability of the action.
Subclasses must implement the following IAction method:
run - to do the action's work
Subclasses may extend any of the IPartListener methods if the
action availablity needs to be recalculated:
partActivatedpartDeactivatedpartOpenedpartClosedpartBroughtToTop
Although this method implements the IPartListener interface,
it does NOT register itself.
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.jface.action.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 | |
|---|---|
protected |
PartEventAction(String text)
Creates a new action with the given text. |
protected |
PartEventAction(String text,
int style)
Creates a new action with the given text and style. |
| Method Summary | |
|---|---|
IWorkbenchPart |
getActivePart()
Returns the currently active part in the workbench. |
void |
partActivated(IWorkbenchPart part)
The PartEventAction implementation of this
IPartListener method records that the given part is active. |
void |
partBroughtToTop(IWorkbenchPart part)
The PartEventAction implementation of this
IPartListener method does nothing. |
void |
partClosed(IWorkbenchPart part)
The PartEventAction implementation of this
IPartListener method clears the active part if it just closed. |
void |
partDeactivated(IWorkbenchPart part)
The PartEventAction implementation of this
IPartListener method records that there is no active part. |
void |
partOpened(IWorkbenchPart part)
The PartEventAction implementation of this
IPartListener method does nothing. |
| Methods inherited from class org.eclipse.jface.action.AbstractAction |
|---|
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.action.IAction |
|---|
addPropertyChangeListener, removePropertyChangeListener |
| Constructor Detail |
|---|
protected PartEventAction(String text)
text - the action's text, or null if there is no text
protected PartEventAction(String text,
int style)
text - the action's text, or null if there is no textstyle - one of AS_PUSH_BUTTON, AS_CHECK_BOX,
AS_DROP_DOWN_MENU, AS_RADIO_BUTTON, and
AS_UNSPECIFIED| Method Detail |
|---|
public IWorkbenchPart getActivePart()
null if nonepublic void partActivated(IWorkbenchPart part)
PartEventAction implementation of this
IPartListener method records that the given part is active.
Subclasses may extend this method if action availability has to be
recalculated.
partActivated in interface IPartListenerpart - the part that was activatedIWorkbenchPage.activate(org.eclipse.ui.IWorkbenchPart)public void partBroughtToTop(IWorkbenchPart part)
PartEventAction implementation of this
IPartListener method does nothing. Subclasses should extend
this method if action availability has to be recalculated.
partBroughtToTop in interface IPartListenerpart - the part that was surfacedIWorkbenchPage.bringToTop(org.eclipse.ui.IWorkbenchPart)public void partClosed(IWorkbenchPart part)
PartEventAction implementation of this
IPartListener method clears the active part if it just closed.
Subclasses may extend this method if action availability has to be
recalculated.
partClosed in interface IPartListenerpart - the part that was closedIWorkbenchPage.hideView(IViewPart)public void partDeactivated(IWorkbenchPart part)
PartEventAction implementation of this
IPartListener method records that there is no active part.
Subclasses may extend this method if action availability has to be
recalculated.
partDeactivated in interface IPartListenerpart - the part that was deactivatedIWorkbenchPage.activate(IWorkbenchPart)public void partOpened(IWorkbenchPart part)
PartEventAction implementation of this
IPartListener method does nothing. Subclasses should extend
this method if action availability has to be recalculated.
partOpened in interface IPartListenerpart - the part that was openedIWorkbenchPage.showView(String)
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.