Class PDPrintFieldAttributeObject
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
- All Implemented Interfaces:
COSObjectable
A PrintField attribute object.
- Version:
- $Revision: $
- Author:
- Johannes Koch
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
checked state: neutralstatic final String
checked state: offstatic final String
checked state: onstatic final String
standard attribute owner: PrintFieldstatic final String
role: cb: Check boxstatic final String
role: pb: Push buttonstatic final String
role: rb: Radio buttonstatic final String
role: tv: Text-value fieldFields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
UNSPECIFIED
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDPrintFieldAttributeObject
(COSDictionary dictionary) Creates a new PrintField attribute object with a given dictionary. -
Method Summary
Modifier and TypeMethodDescriptionGets the alternate name of the field (Desc).Gets the checked state.getRole()
Gets the role.void
setAlternateName
(String alternateName) Sets the alternate name of the field (Desc).void
setCheckedState
(String checkedState) Sets the checked state.void
Sets the role.toString()
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
getArrayOfString, getColor, getColorOrFourColors, getInteger, getName, getName, getNameOrArrayOfName, getNumber, getNumber, getNumberOrArrayOfNumber, getNumberOrName, getString, isSpecified, setArrayOfName, setArrayOfNumber, setArrayOfString, setColor, setFourColors, setInteger, setName, setNumber, setNumber, setString
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSDictionary, getCOSObject, hashCode
-
Field Details
-
OWNER_PRINT_FIELD
standard attribute owner: PrintField- See Also:
-
ROLE_RB
role: rb: Radio button- See Also:
-
ROLE_CB
role: cb: Check box- See Also:
-
ROLE_PB
role: pb: Push button- See Also:
-
ROLE_TV
role: tv: Text-value field- See Also:
-
CHECKED_STATE_ON
checked state: on- See Also:
-
CHECKED_STATE_OFF
checked state: off- See Also:
-
CHECKED_STATE_NEUTRAL
checked state: neutral- See Also:
-
-
Constructor Details
-
PDPrintFieldAttributeObject
public PDPrintFieldAttributeObject()Default constructor. -
PDPrintFieldAttributeObject
Creates a new PrintField attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Details
-
getRole
Gets the role.- Returns:
- the role
-
setRole
- Parameters:
role
- the role
-
getCheckedState
Gets the checked state. The default value isCHECKED_STATE_OFF
.- Returns:
- the checked state
-
setCheckedState
Sets the checked state. The value shall be one of:CHECKED_STATE_ON
,CHECKED_STATE_OFF
(default), orCHECKED_STATE_NEUTRAL
.
- Parameters:
checkedState
- the checked state
-
getAlternateName
Gets the alternate name of the field (Desc).- Returns:
- the alternate name of the field
-
setAlternateName
Sets the alternate name of the field (Desc).- Parameters:
alternateName
- the alternate name of the field
-
toString
- Overrides:
toString
in classPDAttributeObject
-