org.eclipse.gef.ui.actions
Class ToggleGridAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended byorg.eclipse.gef.ui.actions.ToggleGridAction
All Implemented Interfaces:
org.eclipse.jface.action.IAction

public class ToggleGridAction
extends org.eclipse.jface.action.Action

An action that toggles the grid. This action keeps the visibility and enabled properties in sync, i.e., it toggles both at the same time. This action can handle the case where these properties are not set on the given viewer initially.

Since:
3.0

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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
ToggleGridAction(GraphicalViewer diagramViewer)
          Constructor
 
Method Summary
 boolean isChecked()
           
 void run()
           
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToggleGridAction

public ToggleGridAction(GraphicalViewer diagramViewer)
Constructor

Parameters:
diagramViewer - the GraphicalViewer whose grid enablement and visibility properties are to be toggled
Method Detail

isChecked

public boolean isChecked()
See Also:
IAction.isChecked()

run

public void run()
See Also:
IAction.run()