de.intarsys.pdf.pd
Class PDAFButtonField

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.PDAFButtonField

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, de.intarsys.tools.attribute.IAttributeSupport

public class PDAFButtonField
extends PDAcroFormField

A logical button within an AcroForm.

Nested Class Summary

static class

PDAFButtonField.MetaClass

Field Summary

static COSName	DK_Opt
static PDAFButtonField.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.
COSArray	cosGetOptions()
COSObject	cosSetValue(COSObject state) Sets the /V entry in this node and removes all /V entries in child nodes.
Set	getAvailableButtonAppearanceStates() The Set of possible states the button can enter.
Set	getAvailableButtonAppearanceStatesNoOff() The Set of possible non - off states the button can enter.
boolean	isCheckbox() Return true when this is an object with checkbox behavior.
boolean	isChecked() true if this is checked.
boolean	isPushbutton() true if this is a pushbutton.
boolean	isRadio() true if this is a radio button.
boolean	isTypeBtn() Return true if this is a field of type "Btn".
void	reset() Reset this to its default value.
void	setPushbutton(boolean f) Make this a push button.
void	setValueString(String value) Set the value of this.

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

addAnnotation, addField, basicGetFieldFlags, basicSetFieldFlags, copy, cosGetDefaultValue, cosGetFieldType, cosGetValue, dispose, getAcroForm, getAdditionalActions, getAlternateFieldName, getAnyAnnotation, getDefaultValueString, getFieldFlags, getGenericChildren, getGenericParent, getKids, getLocalName, getLocalName, getLogicalParent, getLogicalRoot, getMaxLen, getParent, getQualifiedName, getQualifiedName, getSupportedTriggerEvents, getValueString, invalidateCaches, isAlignmentCenter, isAlignmentLeft, isAlignmentRight, isAnnotation, isComb, isDoNotScroll, isMultiline, isNoExport, isReadOnly, isTypeCh, isTypeSig, isTypeTx, removeField, setAdditionalActions, setAlignmentCenter, setAlignmentLeft, setAlignmentRight, setAlternateFieldName, setComb, setDefaultValue, setDoNotScroll, setLocalName, setMaxLength, setMultiline, setNoExport, setReadOnly, setValueStrings, 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

META

public static final PDAFButtonField.MetaClass META

The meta class instance

DK_Opt

public static final COSName DK_Opt

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.

cosGetOptions

public COSArray cosGetOptions()

cosSetValue

public COSObject cosSetValue(COSObject state)

Description copied from class: PDAcroFormField

Sets the /V entry in this node and removes all /V entries in child nodes.

Overrides:

cosSetValue in class PDAcroFormField

Returns:

The /V entry previously associated with this.

getAvailableButtonAppearanceStates

public Set getAvailableButtonAppearanceStates()

The Set of possible states the button can enter.

Returns:

The Set of possible states the button can enter.

getAvailableButtonAppearanceStatesNoOff

public Set getAvailableButtonAppearanceStatesNoOff()

The Set of possible non - off states the button can enter.

Returns:

The Set of possible non - off states the button can enter.

isCheckbox

public boolean isCheckbox()

Return true when this is an object with checkbox behavior.

Returns:

true when this is an object with checkbox behavior.

isChecked

public boolean isChecked()

true if this is checked.

Returns:

true if this is checked.

isPushbutton

public boolean isPushbutton()

true if this is a pushbutton.

Returns:

true if this is a pushbutton.

isRadio

public boolean isRadio()

true if this is a radio button.

Returns:

true if this is a radio button.

isTypeBtn

public boolean isTypeBtn()

Description copied from class: PDAcroFormField

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

"Btn" means this is a button style object.

Overrides:

isTypeBtn in class PDAcroFormField

Returns:

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

reset

public void reset()

Description copied from class: PDAcroFormField

Reset this to its default value.

Overrides:

reset in class PDAcroFormField

setPushbutton

public void setPushbutton(boolean f)

Make this a push button.

Parameters:

f -

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.