ag.ion.bion.officelayer.text
Interface IVariableTextFieldMaster

All Known Implementing Classes:

VariableTextFieldMaster

public interface IVariableTextFieldMaster

Master of a variable text field of a text document.

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.

Method Detail

getName

java.lang.String getName()

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

Returns:

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

getXPropertySet

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

Returns the property set of this master.

Returns:

the property set of this master

getVariableTextFields

ITextField[] getVariableTextFields()
                                   throws TextException

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

Returns:

all related variable text fields of this variable text field master

Throws:

TextException - if the variable text fields can not be fetched

constructNewVariableTextField

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???

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

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???

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

void remove()

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