com.cete.dynamicpdf.pageelements.forms
Class RadioButton

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.forms.FormElement
              com.cete.dynamicpdf.pageelements.forms.RadioButton

public class RadioButton
extends FormElement

Represents the radio button field of a interactive forms.

Radio buttons are a set of related toggles, at most one of which may be on at any given time; selecting any one of the buttons automatically deselects all the others.

NOTE: This page element cannot be used within a table cell, or tranformation group.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

RadioButton(java.lang.String name, float x, float y, float width, float height)
Creates a new instance of RadioButton class.

Method Summary

void	draw(PageWriter writer) Draws the radio button to the given PageWriter object.
java.lang.String	getExportValue() Gets the export value.
Symbol	getSymbol() Gets or Sets the type of �check� to appear in the checkbox.
boolean	isDefaultChecked() Gets the radio button default checked state.
boolean	isNoExport() Gets the export state for the field.
boolean	isRadiosInUnison() Gets the radio button's unsion state.
boolean	isRequired() Gets the value specifying the required state of the field.
void	setDefaultChecked(boolean value) Sets the radio button default checked state.
void	setExportValue(java.lang.String exportValue) Sets the export value.
void	setNoExport(boolean value) Sets the export state for the field.
void	setRadiosInUnison(boolean radiosInUnison) Sets the radio button's unsion state.
void	setRequired(boolean value) Sets the required state for the field.
void	setSymbol(Symbol value) Gets or Sets the type of �check� to appear in the checkbox.

Methods inherited from class com.cete.dynamicpdf.pageelements.forms.FormElement

getBackgroundColor, getBorderColor, getBorderStyle, getHeight, getMappingName, getName, getOutput, getReaderEvents, getRotate, getTextColor, getToolTip, getWidth, getX, getY, isPrintable, isReadOnly, isVisible, setBackgroundColor, setBorderColor, setBorderStyle, setHeight, setMappingName, setName, setOutput, setPrintable, setReadOnly, setRotate, setTag, setTextColor, setToolTip, setVisible, setWidth, setX, setY

Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement

getTag, getTagOrder, setTagOrder

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

RadioButton

public RadioButton(java.lang.String name,
                   float x,
                   float y,
                   float width,
                   float height)

Creates a new instance of RadioButton class.

Parameters:

name - Name of a radio button.

x - X coordinate of a radio button.

y - Y coordinate of a radio button.

width - Width of a radio button.

height - Height of a radio button.

Method Detail

isDefaultChecked

public boolean isDefaultChecked()

Gets the radio button default checked state.

Returns:

the radio button default checked state.

setDefaultChecked

public void setDefaultChecked(boolean value)

Sets the radio button default checked state.

Parameters:

value - the radio button default checked state.

getExportValue

public java.lang.String getExportValue()

Gets the export value.

Returns:

the export value.

setExportValue

public void setExportValue(java.lang.String exportValue)

Sets the export value. To create a set of mutually exclusive radio buttons (i.e., where only one can be selected at a time), give the fields the same name but different export values.

Parameters:

exportValue - the export value of the radio button.

isRequired

public boolean isRequired()

Gets the value specifying the required state of the field.

Returns:

the required state of the field.

setRequired

public void setRequired(boolean value)

Sets the required state for the field.

If set, the field must have a value at the time it is exported by a submit-form action.

Parameters:

value - the required state for the field.

isNoExport

public boolean isNoExport()

Gets the export state for the field.

Returns:

the export state for the field.

setNoExport

public void setNoExport(boolean value)

Sets the export state for the field.

If set, the field will not be exported by a submit-form action.

Parameters:

value - the export state for the field.

isRadiosInUnison

public boolean isRadiosInUnison()

Gets the radio button's unsion state.

Returns:

the radio button's unsion state.

getSymbol

public Symbol getSymbol()

Gets or Sets the type of �check� to appear in the checkbox.

Returns:

sysmbol of the button.

setSymbol

public void setSymbol(Symbol value)

Gets or Sets the type of �check� to appear in the checkbox.

Parameters:

value - symbol of the button.

setRadiosInUnison

public void setRadiosInUnison(boolean radiosInUnison)

Sets the radio button's unsion state. Buttons with the same name and value are selected in unison.

Parameters:

radiosInUnison - the radio button's unsion state.

draw

public void draw(PageWriter writer)

Draws the radio button to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Parameters:

writer - PageWriter object to receive the radio button's output.

See Also:

PageWriter