org.pdfclown.documents.interaction.annotations
Class Note

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

All Implemented Interfaces:

Cloneable, ILayerable, IPdfObjectWrapper

@PDF(value=PDF10)
public final class Note
extends Annotation

Text annotation [PDF:1.6:8.4.5].

It represents a sticky note attached to a point in the PDF document.

Since:

0.0.7

Version:

0.1.2, 12/21/12

Author:

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

Nested Class Summary

static class

Note.IconTypeEnum Icon to be used in displaying the annotation [PDF:1.6:8.4.5].

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

Annotation.FlagsEnum

Constructor Summary

Note(Page page, Point2D location, String text)

Method Summary

Note	clone(Document context) Gets a clone of the object, registered inside the given document context.
Note.IconTypeEnum	getIconType() Gets the icon to be used in displaying the annotation.
boolean	isOpen() Gets whether the annotation should initially be displayed open.
void	setIconType(Note.IconTypeEnum value)
void	setOpen(boolean 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

Note

public Note(Page page,
            Point2D location,
            String text)

Method Detail

clone

public Note 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.

getIconType

public Note.IconTypeEnum getIconType()

Gets the icon to be used in displaying the annotation.

isOpen

public boolean isOpen()

Gets whether the annotation should initially be displayed open.

setIconType

public void setIconType(Note.IconTypeEnum value)

See Also:

getIconType()

setOpen

public void setOpen(boolean value)

See Also:

isOpen()