|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.actions.ActionFactory
Access to standard actions provided by the workbench.
Most of the functionality of this class is provided by static methods and fields. Example usage:
MenuManager menu = ...; ActionFactory.IWorkbenchAction closeEditorAction = ActionFactory.CLOSE.create(window); menu.add(closeEditorAction);
Clients may declare other classes that provide additional application-specific action factories.
Nested Class Summary | |
static interface |
ActionFactory.IWorkbenchAction
Interface for a workbench action. |
Field Summary | |
static ActionFactory |
ABOUT
Workbench action: Displays the About dialog. |
static ActionFactory |
ACTIVATE_EDITOR
Workbench action (id "activateEditor"): Activate the most recently used editor. |
static ActionFactory |
BACK
Workbench action (id "back"): Back. |
static ActionFactory |
BACKWARD_HISTORY
Workbench action (id "backardHistory"): Backward in the navigation history. |
static ActionFactory |
CLOSE
Workbench action (id "close"): Close the active editor. |
static ActionFactory |
CLOSE_ALL
Workbench action (id "closeAll"): Close all open editors. |
static ActionFactory |
CLOSE_ALL_PERSPECTIVES
Workbench action (id "closeAllPerspectives"): Closes all perspectives. |
static ActionFactory |
CLOSE_ALL_SAVED
Workbench action (id "closeAllSaved"): Close all open editors except those with unsaved changes. |
static ActionFactory |
CLOSE_PERSPECTIVE
Workbench action (id "closePerspective"): Closes the current perspective. |
static ActionFactory |
COPY
Workbench action (id "copy"): Copy. |
static ActionFactory |
CUT
Workbench action (id "cut"): Cut. |
static ActionFactory |
DELETE
Workbench action (id "delete"): Delete. |
static ActionFactory |
EDIT_ACTION_SETS
Workbench action (id "editActionSets"): Edit the action sets. |
static ActionFactory |
EXPORT
Workbench action (id "export"): Opens the export wizard. |
static ActionFactory |
FIND
Workbench action (id "find"): Find. |
static ActionFactory |
FORWARD
Workbench action (id "forward"): Forward. |
static ActionFactory |
FORWARD_HISTORY
Workbench action (id "forwardHistory"): Forward in the navigation history. |
static ActionFactory |
GO_INTO
Workbench action (id "goInto"): Go Into. |
static ActionFactory |
HELP_CONTENTS
Workbench action (id "helpContents"): Open the help contents. |
static ActionFactory |
IMPORT
Workbench action (id "import"): Opens the import wizard. |
static ActionFactory |
INTRO
Workbench action (id "intro"): Activate the introduction extension. |
static ActionFactory |
LOCK_TOOL_BAR
Workbench action (id "lockToolBar"): Lock/unlock the workbench window tool bar. |
static ActionFactory |
MAXIMIZE
Workbench action (id "maximize"): Maximize/restore the active part. |
static ActionFactory |
MOVE
Workbench action (id "move"): Move. |
static ActionFactory |
NEW
Workbench action (id "new"): Opens the new wizard. |
static ActionFactory |
NEXT
Workbench action (id "next"): Next. |
static ActionFactory |
NEXT_EDITOR
Workbench action (id "nextEditor"): Next editor. |
static ActionFactory |
NEXT_PART
Workbench action (id "nextPart"): Next part. |
static ActionFactory |
NEXT_PERSPECTIVE
Workbench action (id "nextPerspective"): Next perspective. |
static ActionFactory |
OPEN_NEW_WINDOW
Workbench action (id "openNewWindow"): Open a new workbench window. |
static ActionFactory |
PASTE
Workbench action (id "paste"): Paste. |
static ActionFactory |
PREFERENCES
Workbench action (id "preferences"): Displays the Preferences dialog. |
static ActionFactory |
PREVIOUS
Workbench action (id "previous"): Previous. |
static ActionFactory |
PREVIOUS_EDITOR
Workbench action (id "previousEditor"): Previous editor. |
static ActionFactory |
PREVIOUS_PART
Workbench action (id "previousPart"): Previous part. |
static ActionFactory |
PREVIOUS_PERSPECTIVE
Workbench action (id "previousPerspective"): Previous perspective. |
static ActionFactory |
PRINT
Workbench action (id "print"): Print. |
static ActionFactory |
PROPERTIES
Workbench action (id "properties"): Properties. |
static ActionFactory |
QUIT
Workbench action (id "quit"): Quit (close the workbench). |
static ActionFactory |
REDO
Workbench action (id "redo"): Redo. |
static ActionFactory |
REFRESH
Workbench action (id "refresh"): Refresh. |
static ActionFactory |
RENAME
Workbench action (id "rename"): Rename. |
static ActionFactory |
RESET_PERSPECTIVE
Workbench action (id "resetPerspective"): Resets the current perspective. |
static ActionFactory |
REVERT
Workbench action (id "revert"): Revert. |
static ActionFactory |
SAVE
Workbench action (id "save"): Save the active editor. |
static ActionFactory |
SAVE_ALL
Workbench action (id "saveAll"): Save all open editors with unsaved changes. |
static ActionFactory |
SAVE_AS
Workbench action (id "saveAs"): Save As for the active editor. |
static ActionFactory |
SAVE_PERSPECTIVE
Workbench action (id "savePerspective"): Save the current perspective. |
static ActionFactory |
SELECT_ALL
Workbench action (id "selectAll"): Select All. |
static ActionFactory |
SHOW_EDITOR
Workbench action (id "showEditor"): Show/hide the editor area. |
static ActionFactory |
SHOW_OPEN_EDITORS
Workbench action (id "showOpenEditors"): Show a list of open (and recently closed) editors. |
static ActionFactory |
SHOW_PART_PANE_MENU
Workbench action (id "showPartPaneMenu"): Show the part pane menu. |
static ActionFactory |
SHOW_VIEW_MENU
Workbench action (id "showViewMenu"): Show the view menu. |
static ActionFactory |
SHOW_WORKBOOK_EDITORS
Workbench action (id "showWorkbookEditors"): Shows a list of open editors in the current or last active workbook. |
static ActionFactory |
UNDO
Workbench action (id "undo"): Undo. |
static ActionFactory |
UP
Workbench action (id "up"): Up. |
Constructor Summary | |
protected |
ActionFactory(String actionId)
Creates a new workbench action factory with the given id. |
Method Summary | |
abstract ActionFactory.IWorkbenchAction |
create(IWorkbenchWindow window)
Creates a new standard action for the given workbench window. |
String |
getId()
Returns the id of this action factory. |
static void |
linkCycleActionPair(ActionFactory.IWorkbenchAction next,
ActionFactory.IWorkbenchAction previous)
Establishes bi-direction connections between the forward and backward actions of a cycle pair. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final ActionFactory ABOUT
public static final ActionFactory ACTIVATE_EDITOR
public static final ActionFactory BACK
RetargetAction
with id "back". This action maintains
its enablement state.
public static final ActionFactory BACKWARD_HISTORY
public static final ActionFactory CLOSE
public static final ActionFactory CLOSE_ALL
public static final ActionFactory CLOSE_ALL_PERSPECTIVES
public static final ActionFactory CLOSE_ALL_SAVED
public static final ActionFactory CLOSE_PERSPECTIVE
public static final ActionFactory INTRO
public static final ActionFactory COPY
RetargetAction
with id "copy". This action maintains
its enablement state.
public static final ActionFactory CUT
RetargetAction
with id "cut". This action maintains
its enablement state.
public static final ActionFactory DELETE
RetargetAction
with id "delete". This action maintains
its enablement state.
public static final ActionFactory EDIT_ACTION_SETS
public static final ActionFactory EXPORT
public static final ActionFactory FIND
RetargetAction
with id "find". This action maintains
its enablement state.
public static final ActionFactory FORWARD
RetargetAction
with id "forward". This action
maintains its enablement state.
public static final ActionFactory FORWARD_HISTORY
public static final ActionFactory GO_INTO
RetargetAction
with id "goInto". This action maintains
its enablement state.
public static final ActionFactory IMPORT
public static final ActionFactory LOCK_TOOL_BAR
public static final ActionFactory MAXIMIZE
public static final ActionFactory MOVE
RetargetAction
with id "move". This action maintains
its enablement state.
public static final ActionFactory NEW
public static final ActionFactory NEXT
RetargetAction
with id "next". This action maintains
its enablement state.
public static final ActionFactory NEXT_EDITOR
NEXT_EDITOR
and PREVIOUS_EDITOR
form a
cycle action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory NEXT_PART
NEXT_PART
and PREVIOUS_PART
form a cycle
action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory NEXT_PERSPECTIVE
NEXT_PERSPECTIVE
and PREVIOUS_PERSPECTIVE
form a cycle action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory OPEN_NEW_WINDOW
public static final ActionFactory PASTE
RetargetAction
with id "paste". This action maintains
its enablement state.
public static final ActionFactory PREFERENCES
public static final ActionFactory PREVIOUS
RetargetAction
with id "previous". This action
maintains its enablement state.
public static final ActionFactory PREVIOUS_EDITOR
NEXT_EDITOR
and PREVIOUS_EDITOR
form a
cycle action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory PREVIOUS_PART
NEXT_PART
and PREVIOUS_PART
form a cycle
action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory PREVIOUS_PERSPECTIVE
NEXT_PERSPECTIVE
and PREVIOUS_PERSPECTIVE
form a cycle action pair. For a given window, use
ActionFactory.linkCycleActionPair
to connect the two.
public static final ActionFactory PRINT
RetargetAction
with id "print". This action maintains
its enablement state.
public static final ActionFactory PROPERTIES
RetargetAction
with id "properties". This action
maintains its enablement state.
public static final ActionFactory QUIT
public static final ActionFactory REDO
RetargetAction
with id "redo". This action maintains
its enablement state.
public static final ActionFactory REFRESH
RetargetAction
with id "refresh". This action
maintains its enablement state.
public static final ActionFactory RENAME
RetargetAction
with id "rename". This action maintains
its enablement state.
public static final ActionFactory RESET_PERSPECTIVE
public static final ActionFactory REVERT
RetargetAction
with id "revert". This action maintains
its enablement state.
public static final ActionFactory SAVE
public static final ActionFactory SAVE_ALL
public static final ActionFactory SAVE_AS
public static final ActionFactory SAVE_PERSPECTIVE
public static final ActionFactory SELECT_ALL
RetargetAction
with id "selectAll". This action
maintains its enablement state.
public static final ActionFactory SHOW_EDITOR
public static final ActionFactory SHOW_OPEN_EDITORS
public static final ActionFactory SHOW_WORKBOOK_EDITORS
public static final ActionFactory SHOW_PART_PANE_MENU
public static final ActionFactory SHOW_VIEW_MENU
public static final ActionFactory UNDO
RetargetAction
with id "undo". This action maintains
its enablement state.
public static final ActionFactory UP
RetargetAction
with id "up". This action maintains its
enablement state.
public static final ActionFactory HELP_CONTENTS
Constructor Detail |
protected ActionFactory(String actionId)
actionId
- the id of actions created by this action factoryMethod Detail |
public static void linkCycleActionPair(ActionFactory.IWorkbenchAction next, ActionFactory.IWorkbenchAction previous)
Example usage:
ActionFactory.IWorkbenchAction nextEditorAction = ActionFactory.NEXT_EDITOR.create(window); ActionFactory.IWorkbenchAction previousEditorAction = ActionFactory.PREVIOUS_EDITOR.create(window); ActionFactory.linkCycleActionPair(nextEditorAction, previousEditorAction);
next
- the action that moves forwardprevious
- the action that moves backwardpublic abstract ActionFactory.IWorkbenchAction create(IWorkbenchWindow window)
Actions automatically register listeners against the workbench window so
that they can keep their enablement state up to date. Ordinarily, the
window's references to these listeners will be dropped automatically
when the window closes. However, if the client needs to get rid of an
action while the window is still open, the client must call
dispose
to give the action an
opportunity to deregister its listeners and to perform any other
cleanup.
window
- the workbench window
public String getId()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.