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

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.TextViewerJoinLinesAction

All Implemented Interfaces:

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

public class TextViewerJoinLinesAction
extends TextViewerAction

Action for joining two or more lines together by deleting the line delimiters and trimming the whitespace between them.

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

TextViewerJoinLinesAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer, java.lang.String joint)
Creates a line joining action.

Method Summary

protected void	adjustHighlightRange(org.eclipse.jface.text.ITextViewer viewer, int offset, int length) Adjusts the highlight range so that at least the specified range is highlighted.
protected boolean	isVisible(org.eclipse.jface.text.ITextViewer viewer, int offset, int length)
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

Constructor Detail

TextViewerJoinLinesAction

public TextViewerJoinLinesAction(java.util.ResourceBundle bundle,
                                 java.lang.String prefix,
                                 org.eclipse.jface.text.ITextViewer viewer,
                                 java.lang.String joint)

Creates a line joining action.

Parameters:

bundle - the resource bundle for UI strings

prefix - the prefix for the property keys into bundle

viewer - the viewer

joint - the string to put between the lines

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

adjustHighlightRange

protected void adjustHighlightRange(org.eclipse.jface.text.ITextViewer viewer,
                                    int offset,
                                    int length)

Adjusts the highlight range so that at least the specified range is highlighted.

Subclasses may re-implement this method.

Parameters:

viewer -

offset - the offset of the range which at least should be highlighted

length - the length of the range which at least should be highlighted

isVisible

protected boolean isVisible(org.eclipse.jface.text.ITextViewer viewer,
                            int offset,
                            int length)

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