Eclipse Platform
Release 3.0

org.eclipse.ui.texteditor
Class InsertLineAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended byorg.eclipse.ui.texteditor.ResourceAction
          extended byorg.eclipse.ui.texteditor.TextEditorAction
              extended byorg.eclipse.ui.texteditor.InsertLineAction
All Implemented Interfaces:
IAction, IUpdate

public class InsertLineAction
extends TextEditorAction

This action implements smart return. Instead of breaking the line where we are, we do the following:

Smart Enter

Smart Enter Inverse

Since:
3.0

Field Summary
protected  boolean fAbove
          true if this action inserts a line above the current (Smart Enter Inverse), false otherwise
 
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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
InsertLineAction(ResourceBundle bundle, String prefix, ITextEditor textEditor, boolean above)
          Creates a new smart enter action.
 
Method Summary
 void run()
          The default implementation of this IAction method does nothing.
 void update()
          Always enables this action if it is connected to a text editor.
 
Methods inherited from class org.eclipse.ui.texteditor.TextEditorAction
canModifyEditor, getTextEditor, setEditor, validateEditorInputState
 
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, 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, notifyResult, removeAcceleratorText, removeMnemonics, 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
 

Field Detail

fAbove

protected boolean fAbove
true if this action inserts a line above the current (Smart Enter Inverse), false otherwise

Constructor Detail

InsertLineAction

public InsertLineAction(ResourceBundle bundle,
                        String prefix,
                        ITextEditor textEditor,
                        boolean above)
Creates a new smart enter action.

Parameters:
bundle - the resource bundle
prefix - the prefix to use to get properties from bundle
textEditor - the editor that the action acts upon
above - whether new lines are inserted above or below the caret's line.
Method Detail

update

public void update()
Description copied from class: TextEditorAction
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 IUpdate
Overrides:
update in class TextEditorAction

run

public void run()
Description copied from class: Action
The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

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

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.