AppearanceDictionary
Overview
AppearanceDictionary is a class in Aspose.PDF FOSS for Java.
Typed view over a form field’s {@code /AP} appearance dictionary (ISO 32000-1:2008 §12.5.5).
This class provides 6 methods for working with AppearanceDictionary objects in Java programs.
Available methods include: AppearanceDictionary, get, getCOSDictionary, getNormal, getStateNames, isMultiState.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: cOSDictionary, multiState, normal, stateNames.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
stateNames | Set<String> | Read | Returns the set of state names available under {@code /N} (normal |
| appearance) for multi-state widgets. | |||
normal | XForm | Read | Returns the single normal appearance stream for a single-state widget |
| (text fields, buttons, etc.), or {@code null} if the field is | |||
| multi-state or has no /N entry. | |||
multiState | boolean | Read | Returns {@code true} when {@code /AP/N} is a dictionary (multi-state), |
| {@code false} when it is a stream (single-state) or absent. | |||
cOSDictionary | COSDictionary | Read | Returns the underlying /AP COS dictionary for engine-side use. |
Methods
| Signature | Description |
|---|---|
AppearanceDictionary(apDict: COSDictionary) | Wraps the given /AP dictionary. |
getStateNames() → Set<String> | Returns the set of state names available under {@code /N} (normal |
| appearance) for multi-state widgets. | |
get(stateName: String) → XForm | Returns the normal appearance stream for the given state, or {@code null} |
| if the state name is not present or if the field is single-state. | |
getNormal() → XForm | Returns the single normal appearance stream for a single-state widget |
| (text fields, buttons, etc.), or {@code null} if the field is | |
| multi-state or has no /N entry. | |
isMultiState() → boolean | Returns {@code true} when {@code /AP/N} is a dictionary (multi-state), |
| {@code false} when it is a stream (single-state) or absent. | |
getCOSDictionary() → COSDictionary | Returns the underlying /AP COS dictionary for engine-side use. |