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
public class PDPrintFieldAttributeObject extends PDStandardAttributeObject
A PrintField attribute object.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
CHECKED
static java.lang.String
CHECKED_STATE_NEUTRAL
checked state: neutralstatic java.lang.String
CHECKED_STATE_OFF
checked state: offstatic java.lang.String
CHECKED_STATE_ON
checked state: onprivate static java.lang.String
DESC
static java.lang.String
OWNER_PRINT_FIELD
standard attribute owner: PrintFieldprivate static java.lang.String
ROLE
static java.lang.String
ROLE_CB
role: cb: Check boxstatic java.lang.String
ROLE_PB
role: pb: Push buttonstatic java.lang.String
ROLE_RB
role: rb: Radio buttonstatic java.lang.String
ROLE_TV
role: tv: Text-value field-
Fields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
UNSPECIFIED
-
-
Constructor Summary
Constructors Constructor Description PDPrintFieldAttributeObject()
Default constructor.PDPrintFieldAttributeObject(COSDictionary dictionary)
Creates a new PrintField attribute object with a given dictionary.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAlternateName()
Gets the alternate name of the field (Desc).java.lang.String
getCheckedState()
Gets the checked state.java.lang.String
getRole()
Gets the role.void
setAlternateName(java.lang.String alternateName)
Sets the alternate name of the field (Desc).void
setCheckedState(java.lang.String checkedState)
Sets the checked state.void
setRole(java.lang.String role)
Sets the role.java.lang.String
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, getCOSObject, hashCode
-
-
-
-
Field Detail
-
OWNER_PRINT_FIELD
public static final java.lang.String OWNER_PRINT_FIELD
standard attribute owner: PrintField- See Also:
- Constant Field Values
-
ROLE
private static final java.lang.String ROLE
- See Also:
- Constant Field Values
-
CHECKED
private static final java.lang.String CHECKED
- See Also:
- Constant Field Values
-
DESC
private static final java.lang.String DESC
- See Also:
- Constant Field Values
-
ROLE_RB
public static final java.lang.String ROLE_RB
role: rb: Radio button- See Also:
- Constant Field Values
-
ROLE_CB
public static final java.lang.String ROLE_CB
role: cb: Check box- See Also:
- Constant Field Values
-
ROLE_PB
public static final java.lang.String ROLE_PB
role: pb: Push button- See Also:
- Constant Field Values
-
ROLE_TV
public static final java.lang.String ROLE_TV
role: tv: Text-value field- See Also:
- Constant Field Values
-
CHECKED_STATE_ON
public static final java.lang.String CHECKED_STATE_ON
checked state: on- See Also:
- Constant Field Values
-
CHECKED_STATE_OFF
public static final java.lang.String CHECKED_STATE_OFF
checked state: off- See Also:
- Constant Field Values
-
CHECKED_STATE_NEUTRAL
public static final java.lang.String CHECKED_STATE_NEUTRAL
checked state: neutral- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDPrintFieldAttributeObject
public PDPrintFieldAttributeObject()
Default constructor.
-
PDPrintFieldAttributeObject
public PDPrintFieldAttributeObject(COSDictionary dictionary)
Creates a new PrintField attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Detail
-
getRole
public java.lang.String getRole()
Gets the role.- Returns:
- the role
-
setRole
public void setRole(java.lang.String role)
- Parameters:
role
- the role
-
getCheckedState
public java.lang.String getCheckedState()
Gets the checked state. The default value isCHECKED_STATE_OFF
.- Returns:
- the checked state
-
setCheckedState
public void setCheckedState(java.lang.String checkedState)
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
public java.lang.String getAlternateName()
Gets the alternate name of the field (Desc).- Returns:
- the alternate name of the field
-
setAlternateName
public void setAlternateName(java.lang.String alternateName)
Sets the alternate name of the field (Desc).- Parameters:
alternateName
- the alternate name of the field
-
toString
public java.lang.String toString()
- Overrides:
toString
in classPDAttributeObject
-
-