org.pdfbox.pdmodel.fdf

Class FDFOptionElement

Implemented Interfaces:
COSObjectable

public class FDFOptionElement
extends java.lang.Object
implements 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.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield

Constructor Summary

FDFOptionElement()
Default constructor.
FDFOptionElement(COSArray o)
Constructor.

Method Summary

COSArray
getCOSArray()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
String
getDefaultAppearanceString()
This will get the string of default appearance string.
String
getOption()
This will get the string of one of the available options.
void
setDefaultAppearanceString(String da)
This will set the default appearance string.
void
setOption(String opt)
This will set the string for an available option.

Constructor Details

FDFOptionElement

public FDFOptionElement()
Default constructor.

FDFOptionElement

public FDFOptionElement(COSArray o)
Constructor.
Parameters:
o - The option element.

Method Details

getCOSArray

public COSArray getCOSArray()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getDefaultAppearanceString

public String getDefaultAppearanceString()
This will get the string of default appearance string. A required element.
Returns:
A default appearance string.

getOption

public String getOption()
This will get the string of one of the available options. A required element.
Returns:
An available option.

setDefaultAppearanceString

public void setDefaultAppearanceString(String da)
This will set the default appearance string.
Parameters:
da - The default appearance string.

setOption

public void setOption(String opt)
This will set the string for an available option.
Parameters:
opt - One of the available options.