com.simsilica.lemur.text

Class DocumentModelFilter

java.lang.Object

com.simsilica.lemur.text.DocumentModelFilter

All Implemented Interfaces:

VersionedObject<DocumentModel>, DocumentModel

public class DocumentModelFilter
extends java.lang.Object
implements DocumentModel

A convenient base class for DocumentModel filtering that simply passes most methods through to the wrapped delegate DocumentModel, while intercepting others for subclasses to filter. Subclasses can override the filterInput() and filterOutput() methods to provide simpler filtering or simply set Function implementations for those transforms. Advanced output filtering (where the output string maybe a different size then what is kept by the delegate) would require more extensive overriding of behavior to track carat location, line, column, and so on.

Constructor Summary

Constructors

Constructor and Description
DocumentModelFilter()
DocumentModelFilter(DocumentModel delegate)
DocumentModelFilter(DocumentModel delegate, com.google.common.base.Function<java.lang.Character,java.lang.Character> inputTransform, com.google.common.base.Function<java.lang.String,java.lang.String> outputTransform)
DocumentModelFilter(com.google.common.base.Function<java.lang.Character,java.lang.Character> inputTransform, com.google.common.base.Function<java.lang.String,java.lang.String> outputTransform)

Method Summary

Modifier and Type	Method and Description
void	backspace() Deletes the character immediately before the current carat position.
DocumentModel	clone() Deep clones this document model.
VersionedReference<java.lang.Integer>	createCaratReference() Returns a VersionedReference that can be watched for changes to the carat position.
VersionedReference<DocumentModel>	createReference() Creates a new VersionedReference that can be used to monitor when this object changes.
void	delete() Deletes the character immediately after the current carat position.
void	deleteCharAt(int pos) Deletes the character at the specified position.
int	down() Moves the carat position to the next line if there is one.
int	end(boolean currentLine) Moves the carat to the document's end position or the current line's end position depending on the specified 'currentLine' value.
protected java.lang.Character	filterInput(char c) Can be overridden to filter the input provided to insert().
protected java.lang.String	filterInput(java.lang.String text) Can be overridden to bulk filter input provided to setText().
protected java.lang.String	filterOutput(java.lang.String text) Can be overridden to filter the output from the getText() method, for example replacing all characters with '*' for a password field.
int	getAnchor() During text selection, this is one end of the selection where the other end is the carat position.
int	getAnchorColumn() Returns the column number of the current anchor position in the line returned by getAnchorLine().
int	getAnchorLine() Returns the line number containing the current anchor position.
int	getCarat() Returns the current 'carat' position.
int	getCaratColumn() Returns the column number of the current carat position in the line returned by getCaratLine().
int	getCaratLine() Returns the line number containing the current carat position.
DocumentModel	getDelegate() Returns the delegate document model for which this document model filter is filtering,
com.google.common.base.Function<java.lang.Character,java.lang.Character>	getInputTransform()
java.lang.String	getLine(int line) Passes the delegate's getLine() through the local filterOutput() method before returning.
int	getLineCount() Returns the current number of lines in this document.
DocumentModel	getObject() Returns the object that is being versioned.
com.google.common.base.Function<java.lang.String,java.lang.String>	getOutputTransform()
java.lang.String	getText() Passes the delegate's getText() through the local filterOutput() method before returning.
long	getVersion() Returns the current version of the versioned object.
int	home(boolean currentLine) Moves the carat to the document's home position or the current line's home position depending on the specified 'currentLine' value.
void	insert(char c) Inserts a character at the current carat position.
void	insert(java.lang.String text) Bulk inserts a string of text.
void	insertNewLine() Inserts a new line at the current carat position.
int	left() Moves the carat one position to the left, potentially moving it to the previous line depending on the actual DocumentModel implementation.
int	right() Moves the carat one position to the right, potentially moving it to the next line depending on the actual DocumentModel implementation.
void	setInputTransform(com.google.common.base.Function<java.lang.Character,java.lang.Character> f) Sets an optional input transform that will be used to convert all input from setText() or insert().
void	setOutputTransform(com.google.common.base.Function<java.lang.String,java.lang.String> f) Sets an optional output transform function that will convert text before returning it from getText().
void	setText(java.lang.String text) Replaces the text contained in this DocumentModel.
int	up() Moves the carat position to the previous line if there is one.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentModelFilter

public DocumentModelFilter()

DocumentModelFilter

public DocumentModelFilter(com.google.common.base.Function<java.lang.Character,java.lang.Character> inputTransform,
                           com.google.common.base.Function<java.lang.String,java.lang.String> outputTransform)

DocumentModelFilter

public DocumentModelFilter(DocumentModel delegate)

DocumentModelFilter

public DocumentModelFilter(DocumentModel delegate,
                           com.google.common.base.Function<java.lang.Character,java.lang.Character> inputTransform,
                           com.google.common.base.Function<java.lang.String,java.lang.String> outputTransform)

Method Detail

getDelegate

public DocumentModel getDelegate()

Returns the delegate document model for which this document model filter is filtering,

setOutputTransform

public void setOutputTransform(com.google.common.base.Function<java.lang.String,java.lang.String> f)

Sets an optional output transform function that will convert text before returning it from getText(). Note: with the default implementation of DocumentModelFilter, the transformed text must be a character for character replacement or the carat position will be incorrectly reported from the callers' perspective. If the supplied function is null then no output transformation is done by default.

getOutputTransform

public com.google.common.base.Function<java.lang.String,java.lang.String> getOutputTransform()

setInputTransform

public void setInputTransform(com.google.common.base.Function<java.lang.Character,java.lang.Character> f)

Sets an optional input transform that will be used to convert all input from setText() or insert(). If the function returns null for any character then that character is skipped in the input. If the supplied function is null then no input transformation is done by default.

getInputTransform

public com.google.common.base.Function<java.lang.Character,java.lang.Character> getInputTransform()

clone

public DocumentModel clone()

Description copied from interface: DocumentModel

Deep clones this document model.

Specified by:

clone in interface DocumentModel

Overrides:

clone in class java.lang.Object

filterInput

protected java.lang.String filterInput(java.lang.String text)

Can be overridden to bulk filter input provided to setText(). Default implementation returns the text directly unless there is an input transform function set. If there is an input transform function set then each character is first passed through that function to build a new string.

filterInput

protected java.lang.Character filterInput(char c)

Can be overridden to filter the input provided to insert(). The default implementation returns the character directly.

filterOutput

protected java.lang.String filterOutput(java.lang.String text)

Can be overridden to filter the output from the getText() method, for example replacing all characters with '*' for a password field. The default implementation checks for a transform function and uses it or just returns the string directly.

setText

public void setText(java.lang.String text)

Description copied from interface: DocumentModel

Replaces the text contained in this DocumentModel.

Specified by:

setText in interface DocumentModel

getText

public java.lang.String getText()

Passes the delegate's getText() through the local filterOutput() method before returning.

Specified by:

getText in interface DocumentModel

getLine

public java.lang.String getLine(int line)

Passes the delegate's getLine() through the local filterOutput() method before returning.

Specified by:

getLine in interface DocumentModel

getLineCount

public int getLineCount()

Description copied from interface: DocumentModel

Returns the current number of lines in this document.

Specified by:

getLineCount in interface DocumentModel

getCarat

public int getCarat()

Description copied from interface: DocumentModel

Returns the current 'carat' position. The 'carat' is where new text characters will be inserted. It's the current edit position.

Specified by:

getCarat in interface DocumentModel

getCaratLine

public int getCaratLine()

Description copied from interface: DocumentModel

Returns the line number containing the current carat position.

Specified by:

getCaratLine in interface DocumentModel

getCaratColumn

public int getCaratColumn()

Description copied from interface: DocumentModel

Returns the column number of the current carat position in the line returned by getCaratLine().

Specified by:

getCaratColumn in interface DocumentModel

getAnchorLine

public int getAnchorLine()

Description copied from interface: DocumentModel

Returns the line number containing the current anchor position.

Specified by:

getAnchorLine in interface DocumentModel

getAnchorColumn

public int getAnchorColumn()

Description copied from interface: DocumentModel

Returns the column number of the current anchor position in the line returned by getAnchorLine().

Specified by:

getAnchorColumn in interface DocumentModel

getAnchor

public int getAnchor()

Description copied from interface: DocumentModel

During text selection, this is one end of the selection where the other end is the carat position.

Specified by:

getAnchor in interface DocumentModel

home

public int home(boolean currentLine)

Description copied from interface: DocumentModel

Moves the carat to the document's home position or the current line's home position depending on the specified 'currentLine' value. If currentLine is true then the home position is just before the first character in the current line. If the currentLine parameter is false then the home position is just before the first character in the whole document.

Specified by:

home in interface DocumentModel

end

public int end(boolean currentLine)

Description copied from interface: DocumentModel

Moves the carat to the document's end position or the current line's end position depending on the specified 'currentLine' value. If currentLine is true then the end position is just after the last character in the current line. If the currentLine parameter is false then the end position is just after the last character in the whole document.

Specified by:

end in interface DocumentModel

up

public int up()

Description copied from interface: DocumentModel

Moves the carat position to the previous line if there is one. After this call, the new column position is implementation dependent.

Specified by:

up in interface DocumentModel

down

public int down()

Description copied from interface: DocumentModel

Moves the carat position to the next line if there is one. After this call, the new column position is implementation dependent.

Specified by:

down in interface DocumentModel

left

public int left()

Description copied from interface: DocumentModel

Moves the carat one position to the left, potentially moving it to the previous line depending on the actual DocumentModel implementation.

Specified by:

left in interface DocumentModel

right

public int right()

Description copied from interface: DocumentModel

Moves the carat one position to the right, potentially moving it to the next line depending on the actual DocumentModel implementation.

Specified by:

right in interface DocumentModel

insertNewLine

public void insertNewLine()

Description copied from interface: DocumentModel

Inserts a new line at the current carat position.

Specified by:

insertNewLine in interface DocumentModel

deleteCharAt

public void deleteCharAt(int pos)

Description copied from interface: DocumentModel

Deletes the character at the specified position.

Specified by:

deleteCharAt in interface DocumentModel

backspace

public void backspace()

Description copied from interface: DocumentModel

Deletes the character immediately before the current carat position. This may move the carat to the previous line if the carat was previously at the beginning of a line.

Specified by:

backspace in interface DocumentModel

delete

public void delete()

Description copied from interface: DocumentModel

Deletes the character immediately after the current carat position.

Specified by:

delete in interface DocumentModel

insert

public void insert(char c)

Description copied from interface: DocumentModel

Inserts a character at the current carat position.

Specified by:

insert in interface DocumentModel

insert

public void insert(java.lang.String text)

Description copied from interface: DocumentModel

Bulk inserts a string of text.

Specified by:

insert in interface DocumentModel

getVersion

public long getVersion()

Description copied from interface: VersionedObject

Returns the current version of the versioned object.

Specified by:

getVersion in interface VersionedObject<DocumentModel>

getObject

public DocumentModel getObject()

Description copied from interface: VersionedObject

Returns the object that is being versioned.

Specified by:

getObject in interface VersionedObject<DocumentModel>

createReference

public VersionedReference<DocumentModel> createReference()

Description copied from interface: VersionedObject

Creates a new VersionedReference that can be used to monitor when this object changes.

Specified by:

createReference in interface VersionedObject<DocumentModel>

createCaratReference

public VersionedReference<java.lang.Integer> createCaratReference()

Description copied from interface: DocumentModel

Returns a VersionedReference that can be watched for changes to the carat position.

Specified by:

createCaratReference in interface DocumentModel