org.pdfclown.documents.interaction.annotations
Class Caret

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

All Implemented Interfaces:

Cloneable, ILayerable, IPdfObjectWrapper

@PDF(value=PDF15)
public final class Caret
extends Annotation

Caret annotation [PDF:1.6:8.4.5].

It displays a visual symbol that indicates the presence of text edits.

Since:

0.0.7

Version:

0.1.2, 12/21/12

Author:

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

Nested Class Summary

static class

Caret.SymbolTypeEnum Symbol type [PDF:1.6:8.4.5].

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

Annotation.FlagsEnum

Constructor Summary

Caret(Page page, Rectangle2D box, String text)

Method Summary

Caret	clone(Document context) Gets a clone of the object, registered inside the given document context.
Caret.SymbolTypeEnum	getSymbolType() Gets the symbol to be used in displaying the annotation.
void	setSymbolType(Caret.SymbolTypeEnum 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

Caret

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

Method Detail

clone

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

getSymbolType

public Caret.SymbolTypeEnum getSymbolType()

Gets the symbol to be used in displaying the annotation.

setSymbolType

public void setSymbolType(Caret.SymbolTypeEnum value)

See Also:

getSymbolType()