org.itsnat.comp.text

Interface ItsNatTextComponent

All Superinterfaces:

ItsNatComponent, ItsNatElementComponent, ItsNatUserData

All Known Subinterfaces:

ItsNatFormattedTextField, ItsNatHTMLInputFile, ItsNatHTMLInputHidden, ItsNatHTMLInputPassword, ItsNatHTMLInputText, ItsNatHTMLInputTextBased, ItsNatHTMLInputTextFormatted, ItsNatHTMLTextArea, ItsNatPasswordField, ItsNatTextArea, ItsNatTextField

public interface ItsNatTextComponent
extends ItsNatElementComponent

Is the base interface of text based components.

A text based component manages a single piece of text.

Author:

Jose Maria Arranz Santamaria

Method Summary

Methods

Modifier and Type	Method and Description
void	appendString(java.lang.String str) Appends a new string at the end.
javax.swing.text.Document	createDefaultDocument() Create a new instance of the default data model.
javax.swing.text.Document	getDocument() Returns the current data model of this component.
ItsNatTextComponentUI	getItsNatTextComponentUI() Returns the user interface manager of this component.
java.lang.String	getText() Returns the text contained in this component.
java.lang.String	getText(int offset, int length) Fetches the text contained within the given portion of the text of this component.
void	insertString(java.lang.String str, int pos) Inserts a new string at the specified position.
void	replaceString(java.lang.String str, int start, int end) Replaces a text part with a new string at the specified position.
void	setDocument(javax.swing.text.Document dataModel) Changes the data model of this component.
void	setText(java.lang.String t) Updates the text contained in this component.

Methods inherited from interface org.itsnat.comp.ItsNatElementComponent

getElement, getItsNatElementComponentUI

Methods inherited from interface org.itsnat.comp.ItsNatComponent

addEventListener, addEventListener, addEventListener, addEventListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, disableEventListener, disableEventListener, dispose, enableEventListener, enableEventListener, getArtifact, getArtifact, getItsNatComponentManager, getItsNatComponentUI, getItsNatDocument, getNode, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, isDisposed, isEnabled, registerArtifact, removeArtifact, removeEventListener, removeEventListener, removeEventListener, removeEventListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setEnabled, setEventListenerParams, setEventListenerParams, setNode

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getDocument

javax.swing.text.Document getDocument()

Returns the current data model of this component.

Returns:

the current data model

See Also:

setDocument(javax.swing.text.Document)

setDocument

void setDocument(javax.swing.text.Document dataModel)

Changes the data model of this component.

Current data model is disconnected from this component, and the new data model is bound to this component, every change is tracked and updates the user interfaces accordingly.

If the specified data model is the same instance as the current data model, then is reset, component listener is removed and added again. Use this technique if you want to add a data model listener to be executed before the default component listener.

Parameters:

dataModel - the new data model.

See Also:

getDocument()

getText

java.lang.String getText()

Returns the text contained in this component.

This method is a quick access to the data model text (see javax.swing.text.Document.getText(int,int))

Returns:

the component text.

See Also:

setText(String), getDocument()

setText

void setText(java.lang.String t)

Updates the text contained in this component.

This method is a quick access to modify the data model text (see javax.swing.text.Document.remove(int,int) and javax.swing.text.Document.insertString(int,int,AttributeSet)).

The component keeps track of data model changes the user interface is updated accordingly.

Parameters:

t - the text.

See Also:

getText(), getDocument()

getText

java.lang.String getText(int offset,
                       int length)

Fetches the text contained within the given portion of the text of this component.

This method is a direct wrapper of javax.swing.text.Document.getText(int,int).

Parameters:

offset - the offset into the document representing the desired start of the text >= 0

length - the length of the desired string >= 0

See Also:

getText(), getDocument()

appendString

void appendString(java.lang.String str)

Appends a new string at the end.

This method is a quick access to modify the data model text (see javax.swing.text.Document.insertString(int,int,AttributeSet)).

The component keeps track of data model changes the user interface is updated accordingly.

Parameters:

str - the string to add.

See Also:

getText(), getDocument(), insertString(String,int)

insertString

void insertString(java.lang.String str,
                int pos)

Inserts a new string at the specified position.

This method is a quick access to modify the data model text (see javax.swing.text.Document.insertString(int,int,AttributeSet)).

The component keeps track of data model changes the user interface is updated accordingly.

Parameters:

str - the text.

See Also:

getText(), getDocument(), appendString(String)

replaceString

void replaceString(java.lang.String str,
                 int start,
                 int end)

Replaces a text part with a new string at the specified position.

This method is a quick access to modify the data model text (see javax.swing.text.Document.insertString(int,int,AttributeSet)).

This method is a quick access to modify the data model text (see javax.swing.text.Document.remove(int,int) and javax.swing.text.Document.insertString(int,int,AttributeSet)).

Parameters:

str - the text.

See Also:

getText(), getDocument(), appendString(String)

createDefaultDocument

javax.swing.text.Document createDefaultDocument()

Create a new instance of the default data model.

Returned data model is not bound to this component.

Returns:

a new default data model instance.

See Also:

setDocument(javax.swing.text.Document)

getItsNatTextComponentUI

ItsNatTextComponentUI getItsNatTextComponentUI()

Returns the user interface manager of this component.

Returns:

the user interface manager.