ag.ion.bion.officelayer.form
Interface IFormComponent

All Known Subinterfaces:

IForm

All Known Implementing Classes:

Form, FormComponent

public interface IFormComponent

The interface for a form component in a document.

Method Summary

void	focus() Sets the focus to this from component.
ITextRange	getStartTextRange() Returns the text range of the anchor where the form component starts.
com.sun.star.awt.XControl	getXControl() Returns the OpenOffice.org XControl interface, can be null.
com.sun.star.drawing.XControlShape	getXControlShape() Returns the OpenOffice.org XControlShape interface, can be null.
com.sun.star.form.XFormComponent	getXFormComponent() Returns the OpenOffice.org XFormComponent interface.
com.sun.star.beans.XPropertySet	getXPropertySet() Returns the property set of this form component, or null if not available.
com.sun.star.awt.XTextComponent	getXTextComponent() Returns the OpenOffice.org XTextComponent interface, or null if not available.

Method Detail

getXPropertySet

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

Returns the property set of this form component, or null if not available.

Returns:

the property set of this form component, or null

Throws:

NOAException - if the return fails

getXFormComponent

com.sun.star.form.XFormComponent getXFormComponent()

Returns the OpenOffice.org XFormComponent interface.

Returns:

the OpenOffice.org XFormComponent interface

getXControlShape

com.sun.star.drawing.XControlShape getXControlShape()

Returns the OpenOffice.org XControlShape interface, can be null.

Returns:

the OpenOffice.org XControlShape interface, or null

getXControl

com.sun.star.awt.XControl getXControl()
                                      throws NOAException

Returns the OpenOffice.org XControl interface, can be null.

Returns:

the OpenOffice.org XControl interface, or null

Throws:

NOAException - if the return fails

getXTextComponent

com.sun.star.awt.XTextComponent getXTextComponent()
                                                  throws NOAException

Returns the OpenOffice.org XTextComponent interface, or null if not available.

Returns:

the OpenOffice.org XTextComponent interface, or null

Throws:

NOAException - if the return fails

focus

void focus()
           throws NOAException

Sets the focus to this from component.

Throws:

NOAException - if the focus fails

getStartTextRange

ITextRange getStartTextRange()
                             throws NOAException

Returns the text range of the anchor where the form component starts.

Returns:

the text range of the anchor where the form component starts

Throws:

NOAException - if the return of text range fails