org.eclipse.xtext.ui.editor.embedded
Class TextViewerDeleteLineAction

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.action.AbstractAction
          extended by org.eclipse.jface.action.Action
              extended by org.eclipse.ui.texteditor.ResourceAction
                  extended by org.eclipse.xtext.ui.editor.embedded.TextViewerAction
                      extended by org.eclipse.xtext.ui.editor.embedded.TextViewerDeleteLineAction
All Implemented Interfaces:
org.eclipse.jface.action.IAction, org.eclipse.ui.texteditor.IUpdate

public class TextViewerDeleteLineAction
extends TextViewerAction

Since:
2.3
Author:
Sebastian Zarnekow - Initial contribution and API

Field Summary
static int TO_BEGINNING
          Delete to the beginning of line.
static int TO_END
          Delete to the end of line.
static int WHOLE
          Delete the whole line.
 
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
TextViewerDeleteLineAction(org.eclipse.jface.text.ITextViewer viewer, int type, boolean copyToClipboard)
          Creates a line deletion action.
TextViewerDeleteLineAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer, int type)
          Creates a line deletion action.
TextViewerDeleteLineAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer, int type, boolean copyToClipboard)
          Creates a line deletion action.
 
Method Summary
 void run()
           
 void update()
          Always enables this action if it is connected to a text editor.
 
Methods inherited from class org.eclipse.xtext.ui.editor.embedded.TextViewerAction
canModifyViewer, getSelection, getTextViewer, setViewer
 
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
 

Field Detail

WHOLE

public static final int WHOLE
Delete the whole line.

See Also:
Constant Field Values

TO_BEGINNING

public static final int TO_BEGINNING
Delete to the beginning of line.

See Also:
Constant Field Values

TO_END

public static final int TO_END
Delete to the end of line.

See Also:
Constant Field Values
Constructor Detail

TextViewerDeleteLineAction

public TextViewerDeleteLineAction(java.util.ResourceBundle bundle,
                                  java.lang.String prefix,
                                  org.eclipse.jface.text.ITextViewer viewer,
                                  int type)
Creates a line deletion action.

Parameters:
bundle - the resource bundle for UI strings
prefix - the prefix for the property keys into bundle
viewer - the viewer
type - the line deletion type, must be one of WHOLE_LINE, TO_BEGINNING or TO_END

TextViewerDeleteLineAction

public TextViewerDeleteLineAction(java.util.ResourceBundle bundle,
                                  java.lang.String prefix,
                                  org.eclipse.jface.text.ITextViewer viewer,
                                  int type,
                                  boolean copyToClipboard)
Creates a line deletion action.

Parameters:
bundle - the resource bundle for UI strings
prefix - the prefix for the property keys into bundle
viewer - the viewer
type - the line deletion type, must be one of WHOLE_LINE, TO_BEGINNING or TO_END
copyToClipboard - if true, the contents of the deleted line are copied to the clipboard
Since:
2.1

TextViewerDeleteLineAction

public TextViewerDeleteLineAction(org.eclipse.jface.text.ITextViewer viewer,
                                  int type,
                                  boolean copyToClipboard)
Creates a line deletion action.

Parameters:
viewer - the viewer
type - the line deletion type, must be one of WHOLE_LINE, TO_BEGINNING or TO_END
copyToClipboard - if true, the contents of the deleted line are copied to the clipboard
Since:
3.5
Method Detail

run

public void run()
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