org.icepdf.core.pobjects.acroform

Class ButtonFieldDictionary

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.acroform.FieldDictionary

org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

org.icepdf.core.pobjects.acroform.ButtonFieldDictionary

public class ButtonFieldDictionary
extends VariableTextFieldDictionary

The ButtonFieldDictionary contains all the dictionary entries specific to the button widget.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ButtonFieldDictionary.ButtonFieldType

Nested classes/interfaces inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

VariableTextFieldDictionary.Quadding

Field Summary

Fields

Modifier and Type	Field and Description
protected ButtonFieldDictionary.ButtonFieldType	buttonFieldType
static int	NO_TOGGLE_TO_OFF_BIT_FLAG (Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect.
static int	PUSH_BUTTON_BIT_FLAG If set, the field is a push button that does not retain a permanent value.
static int	RADIO_BIT_FLAG If set, the field is a set of radio buttons; if clear, the field is a check box.
static int	RADIO_IN_UNISON_BIT_FLAG (PDF 1.5) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.

Fields inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

color, DA_KEY, DS_KEY, fontName, Q_KEY, quadding, RV_KEY, size

Fields inherited from class org.icepdf.core.pobjects.acroform.FieldDictionary

AA_KEY, additionalActionsDictionary, alternativeFieldName, defaultFieldValue, DV_KEY, exportMappingName, Ff_KEY, fieldType, fieldValue, FT_KEY, kids, KIDS_KEY, NO_EXPORT_BIT_FLAG, PARENT_KEY, parentField, partialFieldName, READ_ONLY_BIT_FLAG, REQUIRED_BIT_FLAG, T_KEY, TM_KEY, TU_KEY, V_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
ButtonFieldDictionary(Library library, java.util.HashMap entries)

Method Summary

Modifier and Type	Method and Description
ButtonFieldDictionary.ButtonFieldType	getButtonFieldType()
boolean	isNoToggleToOff() (Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect.
boolean	isPushButton() If set, the field is a push button that does not retain a permanent value.
boolean	isRadioButton() If set, the field is a set of radio buttons; if clear, the field is a check box.
boolean	isRadioInUnison() If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.
void	setButtonFieldType(ButtonFieldDictionary.ButtonFieldType buttonFieldType)

Methods inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

getColor, getDefaultAppearance, getDefaultRichText, getDefaultStyle, getFontName, getQuadding, getSize, setFontName, setSize

Methods inherited from class org.icepdf.core.pobjects.acroform.FieldDictionary

getAdditionalActionsDictionary, getAlternativeFieldName, getDefaultFieldValue, getExportMappingName, getFieldType, getFieldValue, getFlags, getFullyQualifiedFieldName, getKids, getParent, getPartialFieldName, hasDefaultValue, hasFieldValue, isNoExport, isReadOnly, isRequired, setFieldValue

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_TOGGLE_TO_OFF_BIT_FLAG

public static final int NO_TOGGLE_TO_OFF_BIT_FLAG

(Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

See Also:

Constant Field Values

RADIO_BIT_FLAG

public static final int RADIO_BIT_FLAG

If set, the field is a set of radio buttons; if clear, the field is a check box. This flag may be set only if the Push button flag is clear.

See Also:

Constant Field Values

PUSH_BUTTON_BIT_FLAG

public static final int PUSH_BUTTON_BIT_FLAG

If set, the field is a push button that does not retain a permanent value.

See Also:

Constant Field Values

RADIO_IN_UNISON_BIT_FLAG

public static final int RADIO_IN_UNISON_BIT_FLAG

(PDF 1.5) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

See Also:

Constant Field Values

buttonFieldType

protected ButtonFieldDictionary.ButtonFieldType buttonFieldType

Constructor Detail

ButtonFieldDictionary

public ButtonFieldDictionary(Library library,
                             java.util.HashMap entries)

Method Detail

isNoToggleToOff

public boolean isNoToggleToOff()

(Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

Returns:

true if only one button state should be selected at all times.

isRadioButton

public boolean isRadioButton()

If set, the field is a set of radio buttons; if clear, the field is a check box. This flag may be set only if the Push button flag is clear.

Returns:

true if button field is of type push button.

isPushButton

public boolean isPushButton()

If set, the field is a push button that does not retain a permanent value.

Returns:

true if button field is of type push button.

isRadioInUnison

public boolean isRadioInUnison()

If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are

Returns:

true if radio buttons in unison; otherwise false.

getButtonFieldType

public ButtonFieldDictionary.ButtonFieldType getButtonFieldType()

setButtonFieldType

public void setButtonFieldType(ButtonFieldDictionary.ButtonFieldType buttonFieldType)