Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFOptionElement

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSArray, .COSBase, .COSString, org.apache.pdfbox.pdmodel.common.COSObjectable
This represents an object that can be used in a Field's Opt entry to represent an available option and a default appearance string.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSArray
option

Constructor Summary

AccessConstructor and Description
public
FDFOptionElement()

Default constructor.

public
FDFOptionElement(COSArray
The option element.
o)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSArray

Returns:

The cos object that matches this Java object.
getCOSArray()

Convert this standard java object to a COS object.

public COSBase

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public String

Returns:

A default appearance string.
getDefaultAppearanceString()

This will get the string of default appearance string.

public String

Returns:

An available option.
getOption()

This will get the string of one of the available options.

public void
setDefaultAppearanceString(String
The default appearance string.
da)

This will set the default appearance string.

public void
setOption(String
One of the available options.
opt)

This will set the string for an available option.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

optionback to summary
private final COSArray option

Constructor Detail

FDFOptionElementback to summary
public FDFOptionElement()

Default constructor.

FDFOptionElementback to summary
public FDFOptionElement(COSArray o)

Constructor.

Parameters
o:COSArray

The option element.

Method Detail

getCOSArrayback to summary
public COSArray getCOSArray()

Convert this standard java object to a COS object.

Returns:COSArray

The cos object that matches this Java object.

getCOSObjectback to summary
public COSBase getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSBase

The cos object that matches this Java object.

Annotations
@Override
getDefaultAppearanceStringback to summary
public String getDefaultAppearanceString()

This will get the string of default appearance string. A required element.

Returns:String

A default appearance string.

getOptionback to summary
public String getOption()

This will get the string of one of the available options. A required element.

Returns:String

An available option.

setDefaultAppearanceStringback to summary
public void setDefaultAppearanceString(String da)

This will set the default appearance string.

Parameters
da:String

The default appearance string.

setOptionback to summary
public void setOption(String opt)

This will set the string for an available option.

Parameters
opt:String

One of the available options.