ag.ion.bion.officelayer.internal.text
Class Annotation

java.lang.Object
  ag.ion.bion.officelayer.text.AbstractTextComponent
      ag.ion.bion.officelayer.internal.text.Annotation

All Implemented Interfaces:

IAnnotation, ITextComponent, ITextContent

public class Annotation
extends AbstractTextComponent
implements IAnnotation, ITextContent, ITextComponent

Annotation of a text document.

Field Summary

Fields inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

textDocument

Constructor Summary

Annotation(ITextDocument textDocument, ITextField textField)
Constructs new Annotation.

Annotation(ITextDocument textDocument, com.sun.star.text.XDependentTextField xDependentTextField)
Constructs new Annotation.

Method Summary

java.lang.String	getText() Returns the text content of the annotation, or null if text content is not available.
ITextRange	getTextRange() Returns text range of the textfield.
com.sun.star.text.XTextContent	getXTextContent() Returns OpenOffice.org XTextContent interface.
void	jumpTo() Jumps to the annotation.

Methods inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

getTextDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.text.ITextComponent

getTextDocument

Constructor Detail

Annotation

public Annotation(ITextDocument textDocument,
                  ITextField textField)
           throws java.lang.IllegalArgumentException

Constructs new Annotation.

Parameters:

textDocument - text document to be used

textField - the text field to be used

Throws:

java.lang.IllegalArgumentException - if one the OpenOffice.org interface is not valid

Annotation

public Annotation(ITextDocument textDocument,
                  com.sun.star.text.XDependentTextField xDependentTextField)
           throws java.lang.IllegalArgumentException

Constructs new Annotation.

Parameters:

textDocument - text document to be used

xDependentTextField - OpenOffice.org XDependentTextField interface

Throws:

java.lang.IllegalArgumentException - if one the OpenOffice.org interface is not valid

Method Detail

getText

public java.lang.String getText()

Returns the text content of the annotation, or null if text content is not available.

Specified by:

getText in interface IAnnotation

Returns:

the text content of the annotation, or null

getTextRange

public ITextRange getTextRange()

Returns text range of the textfield.

Specified by:

getTextRange in interface IAnnotation

Returns:

text range of the textfield

jumpTo

public void jumpTo()

Jumps to the annotation.

Specified by:

jumpTo in interface IAnnotation

getXTextContent

public com.sun.star.text.XTextContent getXTextContent()

Returns OpenOffice.org XTextContent interface. This method is not part of the public API. It should be never used from outside.

Specified by:

getXTextContent in interface ITextContent

Returns:

OpenOffice.org XTextContent interface