ag.ion.bion.officelayer.form
Interface IFormService

All Known Implementing Classes:

FormService

public interface IFormService

Service for forms.

Method Summary

IFormComponent[]	getFormComponents() Returns all form components contained in this component.
java.lang.String[]	getFormComponentsNames() Returns all form components names contained in this component.
IForm[]	getForms(java.lang.String formName) Returns the forms for the given form name as an array.
int	getIndexInForm(IForm form, IFormComponent formComponent) Returns the index of the given form component in the given form, or -1 if not found.
com.sun.star.script.XEventAttacherManager	getXEventAttacherManager(IForm form) Returns the OpenOffice.org XEventAttacherManager interface for the given form, or null if not available.
boolean	hasFormComponents() Returns if the component contains other form components.
boolean	hasForms() Returns if the component has forms.
void	removeFormComponent(IFormComponent formComponent) Removes the given form component.

Method Detail

getForms

IForm[] getForms(java.lang.String formName)
                 throws NOAException

Returns the forms for the given form name as an array. There will be only more than one form if the given form name occurs more than once.

Parameters:

formName - the form name to be used

Returns:

the forms for the given form name as an array

Throws:

NOAException - if the return of forms fails

getXEventAttacherManager

com.sun.star.script.XEventAttacherManager getXEventAttacherManager(IForm form)
                                                                   throws NOAException

Returns the OpenOffice.org XEventAttacherManager interface for the given form, or null if not available.

Parameters:

form - the form to be used

Returns:

the OpenOffice.org XEventAttacherManager interface for the given form, or null

Throws:

NOAException - if the return of OpenOffice.org XEventAttacherManager interface fails

getIndexInForm

int getIndexInForm(IForm form,
                   IFormComponent formComponent)
                   throws NOAException

Returns the index of the given form component in the given form, or -1 if not found.

Parameters:

form - the form to check index in

formComponent - the form component to get index for

Returns:

the index of the given form component in the given form, or -1

Throws:

NOAException - if anything fails

hasForms

boolean hasForms()
                 throws NOAException

Returns if the component has forms.

Returns:

if the component has forms

Throws:

NOAException - if the check fails

hasFormComponents

boolean hasFormComponents()
                          throws NOAException

Returns if the component contains other form components.

Returns:

if the component contains other form components

Throws:

NOAException - if the check fails

getFormComponents

IFormComponent[] getFormComponents()
                                   throws NOAException

Returns all form components contained in this component.

Returns:

all form components contained in this component

Throws:

NOAException - if the return fails

getFormComponentsNames

java.lang.String[] getFormComponentsNames()
                                          throws NOAException

Returns all form components names contained in this component.

Returns:

all form components names contained in this component

Throws:

NOAException - if the return fails

removeFormComponent

void removeFormComponent(IFormComponent formComponent)
                         throws NOAException

Removes the given form component.

Parameters:

formComponent - the form component to remove

Throws:

NOAException - if the remove fails