org.eclipse.gef.ui.palette
Class LayoutAction

java.lang.Object
  org.eclipse.jface.action.Action
      org.eclipse.gef.ui.palette.LayoutAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction, org.eclipse.jface.action.IMenuCreator

public class LayoutAction

extends org.eclipse.jface.action.Action

implements org.eclipse.jface.action.IMenuCreator

This action allows to switch between the various supported layout modes for the given palette.

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

LayoutAction(PaletteViewerPreferences prefs)
Constructor

LayoutAction(PaletteViewerPreferences prefs, boolean hasIcon)
Constructor

Method Summary

protected void	addActionToMenu(org.eclipse.swt.widgets.Menu parent, org.eclipse.jface.action.IAction action) Helper method that wraps the given action in an ActionContributionItem and then adds it to the given menu.
protected java.util.List	createActions()
void	dispose() Empty method
org.eclipse.swt.widgets.Menu	getMenu(org.eclipse.swt.widgets.Control parent)
org.eclipse.swt.widgets.Menu	getMenu(org.eclipse.swt.widgets.Menu parent)

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, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, run, 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

LayoutAction

public LayoutAction(PaletteViewerPreferences prefs)

Constructor

Parameters:

prefs - PaletteViewerPreferences object where the settings can be saved

LayoutAction

public LayoutAction(PaletteViewerPreferences prefs,
                    boolean hasIcon)

Constructor

Parameters:

hasIcon - True if this action should associate an icon with itself

prefs - PaletteViewerPreferences object where the settings can be saved

Method Detail

addActionToMenu

protected void addActionToMenu(org.eclipse.swt.widgets.Menu parent,
                               org.eclipse.jface.action.IAction action)

Helper method that wraps the given action in an ActionContributionItem and then adds it to the given menu.

Parameters:

parent - The menu to which the given action is to be added

action - The action that is to be added to the given menu

createActions

protected java.util.List createActions()

Returns:

A list of actions that can switch to one of the supported layout modes

dispose

public void dispose()

Empty method

Specified by:

dispose in interface org.eclipse.jface.action.IMenuCreator

See Also:

IMenuCreator.dispose()

getMenu

public org.eclipse.swt.widgets.Menu getMenu(org.eclipse.swt.widgets.Control parent)

Specified by:

getMenu in interface org.eclipse.jface.action.IMenuCreator

See Also:

IMenuCreator.getMenu(Control)

getMenu

public org.eclipse.swt.widgets.Menu getMenu(org.eclipse.swt.widgets.Menu parent)

Specified by:

getMenu in interface org.eclipse.jface.action.IMenuCreator

See Also:

IMenuCreator.getMenu(Menu)