Class RTextAreaEditorKit.VerticalPageAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

org.fife.ui.rtextarea.RecordableTextAction

org.fife.ui.rtextarea.RTextAreaEditorKit.VerticalPageAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Enclosing class:

RTextAreaEditorKit

public static class RTextAreaEditorKit.VerticalPageAction
extends RecordableTextAction

Scrolls up/down vertically. The select version of this action extends the selection, instead of simply moving the caret.

Version:

0.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private int	direction
private boolean	select

Fields inherited from class AbstractAction

changeSupport, enabled

Fields inherited from interface Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
VerticalPageAction(String name, int direction, boolean select)

Method Summary

Modifier and Type	Method	Description
void	actionPerformedImpl(ActionEvent e, RTextArea textArea)	The actual meat of the action.
private void	adjustScrollIfNecessary(JTextComponent text, Rectangle visible, int initialY, int index)
private int	constrainOffset(JTextComponent text, int offset)
private int	constrainY(JTextComponent textArea, int y, int vis, int screenHeight)
final String	getMacroID()	Returns the identifier for this macro.

Methods inherited from class RecordableTextAction

actionPerformed, getAccelerator, getDescription, getIcon, getMnemonic, getName, getShortDescription, isRecordable, setAccelerator, setMnemonic, setMnemonic, setName, setProperties, setRecordable, setShortDescription

Methods inherited from class TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class AbstractAction

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

Methods inherited from class Object

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

Methods inherited from interface Action

accept

Field Details

select

private boolean select

direction

private int direction

Constructor Details

VerticalPageAction

public VerticalPageAction(String name,
 int direction,
 boolean select)

Method Details

actionPerformedImpl

public void actionPerformedImpl(ActionEvent e,
 RTextArea textArea)

Description copied from class: RecordableTextAction

The actual meat of the action. If you wish to subclass this action and modify its behavior, this is the method to override.

Specified by:

actionPerformedImpl in class RecordableTextAction

Parameters:

e - The action being performed.

textArea - The text area "receiving" the action.

See Also:

• RecordableTextAction.actionPerformed(ActionEvent)

constrainY

private int constrainY(JTextComponent textArea,
 int y,
 int vis,
 int screenHeight)

constrainOffset

private int constrainOffset(JTextComponent text,
 int offset)

adjustScrollIfNecessary

private void adjustScrollIfNecessary(JTextComponent text,
 Rectangle visible,
 int initialY,
 int index)

getMacroID

public final String getMacroID()

Description copied from class: RecordableTextAction

Returns the identifier for this macro. This method makes it so that you can create an instance of the RTextAreaEditorKit.CutAction action, for example, rename it to "Remove", and it will still be recorded as a "cut" action. Subclasses should return a unique string from this method; preferably the name of the action.

If you subclass a RecordableTextAction, you should NOT override this method; if you do, the action may not be properly recorded in a macro.

Specified by:

getMacroID in class RecordableTextAction

Returns:

The internally-used macro ID.