Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject

Field Summary

Modifier and Type	Field and Description
private static final String	CHECKED
public static final String	CHECKED_STATE_NEUTRAL checked state: neutral
public static final String	CHECKED_STATE_OFF checked state: off
public static final String	CHECKED_STATE_ON checked state: on
private static final String	DESC
public static final String	OWNER_PRINT_FIELD standard attribute owner: PrintField
private static final String	ROLE
public static final String	ROLE_CB role: cb: Check box
public static final String	ROLE_PB role: pb: Push button
public static final String	ROLE_RB role: rb: Radio button
public static final String	ROLE_TV role: tv: Text-value field

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject:: UNSPECIFIED

Constructor Summary

Access	Constructor and Description
public	PDPrintFieldAttributeObject() Default constructor.
public	PDPrintFieldAttributeObject(COSDictionary the dictionary dictionary) Creates a new PrintField attribute object with a given dictionary.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the alternate name of the field getAlternateName() Gets the alternate name of the field (Desc).
public String	Returns: the checked state getCheckedState() Gets the checked state.
public String	Returns: the role getRole() Gets the role.
public void	setAlternateName(String the alternate name of the field alternateName) Sets the alternate name of the field (Desc).
public void	setCheckedState(String the checked state checkedState) Sets the checked state.
public void	setRole(String the role role) Sets the role.
public String	toString() Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString. Returns a string representation of the object.

Field Detail

CHECKED	back to summary
private static final String CHECKED

CHECKED_STATE_NEUTRAL	back to summary
public static final String CHECKED_STATE_NEUTRAL checked state: neutral

CHECKED_STATE_OFF	back to summary
public static final String CHECKED_STATE_OFF checked state: off

CHECKED_STATE_ON	back to summary
public static final String CHECKED_STATE_ON checked state: on

DESC	back to summary
private static final String DESC

OWNER_PRINT_FIELD	back to summary
public static final String OWNER_PRINT_FIELD standard attribute owner: PrintField

ROLE	back to summary
private static final String ROLE

ROLE_CB	back to summary
public static final String ROLE_CB role: cb: Check box

ROLE_PB	back to summary
public static final String ROLE_PB role: pb: Push button

ROLE_RB	back to summary
public static final String ROLE_RB role: rb: Radio button

ROLE_TV	back to summary
public static final String ROLE_TV role: tv: Text-value field

Constructor Detail

PDPrintFieldAttributeObject	back to summary
public PDPrintFieldAttributeObject() Default constructor.

PDPrintFieldAttributeObject	back to summary
public PDPrintFieldAttributeObject(COSDictionary dictionary) Creates a new PrintField attribute object with a given dictionary. Parameters dictionary:COSDictionary the dictionary

PDPrintFieldAttributeObject

back to summary

public PDPrintFieldAttributeObject(COSDictionary dictionary)

Creates a new PrintField attribute object with a given dictionary.

Parameters

dictionary:COSDictionary: the dictionary

Method Detail

getAlternateName	back to summary
public String getAlternateName() Gets the alternate name of the field (Desc). Returns:String the alternate name of the field

getAlternateName

back to summary

public String getAlternateName()

Gets the alternate name of the field (Desc).

Returns:String: the alternate name of the field

getCheckedState back to summary

getCheckedState	back to summary
public String getCheckedState() Gets the checked state. The default value is `CHECKED_STATE_OFF`. Returns:String the checked state

public String getCheckedState()

Gets the checked state. The default value is CHECKED_STATE_OFF.

Returns:String: the checked state

getRole	back to summary
public String getRole() Gets the role. Returns:String the role

getRole

back to summary

public String getRole()

Gets the role.

Returns:String: the role

setAlternateName	back to summary
public void setAlternateName(String alternateName) Sets the alternate name of the field (Desc). Parameters alternateName:String the alternate name of the field

setAlternateName

back to summary

public void setAlternateName(String alternateName)

Sets the alternate name of the field (Desc).

Parameters

alternateName:String: the alternate name of the field

setCheckedState back to summary

setCheckedState	back to summary
public void setCheckedState(String checkedState) Sets the checked state. The value shall be one of: `CHECKED_STATE_ON`, `CHECKED_STATE_OFF` (default), or `CHECKED_STATE_NEUTRAL`. Parameters checkedState:String the checked state

public void setCheckedState(String checkedState)

Sets the checked state. The value shall be one of:

Parameters

checkedState:String: the checked state

setRole back to summary

setRole	back to summary
public void setRole(String role) Sets the role. The value of Role shall be one of the following: `ROLE_RB`, `ROLE_CB`, `ROLE_PB`, `ROLE_TV`. Parameters role:String the role

public void setRole(String role)

Sets the role. The value of Role shall be one of the following:

Parameters

role:String: the role

toString back to summary

toString	back to summary
public String toString() Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class PDPrintFieldAttributeObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail