org.pdfclown.documents.interaction.annotations
Class Popup

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

All Implemented Interfaces:

Cloneable, ILayerable, IPdfObjectWrapper

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

Pop-up annotation [PDF:1.6:8.4.5].

It displays text in a pop-up window for entry and editing. It typically does not appear alone but is associated with a markup annotation, its parent annotation, and is used for editing the parent's text.

Since:

0.0.7

Version:

0.1.2, 12/21/12

Author:

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

Nested Class Summary

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

Annotation.FlagsEnum

Constructor Summary

Popup(Page page, Rectangle2D box, String text)

Method Summary

Popup	clone(Document context) Gets a clone of the object, registered inside the given document context.
Annotation	getParent() Gets the parent annotation.
boolean	isOpen() Gets whether the annotation should initially be displayed open.
void	setOpen(boolean value)
void	setParent(Annotation 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

Popup

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

Method Detail

clone

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

isOpen

public boolean isOpen()

Gets whether the annotation should initially be displayed open.

getParent

public Annotation getParent()

Gets the parent annotation.

setOpen

public void setOpen(boolean value)

See Also:

isOpen()

setParent

public void setParent(Annotation value)

See Also:

getParent()