ag.ion.bion.officelayer.text
Interface ITextFieldService

All Known Implementing Classes:

TextFieldService

public interface ITextFieldService

Textfield service of a text document.

Field Summary

static java.lang.String	ANNOTATION_TEXTFIELD_ID Annotation textfield id
static java.lang.String	PLACEHOLDER_TEXTFIELD_ID Placerholder textfield id
static java.lang.String	USER_TEXTFIELD_ID User textfield id
static java.lang.String	USER_TEXTFIELD_MASTER_ID User field master id
static java.lang.String	VARIABLES_TEXTFIELD_ID Variables textfield id
static java.lang.String	VARIABLES_TEXTFIELD_MASTER_ID Variables field master id

Method Summary

ITextField	addUserTextField(java.lang.String name, java.lang.String content) Adds new user textfield.
ITextField	createPlaceholderTextField(java.lang.String name, java.lang.String hint, short placeholderType) Creates a new placeholder textfield.
IVariableTextFieldMaster	createVariableTextFieldMaster(java.lang.String name, short variableType) Creates a new variable textfield master and returns it, or returns the one that already exists, if it does.
ITextField[]	getPlaceholderFields() Returns all available placeholder textfields.
ITextFieldMaster	getUserTextFieldMaster(java.lang.String name) Returns master of a user textfield with the submitted name.
ITextFieldMaster[]	getUserTextFieldMasters(java.lang.String prefix) Returns masters of the user textfields with the submitted name prefix.
ITextFieldMaster[]	getUserTextFieldMasters(java.lang.String prefix, java.lang.String suffix) Returns masters of the user textfields with the submitted name prefix and suffix.
ITextField[]	getUserTextFields() Returns all available user textfields.
ITextField[]	getVariableFields(java.lang.String prefix) Returns all available variable textfields with the submitted name prefix.
IVariableTextFieldMaster	getVariableTextFieldMaster(java.lang.String masterName) Returns master of the variables text fields with the submitted name, or null if not availbale.
IVariableTextFieldMaster[]	getVariableTextFieldMasters(java.lang.String prefix) Returns all masters of the variables text fields with the submitted name prefix.
void	refresh() Refreshes all textfields.

Field Detail

USER_TEXTFIELD_MASTER_ID

static final java.lang.String USER_TEXTFIELD_MASTER_ID

User field master id

See Also:

Constant Field Values

USER_TEXTFIELD_ID

static final java.lang.String USER_TEXTFIELD_ID

User textfield id

See Also:

Constant Field Values

VARIABLES_TEXTFIELD_MASTER_ID

static final java.lang.String VARIABLES_TEXTFIELD_MASTER_ID

Variables field master id

See Also:

Constant Field Values

VARIABLES_TEXTFIELD_ID

static final java.lang.String VARIABLES_TEXTFIELD_ID

Variables textfield id

See Also:

Constant Field Values

ANNOTATION_TEXTFIELD_ID

static final java.lang.String ANNOTATION_TEXTFIELD_ID

Annotation textfield id

See Also:

Constant Field Values

PLACEHOLDER_TEXTFIELD_ID

static final java.lang.String PLACEHOLDER_TEXTFIELD_ID

Placerholder textfield id

See Also:

Constant Field Values

Method Detail

getUserTextFieldMaster

ITextFieldMaster getUserTextFieldMaster(java.lang.String name)
                                        throws TextException

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

Parameters:

name - name of the master of the user textfield

Returns:

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

Throws:

TextException - if the user textfield can not be provided

getUserTextFieldMasters

ITextFieldMaster[] getUserTextFieldMasters(java.lang.String prefix)
                                           throws TextException

Returns masters of the user textfields with the submitted name prefix.

Parameters:

prefix - name prefix to be used

Returns:

masters of the user textfields with the submitted name prefix

Throws:

TextException - if the masters of the user textfields can not be constructed

getUserTextFieldMasters

ITextFieldMaster[] getUserTextFieldMasters(java.lang.String prefix,
                                           java.lang.String suffix)
                                           throws TextException

Returns masters of the user textfields with the submitted name prefix and suffix.

Parameters:

prefix - name prefix to be used

suffix - name suffix to be used

Returns:

masters of the user textfields with the submitted name prefix and suffix

Throws:

TextException - if the masters of the user textfields can not be constructed

addUserTextField

ITextField addUserTextField(java.lang.String name,
                            java.lang.String content)
                            throws TextException

Adds new user textfield.

Parameters:

name - name of the textfield

content - content of the textfield

Returns:

new textfield

Throws:

TextException - if any error occurs during textfield creation

getUserTextFields

ITextField[] getUserTextFields()
                               throws TextException

Returns all available user textfields.

Returns:

all available user textfields

Throws:

TextException - if the user textfields can not be constructed

getPlaceholderFields

ITextField[] getPlaceholderFields()
                                  throws TextException

Returns all available placeholder textfields.

Returns:

all available placeholder textfields

Throws:

TextException - if the placeholder textfields can not be constructed

createPlaceholderTextField

ITextField createPlaceholderTextField(java.lang.String name,
                                      java.lang.String hint,
                                      short placeholderType)
                                      throws TextException

Creates a new placeholder textfield.

Parameters:

name - name of the placeholder textfield

hint - the hint of the placeholder textfield, may be null

placeholderType - the type of the placeholder found in static members of com.sun.star.text.PlaceholderType (i.e. PlaceholderType.TEXT)

Returns:

new placeholder textfield

Throws:

TextException - if any error occurs during placeholder textfield creation

getVariableTextFieldMaster

IVariableTextFieldMaster getVariableTextFieldMaster(java.lang.String masterName)
                                                    throws TextException

Returns master of the variables text fields with the submitted name, or null if not availbale.

Parameters:

masterName - name of the master to return

Returns:

master of the variables text fields with the submitted name, or null

Throws:

TextException - if the master can not be returned

getVariableTextFieldMasters

IVariableTextFieldMaster[] getVariableTextFieldMasters(java.lang.String prefix)
                                                       throws TextException

Returns all masters of the variables text fields with the submitted name prefix.

Parameters:

prefix - name prefix to be used

Returns:

all masters of the variables text fields

Throws:

TextException - if the masters can not be returned

createVariableTextFieldMaster

IVariableTextFieldMaster createVariableTextFieldMaster(java.lang.String name,
                                                       short variableType)
                                                       throws TextException

Creates a new variable textfield master and returns it, or returns the one that already exists, if it does. TODO maybe some more parameters are needed???

Parameters:

name - name of the variable textfield master

variableType - the type of the variable master found in static members of com.sun.star.text.SetVariableType (i.e. SetVariableType.STRING)

Returns:

the variable textfield master with the given name

Throws:

TextException - if any error occurs during variable textfield master creation

getVariableFields

ITextField[] getVariableFields(java.lang.String prefix)
                               throws TextException

Returns all available variable textfields with the submitted name prefix.

Parameters:

prefix - name prefix to be used

Returns:

all available variable textfields

Throws:

TextException - if the variable textfields can not be constructed

refresh

void refresh()
             throws TextException

Refreshes all textfields.

Throws:

TextException - if refresh fails