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

java.lang.Object
  ag.ion.bion.officelayer.internal.text.TextFieldMaster

All Implemented Interfaces:

ITextFieldMaster

public class TextFieldMaster
extends java.lang.Object
implements ITextFieldMaster

Interface for a master of a textfield.

Constructor Summary

TextFieldMaster(ITextDocument textDocument, com.sun.star.beans.XPropertySet xPropertySet)
Constructs new TextFieldMaster.

Method Summary

ITextField	constructNewTextField() Constructs new textfield on the basis of this textfield master.
java.lang.String	getContent() Returns content of the master of a textfield.
java.lang.String	getName() Returns name of the master of a textfield.
ITextField[]	getTextFields() Returns all related textfields of this textfield master.
void	remove() Removes the master of a textfield from the document.
void	setContent(java.lang.String content) Sets content of the master of a textfield.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldMaster

public TextFieldMaster(ITextDocument textDocument,
                       com.sun.star.beans.XPropertySet xPropertySet)
                throws java.lang.IllegalArgumentException

Constructs new TextFieldMaster.

Parameters:

textDocument - text document to be used

xPropertySet - OpenOffice.org XPropertySet interface to be used

Throws:

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

Method Detail

getName

public java.lang.String getName()

Returns name of the master of a textfield. Returns null if a name is not available.

Specified by:

getName in interface ITextFieldMaster

Returns:

name of the master of a textfield or null if a name is not available

getContent

public java.lang.String getContent()

Returns content of the master of a textfield. Returns null if a content is not available.

Specified by:

getContent in interface ITextFieldMaster

Returns:

content of the master of a textfield or null if a content is not available

setContent

public void setContent(java.lang.String content)
                throws TextException

Sets content of the master of a textfield.

Specified by:

setContent in interface ITextFieldMaster

Parameters:

content - content to be used

Throws:

TextException - if the new content can not be set

getTextFields

public ITextField[] getTextFields()
                           throws TextException

Returns all related textfields of this textfield master.

Specified by:

getTextFields in interface ITextFieldMaster

Returns:

all related textfields of this textfield master

Throws:

TextException - if the textfields can not be fetched

constructNewTextField

public ITextField constructNewTextField()
                                 throws NOAException

Constructs new textfield on the basis of this textfield master.

Specified by:

constructNewTextField in interface ITextFieldMaster

Returns:

new constructed textfield on the basis of this textfield master

Throws:

NOAException - if the new textfield can not be constructed

remove

public void remove()

Removes the master of a textfield from the document.

Specified by:

remove in interface ITextFieldMaster