org.gvsig.gui.beans.editabletextcomponent

Class EditableTextDecorator

java.lang.Object

org.gvsig.gui.beans.editabletextcomponent.EditableTextDecorator

All Implemented Interfaces:

IEditableText

public class EditableTextDecorator
extends java.lang.Object
implements IEditableText

Extra functionality that allows a JTextComponent having graphical edition options, which allows user to select any: COPY, CUT, PASTE, SELECT ALL, REMOVE, UNDO, REDO in a popup menu.

All options will be about the edition of the text in the component.

How select an edition option using the mouse: press the right button of the mouse on the text area, and a popup with the options will be displayed. Select and option.
Default fast-access keys:

• COPY:
CTRL + C. Copies from the text field to the clipboard.
• CUT:
CTRL + X. Cuts from the text field to the clipboad.
• PASTE:
CTRL + V. Copies from the clipboard to the text field.
• REMOVE:
SUPR (in spanish keyboard, and the equivalent in others). Removes the selected text.
• SELECT ALL:
CTRL + A. Selects all the text.
• UNDO:
CTRL + Z. Undoes.
• REDO:
SHIFT + CTRL + Z. Redoes.

This component by default stores 100 undo/redo actions. This value can be modified.

A developer would have to re-implement #defineEditorKeyListener(), creating a new editorKeyListener for changing any fast-access key.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_UNDO_REDO_LIMIT_ACTIONS
protected java.awt.event.KeyListener	editorKeyListener

Constructor Summary

Constructors

Constructor and Description
EditableTextDecorator(javax.swing.text.JTextComponent jTextComponent) Default constructor

Method Summary

Modifier and Type	Method and Description
void	addUndoRedoEditListener(UndoRedoEditListener listener) Adds a listener for notification of an undo or redo operation executed.
protected void	defineEditorKeyListener() Defines a key listener for the editor of the text component.
protected void	fireUndoRedoEditUpdate(UndoRedoEditEvent e) Notifies all listeners that have registered interest for notification on this event type.
UndoRedoEditListener[]	getUndoRedoEditListeners() Returns an array of all the UndoRedoEditListener registered on this text component.
int	getUndoRedoLimitActions() Gets the limit of actions that can hold the UndoManager.
void	removeUndoRedoEditListener(UndoRedoEditListener listener) Removes a listener for notification of an undo or redo operation executed.
void	setUndoRedoLimitActions(int limit) Sets the limit of actions that can hold the UndoManager of this component.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_UNDO_REDO_LIMIT_ACTIONS

public static final int DEFAULT_UNDO_REDO_LIMIT_ACTIONS

See Also:

Constant Field Values

editorKeyListener

protected java.awt.event.KeyListener editorKeyListener

Constructor Detail

EditableTextDecorator

public EditableTextDecorator(javax.swing.text.JTextComponent jTextComponent)

Default constructor

Method Detail

defineEditorKeyListener

protected void defineEditorKeyListener()

Defines a key listener for the editor of the text component.

setUndoRedoLimitActions

public void setUndoRedoLimitActions(int limit)

Description copied from interface: IEditableText

Sets the limit of actions that can hold the UndoManager of this component.

Specified by:

setUndoRedoLimitActions in interface IEditableText

Parameters:

limit - sets the limit of actions that can hold

getUndoRedoLimitActions

public int getUndoRedoLimitActions()

Description copied from interface: IEditableText

Gets the limit of actions that can hold the UndoManager.

Specified by:

getUndoRedoLimitActions in interface IEditableText

Returns:

int limit of actions that can hold

addUndoRedoEditListener

public void addUndoRedoEditListener(UndoRedoEditListener listener)

Description copied from interface: IEditableText

Adds a listener for notification of an undo or redo operation executed.

Specified by:

addUndoRedoEditListener in interface IEditableText

Parameters:

listener - the listener to be added

See Also:

javax.swing.event.UndoRedoEditEvent

removeUndoRedoEditListener

public void removeUndoRedoEditListener(UndoRedoEditListener listener)

Description copied from interface: IEditableText

Removes a listener for notification of an undo or redo operation executed.

Specified by:

removeUndoRedoEditListener in interface IEditableText

Parameters:

listener - the listener to be removed

See Also:

javax.swing.event.UndoRedoEditEvent

getUndoRedoEditListeners

public UndoRedoEditListener[] getUndoRedoEditListeners()

Description copied from interface: IEditableText

Returns an array of all the UndoRedoEditListener registered on this text component.

Specified by:

getUndoRedoEditListeners in interface IEditableText

Returns:

all of this component's UndoRedoEditListeners or an empty array if no listeners of that kind are currently registered

See Also:

IEditableText.addUndoRedoEditListener(org.gvsig.gui.beans.editabletextcomponent.event.UndoRedoEditListener), IEditableText.removeUndoRedoEditListener(org.gvsig.gui.beans.editabletextcomponent.event.UndoRedoEditListener)

fireUndoRedoEditUpdate

protected void fireUndoRedoEditUpdate(UndoRedoEditEvent e)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method. The listener list is processed in a last-to-first manner.

Parameters:

e - the event

See Also:

EventListenerList