Eclipse Platform
2.0

org.eclipse.ui.texteditor
Class ShiftAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.texteditor.ResourceAction
              |
              +--org.eclipse.ui.texteditor.TextEditorAction
                    |
                    +--org.eclipse.ui.texteditor.ShiftAction
All Implemented Interfaces:
IAction, IReadOnlyDependent, IUpdate

public final class ShiftAction
extends TextEditorAction
implements IReadOnlyDependent

Action for shifting code to the right or left by one indentation level.

Since:
2.0

Field Summary
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
ShiftAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode)
          Creates and initializes the action for the given text editor and operation code.
 
Method Summary
 boolean isEnabled(boolean isWritable)
          Returns whether the actions would be enabled if its target would be enabled given the writable state described by isWritable.
 void run()
          The TextOperationAction implementation of this IAction method runs the operation with the current operation code.
 void setEditor(ITextEditor editor)
          Retargets this action to the given editor.
 void update()
          Always enables this action if it is connected to a text editor.
 
Methods inherited from class org.eclipse.ui.texteditor.TextEditorAction
getTextEditor
 
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, setHelpContextId
 
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, removeAcceleratorText, 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

ShiftAction

public ShiftAction(ResourceBundle bundle,
                   String prefix,
                   ITextEditor editor,
                   int operationCode)
Creates and initializes the action for the given text editor and operation code. The action configures its visual representation from the given resource bundle. The action works by asking the text editor at the time for its text operation target adapter (using getAdapter(ITextOperationTarget.class). The action runs that operation with the given opcode.

Parameters:
bundle - the resource bundle
prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none
editor - the text editor
operationCode - the operation code
See Also:
ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String)
Method Detail

run

public void run()
The TextOperationAction implementation of this IAction method runs the operation with the current operation code.

Specified by:
run in interface IAction
Overrides:
run in class Action

update

public void update()
Description copied from class: TextEditorAction
Always enables this action if it is connected to a text editor. If the asocciated editor is null, the action is disabled. Subclasses may override.

Specified by:
update in interface IUpdate
Overrides:
update in class TextEditorAction

setEditor

public void setEditor(ITextEditor editor)
Description copied from class: TextEditorAction
Retargets this action to the given editor.

Overrides:
setEditor in class TextEditorAction
Parameters:
editor - the new editor, or null if none

isEnabled

public boolean isEnabled(boolean isWritable)
Description copied from interface: IReadOnlyDependent
Returns whether the actions would be enabled if its target would be enabled given the writable state described by isWritable. isEnabled() and isEnabled(boolean) holds the following invariants: isEnabled() == false, iff isEnabled(true) == false || isEnabled(false) == false isEnabled() == true, iff isEnabled(true) == true || isEnabled(false) == true

Specified by:
isEnabled in interface IReadOnlyDependent
Parameters:
isWritable -
Returns:
the hypothetical enable state of the action

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.