BaseKit.InsertBreakAction (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class BaseKit.InsertBreakAction

java.lang.Object
  javax.swing.AbstractAction
      javax.swing.text.TextAction
          org.netbeans.editor.BaseAction
              org.netbeans.editor.BaseKit.InsertBreakAction

All Implemented Interfaces:: ActionListener, Serializable, Cloneable, EventListener, Action

Enclosing class:: BaseKit

public static class BaseKit.InsertBreakAction
extends BaseAction
extends BaseAction

See Also:: Serialized Form

Field Summary

Fields inherited from class org.netbeans.editor.BaseAction

ABBREV_RESET, CLEAR_STATUS_TEXT, ICON_RESOURCE_PROPERTY, LOCALE_DESC_PREFIX, LOCALE_POPUP_PREFIX, MAGIC_POSITION_RESET, NO_KEYBINDING, NO_RECORDING, POPUP_MENU_TEXT, SAVE_POSITION, SELECTION_REMOVE, UNDO_MERGE_RESET, updateMask, WORD_MATCH_RESET

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

BaseKit.InsertBreakAction()


Method Summary

void actionPerformed(ActionEvent evt, JTextComponent target)
          The target method that performs the real action functionality.

protected void afterBreak(JTextComponent target, BaseDocument doc, Caret caret, Object data)
          Hook called after the enter was inserted and cursor repositioned.

protected Object beforeBreak(JTextComponent target, BaseDocument doc, Caret caret)
          Hook called before any changes to the document.

protected Class getShortDescriptionBundleClass()
          Get the class in a package where resource bundle for localization of the short description of this action resides.

Methods inherited from class org.netbeans.editor.BaseAction

actionPerformed, asynchonous, createDefaultValue, findValue, getDefaultShortDescription, getPopupMenuItem, getPopupMenuText, getValue, settingsChange, updateComponent, updateComponent

Methods inherited from class javax.swing.text.TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields inherited from class org.netbeans.editor.BaseAction
`ABBREV_RESET, CLEAR_STATUS_TEXT, ICON_RESOURCE_PROPERTY, LOCALE_DESC_PREFIX, LOCALE_POPUP_PREFIX, MAGIC_POSITION_RESET, NO_KEYBINDING, NO_RECORDING, POPUP_MENU_TEXT, SAVE_POSITION, SELECTION_REMOVE, UNDO_MERGE_RESET, updateMask, WORD_MATCH_RESET`

Fields inherited from class javax.swing.AbstractAction
`changeSupport, enabled`

Fields inherited from interface javax.swing.Action
`ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON`

Constructor Summary
`BaseKit.InsertBreakAction()`

Method Summary
`void`	`actionPerformed(ActionEvent evt, JTextComponent target)` The target method that performs the real action functionality.
`protected void`	`afterBreak(JTextComponent target, BaseDocument doc, Caret caret, Object data)` Hook called after the enter was inserted and cursor repositioned.
`protected Object`	`beforeBreak(JTextComponent target, BaseDocument doc, Caret caret)` Hook called before any changes to the document.
`protected Class`	`getShortDescriptionBundleClass()` Get the class in a package where resource bundle for localization of the short description of this action resides.

Methods inherited from class org.netbeans.editor.BaseAction
`actionPerformed, asynchonous, createDefaultValue, findValue, getDefaultShortDescription, getPopupMenuItem, getPopupMenuText, getValue, settingsChange, updateComponent, updateComponent`

Methods inherited from class javax.swing.text.TextAction
`augmentList, getFocusedComponent, getTextComponent`

Methods inherited from class javax.swing.AbstractAction
`addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, isEnabled, putValue, removePropertyChangeListener, setEnabled`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

BaseKit.InsertBreakAction

public BaseKit.InsertBreakAction()

Method Detail

actionPerformed

public void actionPerformed(ActionEvent evt,
                            JTextComponent target)

Description copied from class: BaseAction

The target method that performs the real action functionality.

Specified by:: actionPerformed in class BaseAction

Parameters:: evt - action event describing the action that occured; target - target component where the action occured. It's retrieved by the TextAction.getTextComponent(evt).

beforeBreak

protected Object beforeBreak(JTextComponent target,
                             BaseDocument doc,
                             Caret caret)

Hook called before any changes to the document. The value returned is passed intact to the other hook.

afterBreak

protected void afterBreak(JTextComponent target,
                          BaseDocument doc,
                          Caret caret,
                          Object data)

Hook called after the enter was inserted and cursor repositioned. *data* is the object returned previously by *beforeBreak* hook. By default null.

getShortDescriptionBundleClass

protected Class getShortDescriptionBundleClass()