it.stefanochizzolini.clown.documents.interaction.annotations
Class TextMarkup

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.interaction.annotations.Annotation
          it.stefanochizzolini.clown.documents.interaction.annotations.TextMarkup

public class TextMarkup
extends Annotation

Text markup annotation [PDF:1.6:8.4.5].

It displays highlights, underlines, strikeouts, or jagged ("squiggly") underlines in the text of a document.

Since:

0.0.7

Version:

0.0.8

Author:

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

Nested Class Summary

static class

TextMarkup.MarkupTypeEnum Markup type [PDF:1.6:8.4.5].

Nested classes/interfaces inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation

Annotation.FlagsEnum

Constructor Summary

TextMarkup(Page page, Rectangle2D box, TextMarkup.MarkupTypeEnum type)

TextMarkup(PdfDirectObject baseObject, PdfIndirectObject container)

Method Summary

TextMarkup	clone(Document context) Gets a clone of the object, registered inside the given document context.
List<Rectangle2D>	getBoxes() Gets the quadrilaterals encompassing a word or group of contiguous words in the text underlying the annotation.
TextMarkup.MarkupTypeEnum	getMarkupType() Gets the markup type.
void	setBoxes(List<Rectangle2D> value)
void	setMarkupType(TextMarkup.MarkupTypeEnum value)

Methods inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation

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

Methods inherited from class it.stefanochizzolini.clown.objects.PdfObjectWrapper

delete, getBaseDataObject, getBaseObject, getContainer, getDocument, getFile, setBaseObject, setContainer, update

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMarkup

public TextMarkup(Page page,
                  Rectangle2D box,
                  TextMarkup.MarkupTypeEnum type)

TextMarkup

public TextMarkup(PdfDirectObject baseObject,
                  PdfIndirectObject container)

Method Detail

clone

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

getBoxes

public List<Rectangle2D> getBoxes()

Gets the quadrilaterals encompassing a word or group of contiguous words in the text underlying the annotation.

getMarkupType

public TextMarkup.MarkupTypeEnum getMarkupType()

Gets the markup type.

setBoxes

public void setBoxes(List<Rectangle2D> value)

See Also:

getBoxes()

setMarkupType

public void setMarkupType(TextMarkup.MarkupTypeEnum value)

See Also:

getMarkupType()