org.icepdf.core.pobjects.annotations

Class Appearance

java.lang.Object

org.icepdf.core.pobjects.annotations.Appearance

public class Appearance
extends java.lang.Object

An appearance dictionary dictionary entry for N, R or D can be associated with one or more appearance streams. For example a Widget btn annotation can have an /ON an /Off state. This class sill store one or more named appearance streams for a dictionary entry.

Since:

5.1

Constructor Summary

Constructors

Constructor and Description
Appearance() Create a new instance of an Appearance stream.

Method Summary

Modifier and Type	Method and Description
void	addAppearance(Name name, AppearanceState appearanceState)
AppearanceState	getAppearanceState(Name name)
Name	getOffName()
Name	getOnName()
AppearanceState	getSelectedAppearanceState()
Name	getSelectedName()
boolean	hasAlternativeAppearance()
void	setSelectedName(Name selectedName)
protected void	updateAppearanceDictionary(java.util.HashMap<java.lang.Object,java.lang.Object> entries) Updates or adds the APPEARANCE_STATE_KEY with the currently selected state.

Methods inherited from class java.lang.Object

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

Constructor Detail

Appearance

public Appearance()

Create a new instance of an Appearance stream.

Method Detail

hasAlternativeAppearance

public boolean hasAlternativeAppearance()

addAppearance

public void addAppearance(Name name,
                          AppearanceState appearanceState)

getOffName

public Name getOffName()

getOnName

public Name getOnName()

getSelectedName

public Name getSelectedName()

setSelectedName

public void setSelectedName(Name selectedName)

getSelectedAppearanceState

public AppearanceState getSelectedAppearanceState()

getAppearanceState

public AppearanceState getAppearanceState(Name name)

updateAppearanceDictionary

protected void updateAppearanceDictionary(java.util.HashMap<java.lang.Object,java.lang.Object> entries)

Updates or adds the APPEARANCE_STATE_KEY with the currently selected state.

Parameters:

entries - parent annotation dictionary to update.