net.sf.cuf.model.ui

Class DocumentAdapter

java.lang.Object

net.sf.cuf.model.ui.DocumentAdapter

All Implemented Interfaces:

EventListener, ChangeListener, DocumentListener

public class DocumentAdapter
extends Object
implements ChangeListener, DocumentListener

A DocumentAdapter connects the document of a Swing text widget to the value of a ValueModel. Whenever one of the models changes, the other is adjusted accordingly. A DocumentAdapter is itself not a ValueModel, but connects a ValueModel to a Document.

A null value of the ValueModel is preserved until the document changes. Note the following mapping:

• Initially the ValueModel overrides the document.
• When copying the value from ValueModel to the document, the value null is converted to an empty string, but the ValueModel is not modified.
• When the document changes to "", an empty string is set to the ValueModel instead of null.

Constructor Summary

Constructors

Constructor and Description
DocumentAdapter(ValueModel<String> pValueModel, Document pDocument) Creates a new adapter between a ValueModel and a Document.
DocumentAdapter(ValueModel<String> pValueModel, JTextComponent pTextField) Creates a new adapter between a ValueModel and the Document of a JTextComponent.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedUpdate(DocumentEvent pEvent)
JTextComponent	getTextComponent() Return the text component we are adapting.
void	insertUpdate(DocumentEvent pEvent)
void	removeUpdate(DocumentEvent pEvent)
void	stateChanged(ChangeEvent pEvent)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentAdapter

public DocumentAdapter(ValueModel<String> pValueModel,
               JTextComponent pTextField)

Creates a new adapter between a ValueModel and the Document of a JTextComponent. Whenever one of the models changes, the other is adjusted accordingly. The initial text is taken from the value model.

Parameters:

pValueModel - the value model

pTextField - text field we take the document model from

Throws:

IllegalArgumentException - if pValueModel or pTextField are null

DocumentAdapter

public DocumentAdapter(ValueModel<String> pValueModel,
               Document pDocument)

Creates a new adapter between a ValueModel and a Document. Whenever one of the models changes, the other is adjusted accordingly. The initial text is taken from the value model.

Parameters:

pValueModel - the value model

pDocument - the document model

Throws:

IllegalArgumentException - if pValueModel or pDocument are null

Method Detail

getTextComponent

public JTextComponent getTextComponent()

Return the text component we are adapting.

Returns:

the text component, may be null if we are watching a document with multiple text components

stateChanged

public void stateChanged(ChangeEvent pEvent)

Specified by:

stateChanged in interface ChangeListener

insertUpdate

public void insertUpdate(DocumentEvent pEvent)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent pEvent)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent pEvent)

Specified by:

changedUpdate in interface DocumentListener