org.eclipse.xtext.ui.editor.embedded

Class TextViewerShiftAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.ui.texteditor.ResourceAction

org.eclipse.xtext.ui.editor.embedded.TextViewerAction

org.eclipse.xtext.ui.editor.embedded.TextViewerShiftAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction, org.eclipse.ui.texteditor.IReadOnlyDependent, org.eclipse.ui.texteditor.IUpdate

public class TextViewerShiftAction
extends TextViewerAction
implements org.eclipse.ui.texteditor.IReadOnlyDependent

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

Since:

2.3

Author:

Sebastian Zarnekow - Initial contribution and API

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

Constructors

Constructor and Description
TextViewerShiftAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer, int operationCode) Creates and initializes the action for the given text viewer and operation code.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isEnabled(boolean isWritable)
void	run() The TextOperationAction implementation of this IAction method runs the operation with the current operation code.
void	setViewer(org.eclipse.jface.text.ITextViewer viewer) Retargets this action to the given editor.
void	update() Always enables this action if it is connected to a text editor.
protected void	updateForTab() Enablement when tab key is pressed - the current selection has to be cover multiple lines.

Methods inherited from class org.eclipse.xtext.ui.editor.embedded.TextViewerAction

canModifyViewer, getSelection, getTextViewer

Methods inherited from class org.eclipse.ui.texteditor.ResourceAction

getString, initialize, setHelpContextId

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

TextViewerShiftAction

public TextViewerShiftAction(java.util.ResourceBundle bundle,
                     java.lang.String prefix,
                     org.eclipse.jface.text.ITextViewer viewer,
                     int operationCode)

Creates and initializes the action for the given text viewer and operation code. The action configures its visual representation from the given resource bundle. The action works by asking the text viewer at the time for its text operation target adapter ITextViewer.getTextOperationTarget(). 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

viewer - the text editor

operationCode - the operation code

See Also:

TextViewerAction.TextViewerAction(ResourceBundle, String, ITextViewer)

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 org.eclipse.jface.action.IAction

Overrides:

run in class org.eclipse.jface.action.Action

update

public void update()

Description copied from class: TextViewerAction

Always enables this action if it is connected to a text editor. If the associated editor is null, the action is disabled. Subclasses may override.

Specified by:

update in interface org.eclipse.ui.texteditor.IUpdate

Overrides:

update in class TextViewerAction

updateForTab

protected void updateForTab()

Enablement when tab key is pressed - the current selection has to be cover multiple lines.

Since:

3.0

setViewer

public void setViewer(org.eclipse.jface.text.ITextViewer viewer)

Description copied from class: TextViewerAction

Retargets this action to the given editor.

Overrides:

setViewer in class TextViewerAction

Parameters:

viewer - the new viewer, or null if none

isEnabled

public boolean isEnabled(boolean isWritable)

Specified by:

isEnabled in interface org.eclipse.ui.texteditor.IReadOnlyDependent