ag.ion.bion.officelayer.internal.form
Class FormComponent

java.lang.Object
  ag.ion.bion.officelayer.internal.form.FormComponent

All Implemented Interfaces:

IFormComponent

Direct Known Subclasses:

Form

public class FormComponent
extends java.lang.Object
implements IFormComponent

The implementation of a form component in a document.

Constructor Summary

FormComponent(IDocument document, com.sun.star.drawing.XControlShape xControlShape, com.sun.star.form.XFormComponent xFormComponent)
Constructs new FormComponent.

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, or null if not available.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormComponent

public FormComponent(IDocument document,
                     com.sun.star.drawing.XControlShape xControlShape,
                     com.sun.star.form.XFormComponent xFormComponent)
              throws java.lang.IllegalArgumentException

Constructs new FormComponent.

Parameters:

document - the document of the form component

xControlShape - the OpenOffice.org XControlShape interface to be used

xFormComponent - the OpenOffice.org XFormComponent interface to be used

Throws:

java.lang.IllegalArgumentException - if the submitted document or the OpenOffice.org XFormComponent or XControlShape interface is not valid

Method Detail

getXPropertySet

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

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

Specified by:

getXPropertySet in interface IFormComponent

Returns:

the property set of this form component, or null

Throws:

NOAException - if the return fails

getXFormComponent

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

Returns the OpenOffice.org XFormComponent interface.

Specified by:

getXFormComponent in interface IFormComponent

Returns:

the OpenOffice.org XFormComponent interface

getXControlShape

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

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

Specified by:

getXControlShape in interface IFormComponent

Returns:

the OpenOffice.org XControlShape interface, or null

getXControl

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

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

Specified by:

getXControl in interface IFormComponent

Returns:

the OpenOffice.org XControl interface, or null

Throws:

NOAException - if the return fails

getXTextComponent

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

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

Specified by:

getXTextComponent in interface IFormComponent

Returns:

the OpenOffice.org XTextComponent interface, or null

Throws:

NOAException - if the return fails

focus

public void focus()
           throws NOAException

Sets the focus to this from component.

Specified by:

focus in interface IFormComponent

Throws:

NOAException - if the focus fails

getStartTextRange

public ITextRange getStartTextRange()
                             throws NOAException

Returns the text range of the anchor where the form component starts, or null if not available.

Specified by:

getStartTextRange in interface IFormComponent

Returns:

the text range of the anchor where the form component starts,or null

Throws:

NOAException - if the return of text range fails