ag.ion.bion.officelayer.internal.text
Class TextField

java.lang.Object
  ag.ion.bion.officelayer.text.AbstractTextComponent
      ag.ion.bion.officelayer.internal.text.TextField

All Implemented Interfaces:

ITextComponent, ITextContent, ITextField

public class TextField
extends AbstractTextComponent
implements ITextField

Text field implementation of a text document.

Field Summary

Fields inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

textDocument

Constructor Summary

TextField(ITextDocument textDocument, com.sun.star.text.XDependentTextField xDependentTextField)
Constructs new TextField.

TextField(ITextDocument textDocument, com.sun.star.text.XTextField xTextField)
Constructs new TextField.

Method Summary

void	addDisposeListener(IElementDisposedListener listener) Adds a dispose listener to the field.
java.lang.String	getDisplayText() Returns displayed text of the text field.
ITextFieldMaster	getTextFieldMaster() Returns master of the textfield.
ITextRange	getTextRange() Returns text range of the textfield.
com.sun.star.text.XTextContent	getXTextContent() Returns OpenOffice.org XTextContent interface.
void	markTextField() Marks the text field in the text.
void	remove() Removes the text field from the document.
void	removeDisposeListener(IElementDisposedListener listener) Removes the dispose listener belonging to the field (if there is any).

Methods inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

getTextDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.text.ITextComponent

getTextDocument

Constructor Detail

TextField

public TextField(ITextDocument textDocument,
                 com.sun.star.text.XDependentTextField xDependentTextField)
          throws java.lang.IllegalArgumentException

Constructs new TextField.

Parameters:

textDocument - text document to be used

xDependentTextField - OpenOffice.org XDependentTextField interface

Throws:

java.lang.IllegalArgumentException - if the submitted text document or OpenOffice.org XDependentTextField interface is not valid

TextField

public TextField(ITextDocument textDocument,
                 com.sun.star.text.XTextField xTextField)
          throws java.lang.IllegalArgumentException

Constructs new TextField.

Parameters:

textDocument - text document to be used

xTextField - OpenOffice.org XTextField interface

Throws:

java.lang.IllegalArgumentException - if the submitted text document or OpenOffice.org XTextField interface is not valid

Method Detail

getXTextContent

public com.sun.star.text.XTextContent getXTextContent()

Returns OpenOffice.org XTextContent interface.

Specified by:

getXTextContent in interface ITextContent

Returns:

OpenOffice.org XTextContent interface

getDisplayText

public java.lang.String getDisplayText()

Returns displayed text of the text field.

Specified by:

getDisplayText in interface ITextField

Returns:

display text of the text field

getTextFieldMaster

public ITextFieldMaster getTextFieldMaster()

Returns master of the textfield.

Specified by:

getTextFieldMaster in interface ITextField

Returns:

master of the textfield.

getTextRange

public ITextRange getTextRange()

Returns text range of the textfield.

Specified by:

getTextRange in interface ITextField

Returns:

text range of the textfield

remove

public void remove()

Removes the text field from the document.

Specified by:

remove in interface ITextField

addDisposeListener

public void addDisposeListener(IElementDisposedListener listener)

Adds a dispose listener to the field.

Specified by:

addDisposeListener in interface ITextField

Parameters:

listener - listene to be used

removeDisposeListener

public void removeDisposeListener(IElementDisposedListener listener)

Removes the dispose listener belonging to the field (if there is any).

Specified by:

removeDisposeListener in interface ITextField

Parameters:

listener - the dispose listener to be removed

markTextField

public void markTextField()

Marks the text field in the text.

Specified by:

markTextField in interface ITextField