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

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

All Implemented Interfaces:

IVariableTextFieldMaster

public class VariableTextFieldMaster
extends java.lang.Object
implements IVariableTextFieldMaster

Master of a variable text field of a text document.

Constructor Summary

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

Method Summary

ITextField	constructNewVariableTextField(java.lang.String content, boolean visible) Constructs new variable text field on the basis of this variable text field master.
ITextField	constructNewVariableTextField(java.lang.String content, boolean visible, INumberFormat numberFormat, boolean isFormula) Constructs new variable text field on the basis of this variable text field master.
java.lang.String	getName() Returns name of the master of a variable text field.
ITextField[]	getVariableTextFields() Returns all related variable text fields of this variable text field master.
com.sun.star.beans.XPropertySet	getXPropertySet() Returns the property set of this master.
void	remove() Removes the master of a variable text field from the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableTextFieldMaster

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

Constructs new VariableTextFieldMaster.

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

getXPropertySet

public com.sun.star.beans.XPropertySet getXPropertySet()

Returns the property set of this master.

Specified by:

getXPropertySet in interface IVariableTextFieldMaster

Returns:

the property set of this master

getName

public java.lang.String getName()

Returns name of the master of a variable text field. Returns null if a name is not available.

Specified by:

getName in interface IVariableTextFieldMaster

Returns:

name of the master of a variable text field or null if a name is not available

getVariableTextFields

public ITextField[] getVariableTextFields()
                                   throws TextException

Returns all related variable text fields of this variable text field master.

Specified by:

getVariableTextFields in interface IVariableTextFieldMaster

Returns:

all related variable text fields of this variable text field master

Throws:

TextException - if the variable text fields can not be fetched

constructNewVariableTextField

public ITextField constructNewVariableTextField(java.lang.String content,
                                                boolean visible)
                                         throws NOAException

Constructs new variable text field on the basis of this variable text field master. TODO maybe some more parameters are needed???

Specified by:

constructNewVariableTextField in interface IVariableTextFieldMaster

Parameters:

content - the content of the variable textfield

visible - if the variable should be visible

Returns:

new constructed variable text field on the basis of this variable text field master

Throws:

NOAException - if the new variable text field can not be constructed

constructNewVariableTextField

public ITextField constructNewVariableTextField(java.lang.String content,
                                                boolean visible,
                                                INumberFormat numberFormat,
                                                boolean isFormula)
                                         throws NOAException

Constructs new variable text field on the basis of this variable text field master. TODO maybe some more parameters are needed???

Specified by:

constructNewVariableTextField in interface IVariableTextFieldMaster

Parameters:

content - the content of the variable textfield

visible - if the variable should be visible

numberFormat - the number format used for the variable

isFormula - if the given content is a formula

Returns:

new constructed variable text field on the basis of this variable text field master

Throws:

NOAException - if the new variable text field can not be constructed

remove

public void remove()

Removes the master of a variable text field from the document.

Specified by:

remove in interface IVariableTextFieldMaster