de.intarsys.pdf.pd
Class PDAFChoiceField

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDAcroFormNode
              de.intarsys.pdf.pd.PDAcroFormField
                  de.intarsys.pdf.pd.PDAFChoiceField

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, IAttributeSupport

public class PDAFChoiceField
extends PDAcroFormField

A logical choice field within an AcroForm.

Nested Class Summary

static class

PDAFChoiceField.MetaClass

Field Summary

static COSName	DK_I
static COSName	DK_Opt
static COSName	DK_TI
static PDAFChoiceField.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDAcroFormField

ACROFORMFIELD_ACTION_TRIGGERS, ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, CN_FT_Btn, CN_FT_Ch, CN_FT_Sig, CN_FT_Tx, DK_DS, DK_DV, DK_Ff, DK_FT, DK_Kids, DK_MaxLen, DK_Parent, DK_RV, DK_T, DK_TM, DK_TU, DK_V

Fields inherited from class de.intarsys.pdf.pd.PDAcroFormNode

DK_DA, DK_DR, DK_Encoding, DK_Font, DK_Q

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Fields inherited from interface de.intarsys.pdf.pd.IAdditionalActionSupport

DK_AA

Method Summary

COSName	cosGetExpectedFieldType() The AcroForm field type expected for this.
List	getExportValues() A List containing the option export values as Strings.
List	getOptionNames() A List containing the option names as Strings.
List	getValueList() The value stored in this field as a List of String objects
void	invalidateCaches() Invalidate all local caches as the base object may have changed.
boolean	isCombo() Convenience method to access "Combo" flag.
boolean	isCommitOnSelChange() Convenience method to access "CommitOnSelChange" flag.
boolean	isEdit() Convenience method to access "Edit" flag.
boolean	isMultiSelect() Convenience method to access "MultiSelect" flag.
boolean	isTypeCh() Return true if this is a field of type "Ch".
void	setOptions(Map options) Assign the currently active options.
void	setOptions(String[] names, String[] values) Assign the currently active options.
void	setValueString(String value) Set the value of this.
void	setValueStrings(List values) Set the value of this to a List of String objects.

Methods inherited from class de.intarsys.pdf.pd.PDAcroFormField

addAnnotation, addField, basicGetFieldFlags, basicSetFieldFlags, copy, cosGetDefaultValue, cosGetFieldType, cosGetValue, cosSetValue, dispose, getAcroForm, getAdditionalActions, getAlternateFieldName, getAnyAnnotation, getDefaultValueString, getFieldFlags, getGenericChildren, getGenericParent, getKids, getLocalName, getLocalName, getLogicalParent, getLogicalRoot, getMaxLen, getParent, getQualifiedName, getQualifiedName, getSupportedTriggerEvents, getValueString, isAlignmentCenter, isAlignmentLeft, isAlignmentRight, isAnnotation, isComb, isDoNotScroll, isMultiline, isNoExport, isReadOnly, isTypeBtn, isTypeSig, isTypeTx, removeField, reset, setAdditionalActions, setAlignmentCenter, setAlignmentLeft, setAlignmentRight, setAlternateFieldName, setComb, setDefaultValue, setDoNotScroll, setLocalName, setMaxLength, setMultiline, setNoExport, setReadOnly, toString

Methods inherited from class de.intarsys.pdf.pd.PDAcroFormNode

canonicalize, collectLeafFields, getAnnotation, getAnnotations, getDefaultAppearanceContent, getDefaultAppearanceFont, getDefaultAppearanceFontColor, getDefaultAppearanceFontName, getDefaultAppearanceFontSize, getField, getField, getQuadding, setDefaultAppearanceContent, setDefaultAppearanceFont, setDefaultAppearanceFontColor, setDefaultAppearanceFontSize, setQuadding

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, setGenericParent

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DK_Opt

public static final COSName DK_Opt

DK_TI

public static final COSName DK_TI

DK_I

public static final COSName DK_I

META

public static final PDAFChoiceField.MetaClass META

The meta class instance

Method Detail

cosGetExpectedFieldType

public COSName cosGetExpectedFieldType()

Description copied from class: PDAcroFormField

The AcroForm field type expected for this.

Specified by:

cosGetExpectedFieldType in class PDAcroFormField

Returns:

The AcroForm field type expected for this.

getExportValues

public List getExportValues()

A List containing the option export values as Strings.

Returns:

a List containing the option export values as Strings. The result will never be null.

getOptionNames

public List getOptionNames()

A List containing the option names as Strings.

Returns:

a List containing the option names as Strings. The result will never be null.

getValueList

public List getValueList()

The value stored in this field as a List of String objects

Returns:

The value stored in this field as a List of String objects

invalidateCaches

public void invalidateCaches()

Description copied from class: COSBasedObject

Invalidate all local caches as the base object may have changed.

Overrides:

invalidateCaches in class PDAcroFormField

isCombo

public boolean isCombo()

Convenience method to access "Combo" flag.

isCommitOnSelChange

public boolean isCommitOnSelChange()

Convenience method to access "CommitOnSelChange" flag.

isEdit

public boolean isEdit()

Convenience method to access "Edit" flag.

isMultiSelect

public boolean isMultiSelect()

Convenience method to access "MultiSelect" flag.

isTypeCh

public boolean isTypeCh()

Description copied from class: PDAcroFormField

Return true if this is a field of type "Ch".

"Ch" means this is a choice object.

Overrides:

isTypeCh in class PDAcroFormField

Returns:

Return true if this is a field of type "Ch".

setOptions

public void setOptions(Map options)

Assign the currently active options.

Parameters:

options - A Map containing the new options.

setOptions

public void setOptions(String[] names,
                       String[] values)

Assign the currently active options.

Parameters:

names -

values -

setValueString

public void setValueString(String value)

Description copied from class: PDAcroFormField

Set the value of this.

Overrides:

setValueString in class PDAcroFormField

Parameters:

value - The new value of this, represented by a String.

setValueStrings

public void setValueStrings(List values)

Description copied from class: PDAcroFormField

Set the value of this to a List of String objects.

Overrides:

setValueStrings in class PDAcroFormField

Parameters:

values - The new value.