uk.ac.kcl.cch.jb.pliny.actions
Class DisplayReferrerAction

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.action.AbstractAction
          org.eclipse.jface.action.Action
              uk.ac.kcl.cch.jb.pliny.actions.DisplayReferrerAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction

public class DisplayReferrerAction

extends org.eclipse.jface.action.Action

This action supports the "see referrer" button that appears in the toolbar associated with Pliny editors and views, and generates a drop-down list of resources that refer to the editor/view's resource.

Although this action generates a button it is a pulldown type. The main icon (which when clicked invokes the run() method actually does nothing but display a dialog box to the user telling them to click on the dropdown icon instead.

Author:

John Bradley

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

DisplayReferrerAction()
this constructor is used by Editors since its action icon must appear in the main toolbar with other editor action icons.

DisplayReferrerAction(org.eclipse.ui.IViewPart myPart)
this constructor is used by Pliny's AnnotationViewer since its action icon must appear among the view's action icons.

Method Summary

void	run() this run method is invoked when the user clicks on the icon associated with this action and displays a message telling them to click the dropdown item instead.
void	setActivePart(org.eclipse.ui.IEditorPart targetEditor) sets the active part based on the current page of the AnnotationView (which is a PageBookView).

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, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

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

DisplayReferrerAction

public DisplayReferrerAction()

this constructor is used by Editors since its action icon must appear in the main toolbar with other editor action icons.

DisplayReferrerAction

public DisplayReferrerAction(org.eclipse.ui.IViewPart myPart)

this constructor is used by Pliny's AnnotationViewer since its action icon must appear among the view's action icons.

Parameters:

myPart - IViewPart the owning part for this action.

Method Detail

setActivePart

public void setActivePart(org.eclipse.ui.IEditorPart targetEditor)

sets the active part based on the current page of the AnnotationView (which is a PageBookView).

Parameters:

targetEditor -

run

public void run()

this run method is invoked when the user clicks on the icon associated with this action and displays a message telling them to click the dropdown item instead.