Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - ToggleGridAction (Eclipse GEF API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse GEF
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gef.ui.actions
Class ToggleGridAction

java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              
org.eclipse.gef.ui.actions.ToggleGridAction

All Implemented Interfaces:: IAction

public class ToggleGridAction
extends 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
See Also:: Serialized Form

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

ToggleGridAction ( GraphicalViewer diagramViewer)
          Constructor

Method Summary

boolean isChecked ()


void run ()


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, 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 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

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()