com.ontimize.gui.field.html.utils

Class TextEditPopupManager

java.lang.Object

com.ontimize.gui.field.html.utils.TextEditPopupManager

public class TextEditPopupManager
extends Object

Manages an application-wide popup menu for JTextComponents. Any JTextComponent registered with the manager will have a right-click invokable popup menu, which provides options to undo, redo, cut, copy, paste, and select-all. The popup manager is a singleton and must be retrieved with the getInstance() method:

 
 JTextField textField = new JTextField(20);
 TextEditPopupManager.getInstance().registerJTextComponent(textField);
 
 

Author:

Bob Tantlinger TODO Internationalize, add mnemonics, etc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextEditPopupManager.CaretHandler
protected class	TextEditPopupManager.NSelectAllAction
protected class	TextEditPopupManager.PopupFocusHandler
protected class	TextEditPopupManager.PopupHandler
protected class	TextEditPopupManager.RedoAction
protected class	TextEditPopupManager.UndoAction
protected class	TextEditPopupManager.UndoListener

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap	actions
protected CaretListener	caretHandler
protected Action	copy
static String	COPY
protected Action	cut
static String	CUT
protected JTextComponent	focusedComp
protected FocusListener	focusHandler
protected Action	paste
static String	PASTE
protected JPopupMenu	popup
protected MouseListener	popupHandler
protected Action	redo
static String	REDO
static String	SELECT_ALL
protected Action	selectAll
protected List	textComps
protected Action	undo
static String	UNDO
protected UndoManager	undoer
protected List	undoers
protected TextEditPopupManager.UndoListener	undoHandler

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearEmptyReferences() Clears any JTextComponent references from the manager that have been garbage collected.
Action	getAction(String name)
protected int	getIndexOfJTextComponent(JTextComponent tc) Gets the index of a registered JTextComponent
static TextEditPopupManager	getInstance() Gets the singleton instance of TextEditPopupManager
void	registerJTextComponent(JTextComponent tc) Registers a JTextComponent with the manager.
void	registerJTextComponent(JTextComponent tc, UndoManager um) Registers a JTextComponent and UndoManager with the manager.
void	unregisterJTextComponent(JTextComponent tc) Unregisters a JTextComponent from the manager.
protected void	updateActions() Updates the enabled state of the actions

Methods inherited from class java.lang.Object

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

Field Detail

CUT

public static final String CUT

See Also:

Constant Field Values

COPY

public static final String COPY

See Also:

Constant Field Values

PASTE

public static final String PASTE

See Also:

Constant Field Values

SELECT_ALL

public static final String SELECT_ALL

See Also:

Constant Field Values

UNDO

public static final String UNDO

See Also:

Constant Field Values

REDO

public static final String REDO

See Also:

Constant Field Values

actions

protected HashMap actions

cut

protected Action cut

copy

protected Action copy

paste

protected Action paste

selectAll

protected Action selectAll

undo

protected Action undo

redo

protected Action redo

textComps

protected List textComps

undoers

protected List undoers

focusedComp

protected JTextComponent focusedComp

undoer

protected UndoManager undoer

focusHandler

protected FocusListener focusHandler

popupHandler

protected MouseListener popupHandler

undoHandler

protected TextEditPopupManager.UndoListener undoHandler

caretHandler

protected CaretListener caretHandler

popup

protected JPopupMenu popup

Method Detail

getInstance

public static TextEditPopupManager getInstance()

Gets the singleton instance of TextEditPopupManager

Returns:

The one and only TextEditPopupManager

getAction

public Action getAction(String name)

registerJTextComponent

public void registerJTextComponent(JTextComponent tc)
                            throws IllegalArgumentException

Registers a JTextComponent with the manager. Note that if you change the document of the JTextComponent, you should unregister it with method unregisterJTextComponent, and then re-register it with this method. e.g...

 
 TextEditPopupManager.getInstance().registerJTextComponent(comp);
 ...
 ...
 TextEditPopupManager.getInstance().unregisterJTextComponent(comp);
 comp.setDocument(new PlainDocument());
 TextEditPopupManager.getInstance().registerJTextComponent(comp);
 
 

Parameters:

tc - The JTextComponent to register

Throws:

IllegalArgumentException - If the component is null, or already registered

registerJTextComponent

public void registerJTextComponent(JTextComponent tc,
                          UndoManager um)
                            throws IllegalArgumentException

Registers a JTextComponent and UndoManager with the manager. This is useful if you wish to supply a custom UndoManager

Parameters:

tc - The JTextComponent to register

um - The UndoManger to register

Throws:

IllegalArgumentException - If the component is null, or already registered

unregisterJTextComponent

public void unregisterJTextComponent(JTextComponent tc)

Unregisters a JTextComponent from the manager.

Parameters:

tc - The JTextComponent to unregister

getIndexOfJTextComponent

protected int getIndexOfJTextComponent(JTextComponent tc)

Gets the index of a registered JTextComponent

Parameters:

tc -

Returns:

clearEmptyReferences

protected void clearEmptyReferences()

Clears any JTextComponent references from the manager that have been garbage collected.

updateActions

protected void updateActions()

Updates the enabled state of the actions