org.pdfclown.documents.interaction.annotations
Class CalloutNote

java.lang.Object
  org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
      org.pdfclown.documents.interaction.annotations.Annotation
          org.pdfclown.documents.interaction.annotations.CalloutNote

All Implemented Interfaces:

Cloneable, ILayerable, IPdfObjectWrapper

@PDF(value=PDF13)
public final class CalloutNote
extends Annotation

Free text annotation [PDF:1.6:8.4.5].

It displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.

Since:

0.0.7

Version:

0.1.2, 12/21/12

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary

static class

CalloutNote.LineObject Callout line [PDF:1.6:8.4.5].

Nested classes/interfaces inherited from class org.pdfclown.documents.interaction.annotations.Annotation

Annotation.FlagsEnum

Constructor Summary

CalloutNote(Page page, Rectangle2D box, String text)

Method Summary

CalloutNote	clone(Document context) Gets a clone of the object, registered inside the given document context.
JustificationEnum	getJustification() Gets the justification to be used in displaying the annotation's text.
CalloutNote.LineObject	getLine() Gets the callout line attached to the free text annotation.
void	setJustification(JustificationEnum value)
void	setLine(CalloutNote.LineObject value)

Methods inherited from class org.pdfclown.documents.interaction.annotations.Annotation

delete, getAction, getActions, getAppearance, getBorder, getBox, getColor, getFlags, getLayer, getModificationDate, getName, getPage, getText, isPrintable, isVisible, setAction, setActions, setAppearance, setBorder, setBox, setColor, setFlags, setLayer, setModificationDate, setName, setPrintable, setText, setVisible, wrap

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper

checkCompatibility, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

CalloutNote

public CalloutNote(Page page,
                   Rectangle2D box,
                   String text)

Method Detail

clone

public CalloutNote clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Overrides:

clone in class Annotation

Parameters:

context - Which document the clone has to be registered in.

getJustification

public JustificationEnum getJustification()

Gets the justification to be used in displaying the annotation's text.

getLine

public CalloutNote.LineObject getLine()

Gets the callout line attached to the free text annotation.

setJustification

public void setJustification(JustificationEnum value)

See Also:

getJustification()

setLine

public void setLine(CalloutNote.LineObject value)

See Also:

getLine()