Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Runtime
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

org.eclipse.gmf.runtime.common.ui.action.global
Class GlobalAction

java.lang.Object
  AbstractActionHandler
      
org.eclipse.gmf.runtime.common.ui.action.global.GlobalAction

Direct Known Subclasses:

GlobalBookmarkAction, GlobalCloseProjectAction, GlobalOpenProjectAction, GlobalPrintAction, GlobalRedoAction, GlobalUndoAction

---

public abstract class GlobalAction
extends AbstractActionHandler

The abstract parent of all concrete global actions. A concrete global action needs to override the getActionId() method. The concrete global action could override the createContext() and createCompoundCommand() methods.

---

Constructor Summary
GlobalAction ( IWorkbenchPage workbenchPage)           Creates a GlobalAction.
GlobalAction ( IWorkbenchPart workbenchPart)           Creates a GlobalAction.

 

Method Summary
protected   CompositeCommand	createCompositeCommand (java.util.List commands)           Returns a CompositeCommand whose undo context is derived from my workbench part.
protected   IGlobalActionContext	createContext ()           Returns a IGlobalActionContext
protected  void	doRun ( IProgressMonitor progressMonitor)
abstract  java.lang.String	getActionId ()           Returns the GlobalActionId handled by this action
protected  java.util.List	getGlobalActionHandlerData ()           Returns a list of GlobalActionHandlerData.
protected  java.util.List	getObjectContextGlobalActionHandlerData ()           Returns a list with a GlobalActionHandlerData object containing a context of Object.
protected   IUndoContext	getUndoContext ()           Gets the undo context from my workbench part.
protected  java.lang.String	getWorkbenchActionConstant ()           Returns the workbenchActionConstant.
void	init ()
void	refresh ()

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

GlobalAction

public GlobalAction(
IWorkbenchPart workbenchPart)

Creates a GlobalAction.

Parameters:

workbenchPart - The part associated with this action

---

GlobalAction

public GlobalAction(
IWorkbenchPage workbenchPage)

Creates a GlobalAction.

Parameters:

workbenchPage - The part associated with this action

Method Detail

doRun

protected void doRun(
IProgressMonitor progressMonitor)

---

refresh

public void refresh()

---

getActionId

public abstract java.lang.String getActionId()

Returns the GlobalActionId handled by this action

Returns:

int

---

createCompositeCommand

protected 
CompositeCommand createCompositeCommand(java.util.List commands)

Returns a CompositeCommand whose undo context is derived from my workbench part.

Parameters:

commands - a list of commands to compose into a CompositeCommand

Returns:

the CompositeCommand

---

getUndoContext

protected 
IUndoContext getUndoContext()

Gets the undo context from my workbench part. May be null.

Returns:

my undo context

---

createContext

protected 
IGlobalActionContext createContext()

Returns a IGlobalActionContext

Returns:

IGlobalActionContext

---

getGlobalActionHandlerData

protected java.util.List getGlobalActionHandlerData()

Returns a list of GlobalActionHandlerData. Handles different types of selections

Returns:

List

---

getWorkbenchActionConstant

protected java.lang.String getWorkbenchActionConstant()

Returns the workbenchActionConstant.

Returns:

String

---

getObjectContextGlobalActionHandlerData

protected java.util.List getObjectContextGlobalActionHandlerData()

Returns a list with a GlobalActionHandlerData object containing a context of Object. You can have getObjectContextGlobalActionHandlerData call this instead.

Returns:

List with a GlobalActionHandlerData object containing a context of Object

---

init

public void init()

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Runtime
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.