public class PdfScreenAnnotation extends 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
Modifier | Constructor and Description |
---|---|
protected |
PdfScreenAnnotation(PdfDictionary pdfObject)
|
|
PdfScreenAnnotation(Rectangle rect) |
Modifier and Type | Method and Description |
---|---|
PdfDictionary |
getAction()
An PdfAction 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 a PdfName which value is a subtype of this annotation.
|
PdfScreenAnnotation |
setAction(PdfAction action)
Sets a PdfAction to this annotation which will be performed when the annotation is activated.
|
PdfScreenAnnotation |
setAdditionalAction(PdfName key, PdfAction action)
Sets an additional PdfAction to this annotation which will be performed in response to the specific trigger event defined by key .
|
PdfScreenAnnotation |
setAppearanceCharacteristics(PdfDictionary characteristics)
Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.
|
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
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
public PdfScreenAnnotation(Rectangle rect)
protected PdfScreenAnnotation(PdfDictionary pdfObject)
public PdfName getSubtype()
PdfAnnotation
PdfName
which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.
getSubtype
in class PdfAnnotation
public PdfDictionary getAction()
PdfAction
to perform, such as launching an application, playing a sound, changing an annotation’s appearance state etc, when the annotation is activated.
PdfDictionary
which defines the characteristics and behaviour of an action.
public PdfScreenAnnotation setAction(PdfAction action)
PdfAction
to this annotation which will be performed when the annotation is activated.
action
- PdfAction
to set to this annotation.
PdfScreenAnnotation
instance.
public PdfDictionary getAdditionalAction()
PdfDictionary
.
getAction()
public PdfScreenAnnotation setAdditionalAction(PdfName key, PdfAction action)
PdfAction
to this annotation which will be performed in response to the specific trigger event defined by key
. See ISO-320001 12.6.3, "Trigger Events".
key
- a PdfName
that denotes a type of the additional action to set.
action
- PdfAction
to set as additional to this annotation.
PdfScreenAnnotation
instance.
public PdfDictionary getAppearanceCharacteristics()
public PdfScreenAnnotation setAppearanceCharacteristics(PdfDictionary characteristics)
characteristics
- the PdfDictionary
with additional information for appearance stream.
PdfScreenAnnotation
instance.
Copyright © 1998–2020 iText Group NV. All rights reserved.