Foxit PDF SDK
|
Public Member Functions | |
SchemaField () | |
Constructor. | |
SchemaField (SchemaField other) | |
Constructor, with another schema field object. More... | |
String | getDisplayName () throws com.foxit.sdk.PDFException |
Get the display name. More... | |
String | getKeyName () throws com.foxit.sdk.PDFException |
Get the key name string. More... | |
String | getSubtypeName () throws com.foxit.sdk.PDFException |
Get the subtype name string. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | isVisible () throws com.foxit.sdk.PDFException |
Check if current field is initially visible in application or not. More... | |
void | setDisplayName (String display_name) throws com.foxit.sdk.PDFException |
Set the display name. More... | |
void | setKeyName (String key_name) throws com.foxit.sdk.PDFException |
Set the key name string. More... | |
void | setSubtypeName (String subtype_name) throws com.foxit.sdk.PDFException |
Set the subtype name string. More... | |
void | setVisibility (boolean is_visible) throws com.foxit.sdk.PDFException |
Set the initial visibility of current field in application. More... | |
Schema field can be used to decide which information of a node is to be shown or hide in application.
com.foxit.sdk.pdf.SchemaField.SchemaField | ( | SchemaField | other | ) |
Constructor, with another schema field object.
[in] | other | Another PDF portfolio folder object. |
String com.foxit.sdk.pdf.SchemaField.getDisplayName | ( | ) | throws com.foxit.sdk.PDFException |
Get the display name.
Display name is used for displaying. This can be different from schema field's key name.
String com.foxit.sdk.pdf.SchemaField.getKeyName | ( | ) | throws com.foxit.sdk.PDFException |
Get the key name string.
Each schema field is stored by a unique key name. Schema field's key name can be used:
String com.foxit.sdk.pdf.SchemaField.getSubtypeName | ( | ) | throws com.foxit.sdk.PDFException |
Get the subtype name string.
Subtype name can be used to specify some properties of file node and folder node directly:
For other case, subtype name is used to specified the data type of an specified entry in file or folder node dictionary. The key for the entry is specified by current schema field's key name. and the data type is specified by:
boolean com.foxit.sdk.pdf.SchemaField.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.pdf.SchemaField.isVisible | ( | ) | throws com.foxit.sdk.PDFException |
Check if current field is initially visible in application or not.
void com.foxit.sdk.pdf.SchemaField.setDisplayName | ( | String | display_name | ) | throws com.foxit.sdk.PDFException |
Set the display name.
Display name is used for displaying. This can be different from schema field's key name.
[in] | display_name | Display name string. This should not be an empty string. |
void com.foxit.sdk.pdf.SchemaField.setKeyName | ( | String | key_name | ) | throws com.foxit.sdk.PDFException |
Set the key name string.
Each schema field is stored by a unique key name. Schema field's key name can be used:
[in] | key_name | New key name string. This should not be an empty string. |
void com.foxit.sdk.pdf.SchemaField.setSubtypeName | ( | String | subtype_name | ) | throws com.foxit.sdk.PDFException |
Set the subtype name string.
Subtype name can be used to specify some properties of file node and folder node directly:
For other case, subtype name is used to specified the data type of an specified entry in file or folder node dictionary. The key for the entry is specified by current schema field's key name. and the data type is specified by:
[in] | subtype_name | Subtype name string. This should not be an empty string. Please refer to "Details" part for more information. |
void com.foxit.sdk.pdf.SchemaField.setVisibility | ( | boolean | is_visible | ) | throws com.foxit.sdk.PDFException |
Set the initial visibility of current field in application.
[in] | is_visible | true means current field is initially visible in application, while false means current field is initially invisible in application. |