Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDAppearanceEntry

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.util.HashMap, .Map, org.apache.pdfbox.cos.COSDictionary, .COSName, .COSStream, org.apache.pdfbox.pdmodel.common.COSDictionaryMap, .COSObjectable
An entry in an appearance dictionary. May contain either a single appearance stream or an appearance subdictionary.
Author
John Hewson

Field Summary

Modifier and TypeField and Description
private COSDictionary
entry

Constructor Summary

AccessConstructor and Description
private
PDAppearanceEntry()

public
PDAppearanceEntry(COSDictionary
the dictionary of the appearance entry
entry)

Constructor for reading.

Method Summary

Modifier and TypeMethod and Description
public PDAppearanceStream

Returns:

the entry as an appearance stream
getAppearanceStream()

Returns the entry as an appearance stream.

public COSDictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public Map<COSName, PDAppearanceStream>

Returns:

the entry as an appearance subdictionary
getSubDictionary()

Returns the entry as an appearance subdictionary.

public boolean

Returns:

true if this entry is an appearance stream
isStream()

Returns true if this entry is an appearance stream.

public boolean

Returns:

true if this entry is an appearance subdictionary
isSubDictionary()

Returns true if this entry is an appearance subdictionary.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

entryback to summary
private COSDictionary entry

Constructor Detail

PDAppearanceEntryback to summary
private PDAppearanceEntry()
PDAppearanceEntryback to summary
public PDAppearanceEntry(COSDictionary entry)

Constructor for reading.

Parameters
entry:COSDictionary

the dictionary of the appearance entry

Method Detail

getAppearanceStreamback to summary
public PDAppearanceStream getAppearanceStream()

Returns the entry as an appearance stream.

Returns:PDAppearanceStream

the entry as an appearance stream

Exceptions
IllegalStateException:
if this entry is not an appearance stream
getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getSubDictionaryback to summary
public Map<COSName, PDAppearanceStream> getSubDictionary()

Returns the entry as an appearance subdictionary.

Returns:Map<COSName, PDAppearanceStream>

the entry as an appearance subdictionary

Exceptions
IllegalStateException:
if this entry is not an appearance subdictionary
isStreamback to summary
public boolean isStream()

Returns true if this entry is an appearance stream.

Returns:boolean

true if this entry is an appearance stream

isSubDictionaryback to summary
public boolean isSubDictionary()

Returns true if this entry is an appearance subdictionary.

Returns:boolean

true if this entry is an appearance subdictionary