class HexaPDF::Type::Annotation::AppearanceDictionary

Parent	HexaPDF::Dictionary

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: PDF2.0 s12.5.5

Field Definitions

Name	Type/Allowed Values	Required	Default Value
N	HexaPDF::Dictionary or HexaPDF::Stream or Hash	true	nil
R	HexaPDF::Dictionary or HexaPDF::Stream or Hash	false	nil
D	HexaPDF::Dictionary or HexaPDF::Stream or Hash	false	nil

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.

set_appearance(appearance, type: :normal, state_name: nil)¶

Sets the appearance of the given appearance type, which can either be :normal, :rollover or :down, to appearance.

If the state_name argument is provided, the appearance is stored under the state_name key in a sub-dictionary of the appearance.