org.icepdf.core.pobjects.annotations
Class Appearance

java.lang.Object
  org.icepdf.core.pobjects.Dictionary
      org.icepdf.core.pobjects.Stream
          org.icepdf.core.pobjects.annotations.Appearance

public class Appearance
extends Stream

Refer to: 8.4.4 Appearance Streams

An annotation can define as many as three separate appearances:

• The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation.
• The rollover appearance is used when the user moves the cursor into the annotation's active area without pressing the mouse button.
• The down appearance is used when the mouse button is pressed or held down within the annotation's active area.

Key	Type	Value
N	stream or dictionary	(Required) The annotation's normal appearance
R	stream or dictionary	(Optional) The annotation's rollover appearance. Default value: the value of the N entry.
D	stream or dictionary	(Optional) The annotation's down appearance. Default value: the value of the N entry.

Since:

2.5

Author:

Mark Collette

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Stream

COLORSPACE_KEY, compressed, CS_KEY, DECODEPARAM_KEY, F_KEY, FILTER_KEY, H_KEY, HEIGHT_KEY, I_KEY, IM_KEY, IMAGEMASK_KEY, INDEXED_KEY, pObjectReference, rawBytes, W_KEY, WIDTH_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Appearance(Library l, java.util.HashMap h, SeekableInputConstrainedWrapper streamInputWrapper)
Create a new instance of an Appearance stream.

Method Summary

Methods inherited from class org.icepdf.core.pobjects.Stream

getDecodedByteArrayInputStream, getDecodedStreamBytes, getDecodedStreamBytes, getFilterNames, getNormalisedFilterNames, getPObjectReference, getRawBytes, isImageSubtype, isRawBytesCompressed, setPObjectReference, setRawBytes, toString

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, init, isDeleted, isNew, setDeleted, setNew

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Appearance

public Appearance(Library l,
                  java.util.HashMap h,
                  SeekableInputConstrainedWrapper streamInputWrapper)

Create a new instance of an Appearance stream.

Parameters:

l - library containing a hash of all document objects

h - HashMap of parameters specific to the Stream object.

streamInputWrapper - Accessor to stream byte data