Package com.itextpdf.kernel.pdf.annot
Class PdfScreenAnnotation
- java.lang.Object
-
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
-
- com.itextpdf.kernel.pdf.annot.PdfAnnotation
-
- com.itextpdf.kernel.pdf.annot.PdfScreenAnnotation
-
public class PdfScreenAnnotation extends PdfAnnotation
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
PdfAnnotation.PdfUnknownAnnotation
-
-
Field Summary
-
Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked
-
-
Constructor Summary
Constructors Modifier Constructor Description PdfScreenAnnotation(Rectangle rect)
protected
PdfScreenAnnotation(PdfDictionary pdfObject)
Instantiates a newPdfScreenAnnotation
instance based onPdfDictionary
instance, that represents existing annotation object in the document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfDictionary
getAction()
AnPdfAction
to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated.PdfDictionary
getAdditionalAction()
An additional actions dictionary that extends the set of events that can trigger the execution of an action.PdfDictionary
getAppearanceCharacteristics()
An appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.PdfName
getSubtype()
Gets aPdfName
which value is a subtype of this annotation.PdfScreenAnnotation
setAction(PdfAction action)
Sets aPdfAction
to this annotation which will be performed when the annotation is activated.PdfScreenAnnotation
setAdditionalAction(PdfName key, PdfAction action)
Sets an additionalPdfAction
to this annotation which will be performed in response to the specific trigger event defined bykey
.PdfScreenAnnotation
setAppearanceCharacteristics(PdfDictionary characteristics)
Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.-
Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle
-
Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
-
-
-
-
Constructor Detail
-
PdfScreenAnnotation
public PdfScreenAnnotation(Rectangle rect)
-
PdfScreenAnnotation
protected PdfScreenAnnotation(PdfDictionary pdfObject)
Instantiates a newPdfScreenAnnotation
instance based onPdfDictionary
instance, that represents existing annotation object in the document.- Parameters:
pdfObject
- thePdfDictionary
representing annotation object- See Also:
PdfAnnotation.makeAnnotation(PdfObject)
-
-
Method Detail
-
getSubtype
public PdfName getSubtype()
Description copied from class:PdfAnnotation
Gets aPdfName
which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.- Specified by:
getSubtype
in classPdfAnnotation
- Returns:
- subtype of this annotation.
-
getAction
public PdfDictionary getAction()
AnPdfAction
to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated.- Returns:
PdfDictionary
which defines the characteristics and behaviour of an action.
-
setAction
public PdfScreenAnnotation setAction(PdfAction action)
Sets aPdfAction
to this annotation which will be performed when the annotation is activated.- Parameters:
action
-PdfAction
to set to this annotation.- Returns:
- this
PdfScreenAnnotation
instance.
-
getAdditionalAction
public PdfDictionary getAdditionalAction()
An additional actions dictionary that extends the set of events that can trigger the execution of an action. See ISO-320001 12.6.3 Trigger Events.- Returns:
- an additional actions
PdfDictionary
. - See Also:
getAction()
-
setAdditionalAction
public PdfScreenAnnotation setAdditionalAction(PdfName key, PdfAction action)
Sets an additionalPdfAction
to this annotation which will be performed in response to the specific trigger event defined bykey
. See ISO-320001 12.6.3, "Trigger Events".- Parameters:
key
- aPdfName
that denotes a type of the additional action to set.action
-PdfAction
to set as additional to this annotation.- Returns:
- this
PdfScreenAnnotation
instance.
-
getAppearanceCharacteristics
public PdfDictionary getAppearanceCharacteristics()
An appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream. See ISO-320001, Table 189.- Returns:
- an appearance characteristics dictionary or null if it isn't specified.
-
setAppearanceCharacteristics
public PdfScreenAnnotation setAppearanceCharacteristics(PdfDictionary characteristics)
Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream. See ISO-320001, Table 189.- Parameters:
characteristics
- thePdfDictionary
with additional information for appearance stream.- Returns:
- this
PdfScreenAnnotation
instance.
-
-