net.sf.cuf.state.ui

Class SwingDocumentState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.ui.AbstractSwingState

net.sf.cuf.state.ui.SwingDocumentState

All Implemented Interfaces:

EventListener, DocumentListener, State

public class SwingDocumentState
extends AbstractSwingState
implements State, DocumentListener

The SwingDocumentState class models a State with the Document of a Swing JTextField or JTextComponent as the state source. The value of the state is determined by comparing the Document's string with a user-defined string. If the string matches the document, the state is true. To avoid a "broadcast storm" of firing SwingDocumentState's, a SwingDocumentState can be switched to "silent", in that case it ignores all changes.

Field Summary

Fields inherited from class net.sf.cuf.state.ui.AbstractSwingState

mSilent

Fields inherited from class net.sf.cuf.state.AbstractState

mIsEnabled, mIsInitialized, mListenerList, mName, mReason

Constructor Summary

Constructors

Constructor and Description
SwingDocumentState(JTextComponent pTextField) Creates a new state, using the handed text field as its state source.
SwingDocumentState(JTextComponent pTextField, String pContent) Creates a new state, using the handed text field as its state source.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedUpdate(DocumentEvent pEvent) Gives notification that an attribute or set of attributes changed.
protected boolean	getInternalState() Check the document state.
void	insertUpdate(DocumentEvent pEvent) Gives notification that there was an insert into the document.
void	removeUpdate(DocumentEvent pEvent) Gives notification that a portion of the document has been removed.
void	setCompareContent(String pContent) Sets the string we compare the document against.
protected void	setReason() Set the source of the state as the reason for a change.
void	updateCompareFromDocument() Updates the compare content from the current value of the document.

Methods inherited from class net.sf.cuf.state.ui.AbstractSwingState

checkStateChange, isSilent, setSilent

Methods inherited from class net.sf.cuf.state.AbstractState

addChangeListener, checkDisposed, dispose, fireStateChanged, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.state.State

addChangeListener, dispose, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName

Constructor Detail

SwingDocumentState

public SwingDocumentState(JTextComponent pTextField)

Creates a new state, using the handed text field as its state source. If the content of the text field matches "" (= it is empty), then the state is true.

Parameters:

pTextField - text field we take the document from

SwingDocumentState

public SwingDocumentState(JTextComponent pTextField,
                  String pContent)

Creates a new state, using the handed text field as its state source. If the content of the text field matches pContent, then the state is true

Parameters:

pTextField - text field we take the document from

pContent - string to compare to

Method Detail

setCompareContent

public void setCompareContent(String pContent)

Sets the string we compare the document against.

Parameters:

pContent - string we compare our document to, must not be null

updateCompareFromDocument

public void updateCompareFromDocument()

Updates the compare content from the current value of the document.

getInternalState

protected boolean getInternalState()

Check the document state.

Specified by:

getInternalState in class AbstractSwingState

Returns:

true of our compare content matches the Document

setReason

protected void setReason()

Set the source of the state as the reason for a change.

Specified by:

setReason in class AbstractSwingState

insertUpdate

public void insertUpdate(DocumentEvent pEvent)

Gives notification that there was an insert into the document. The range given by the DocumentEvent bounds the freshly inserted region.

Specified by:

insertUpdate in interface DocumentListener

Parameters:

pEvent - the document event

removeUpdate

public void removeUpdate(DocumentEvent pEvent)

Gives notification that a portion of the document has been removed. The range is given in terms of what the view last saw (that is, before updating sticky positions).

Specified by:

removeUpdate in interface DocumentListener

Parameters:

pEvent - the document event

changedUpdate

public void changedUpdate(DocumentEvent pEvent)

Gives notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface DocumentListener

Parameters:

pEvent - the document event