Class PdfScreenAnnotation


public class PdfScreenAnnotation extends PdfAnnotation
  • Constructor Details

  • Method Details

    • getSubtype

      public PdfName getSubtype()
      Description copied from class: PdfAnnotation
      Gets a PdfName 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 class PdfAnnotation
      Returns:
      subtype of this annotation.
    • getAction

      public 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.
      Returns:
      PdfDictionary which defines the characteristics and behaviour of an action.
    • setAction

      public PdfScreenAnnotation setAction(PdfAction action)
      Sets a PdfAction 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:
    • setAdditionalAction

      public 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. See ISO-320001 12.6.3, "Trigger Events".
      Parameters:
      key - a PdfName 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 - the PdfDictionary with additional information for appearance stream.
      Returns:
      this PdfScreenAnnotation instance.