class HexaPDF::Type::Annotation::AppearanceDictionary

Parent

The appearance dictionary references appearance streams for various use cases.

Each appearance can either be an XObject or a dictionary mapping names to XObjects. The latter is used when the appearance depends on the state of the annotation, e.g. a check box widget that can be checked or unchecked.

See: PDF1.7 s12.5.5

Field Definitions

NameType/Allowed ValuesRequiredDefault Value
NHexaPDF::Dictionary or HexaPDF::Stream or Hashtruenil
RHexaPDF::Dictionary or HexaPDF::Stream or Hashfalsenil
DHexaPDF::Dictionary or HexaPDF::Stream or Hashfalsenil

Public Instance Methods

down_appearance()

The down appearance which should be used when the mouse button is pressed or held down inside the active area of the annotation.

normal_appearance()

The annotation's normal appearance.

rollover_appearance()

The rollover appearance which should be used when the cursor is moved into the active area of the annotation without pressing a button.