com.ibm.rcp.ui.shelf
Class ToggleShelfAction

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.action.AbstractAction
          org.eclipse.jface.action.Action
              com.ibm.rcp.ui.shelf.ToggleShelfAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction

public class ToggleShelfAction

extends org.eclipse.jface.action.Action

Action used to change the mode of the shelf: closed, thin, open.

Since:

Lotus Expeditor V6.1

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

ToggleShelfAction(ShelfPage page, java.lang.String name, int mode)
Creates an instance of this Action given the shelf page, the name of the action, and the mode to switch to.

Method Summary

int	getStyle()
void	run() Sets the mode of the sidebar to be the mode specified in the constructor of this action.

Methods inherited from class org.eclipse.jface.action.Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, 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

ToggleShelfAction

public ToggleShelfAction(ShelfPage page,
                         java.lang.String name,
                         int mode)

Creates an instance of this Action given the shelf page, the name of the action, and the mode to switch to. The mode is based on the constants specified by ShelfPage: ShelfPage.COLLAPSED, ShelfPage.THIN, and ShelfPage.EXPANDED.

Parameters:

page -

name -

mode -

Method Detail

run

public void run()

Sets the mode of the sidebar to be the mode specified in the constructor of this action.

getStyle

public int getStyle()