TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.core.ui.actions
Class AbstractResultAction

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.action.AbstractAction
          extended by org.eclipse.jface.action.Action
              extended by org.eclipse.tptp.platform.analysis.core.ui.actions.AbstractResultAction
All Implemented Interfaces:
org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelectionChangedListener

public abstract class AbstractResultAction
extends org.eclipse.jface.action.Action
implements org.eclipse.jface.viewers.ISelectionChangedListener


Field Summary
static java.lang.String PROP_IS_MENU_ITEM
           
static java.lang.String PROP_IS_TOOLBAR_ITEM
           
 
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
AbstractResultAction()
           
 
Method Summary
 void enableForAnalysisElement(AbstractAnalysisElement element)
          Enable or disable this action for the specified analysis element.
 void enableForAnalysisHistory(boolean enable)
          Enable or disable this action for the specified analysis hist.
 AnalysisHistory getHistory()
           
 AbstractAnalysisProvider getProvider()
           
 org.eclipse.jface.viewers.ISelection getSelection()
           
 org.eclipse.jface.viewers.TreeViewer getViewer()
          Deprecated. use getSelection()
 boolean isMenuItem()
           
 boolean isToolbarItem()
           
 void selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)
           
 void setHistory(AnalysisHistory history)
          Internal Use Only Assigns the currently selected analysis history
 void setMenuItem(boolean value)
          Internal use only Set the value of the menu item state.
 void setProvider(AbstractAnalysisProvider provider)
          Internal Use Only Assigns the selected analysis provider
 void setToolbarItem(boolean value)
          Internal use only Set the value of the toolbar item state.
 void setViewer(org.eclipse.jface.viewers.TreeViewer viewer)
          Deprecated. use getSelection to determine the viewer selection
 
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, run, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, removePropertyChangeListener
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.action.IAction
addPropertyChangeListener, removePropertyChangeListener
 

Field Detail

PROP_IS_TOOLBAR_ITEM

public static final java.lang.String PROP_IS_TOOLBAR_ITEM
See Also:
Constant Field Values

PROP_IS_MENU_ITEM

public static final java.lang.String PROP_IS_MENU_ITEM
See Also:
Constant Field Values
Constructor Detail

AbstractResultAction

public AbstractResultAction()
Method Detail

setViewer

public final void setViewer(org.eclipse.jface.viewers.TreeViewer viewer)
Deprecated. use getSelection to determine the viewer selection

Inform the action of the tree viewer that manages analysis element selections

Parameters:
viewer - The analysis results tree viewer

getViewer

public final org.eclipse.jface.viewers.TreeViewer getViewer()
Deprecated. use getSelection()

Returns:
The tree viewer of the result view

enableForAnalysisHistory

public void enableForAnalysisHistory(boolean enable)
Enable or disable this action for the specified analysis hist. This method should be over- ridden to control the enable state of custom toolbar options that depend on the state of the specified analysis history. Typically this is used to enable/diksable the action when history is active or inactive.

Parameters:
enable - true the history is inactive false if it is busy

enableForAnalysisElement

public void enableForAnalysisElement(AbstractAnalysisElement element)
Enable or disable this action for the specified analysis element. This method should be over- ridden to control the enable state of custom menu items when the context menu is invoked for an anlaysis element of the specified type.

Parameters:
element - The selected analysis element for which the context menu will be displayed

isToolbarItem

public final boolean isToolbarItem()
Returns:
true if this item will be displayed in the result view toolbar

setToolbarItem

public final void setToolbarItem(boolean value)
Internal use only Set the value of the toolbar item state. This is called during initialization and once set the value cannot be changed.

Parameters:
value - The toolbar item state

isMenuItem

public final boolean isMenuItem()
Returns:
true if this item will be displayed in the result view context menu

setMenuItem

public final void setMenuItem(boolean value)
Internal use only Set the value of the menu item state. This is called during initialization and once set the value cannot be changed.

Parameters:
value - The menu item state

getHistory

public final AnalysisHistory getHistory()
Returns:
The currently selected analysis history

setHistory

public void setHistory(AnalysisHistory history)
Internal Use Only Assigns the currently selected analysis history

Parameters:
history - The current history

getProvider

public final AbstractAnalysisProvider getProvider()
Returns:
The currently selected analysis provider

setProvider

public final void setProvider(AbstractAnalysisProvider provider)
Internal Use Only Assigns the selected analysis provider

Parameters:
provider - The selected analysis provider

selectionChanged

public void selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)
Specified by:
selectionChanged in interface org.eclipse.jface.viewers.ISelectionChangedListener

getSelection

public org.eclipse.jface.viewers.ISelection getSelection()
Returns:
The current viewer selection

TPTP 4.5.0 Platform Project
Public API Specification