com.cete.dynamicpdf.pageelements.forms
Class CheckBox

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

public class CheckBox
extends FormElement

Represents the check box field of a interactive forms.

A check box toggles between two states, on and off.

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

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

Method Summary

void	draw(PageWriter writer) Draws the checkbox to the given PageWriter object.
java.lang.String	getExportValue() Gets the export value.
float	getFontSize() Gets the font size of the field.
Symbol	getSymbol() Gets the type of �check� to appear inside the checkbox.
boolean	isDefaultChecked() Gets the checkbox's default checked state.
boolean	isNoExport() Gets the export state for a field.
void	setDefaultChecked(boolean check) Sets the checkbox's default checked state.
void	setExportValue(java.lang.String exportValue) Sets the export value.
void	setFontSize(float fontSize) Sets the font size for the field.
void	setNoExport(boolean value) Sets the export state for a field.
void	setSymbol(Symbol symbol) Sets the type of �check� to appear inside 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

CheckBox

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

Creates a new instance of CheckBox class.

Parameters:

name - Name of a check box.

x - X coordinate of a check box.

y - Y coordinate of a check box.

width - Width of a check box.

height - Height of a check box.

Method Detail

setFontSize

public void setFontSize(float fontSize)

Sets the font size for the field.

Parameters:

fontSize - the font size for the field.

getFontSize

public float getFontSize()

Gets the font size of the field.

Returns:

float value the font size of the field

isDefaultChecked

public boolean isDefaultChecked()

Gets the checkbox's default checked state.

Returns:

boolean the default checked state of the checkbox.

setDefaultChecked

public void setDefaultChecked(boolean check)

Sets the checkbox's default checked state.

Parameters:

check - the checkbox's default checked state.

getExportValue

public java.lang.String getExportValue()

Gets the export value.

Returns:

string the export value.

setExportValue

public void setExportValue(java.lang.String exportValue)

Sets the export value.

Parameters:

exportValue - the export value.

getSymbol

public Symbol getSymbol()

Gets the type of �check� to appear inside the checkbox.

Returns:

Symbol the check to appear inside the checkbox.

setSymbol

public void setSymbol(Symbol symbol)

Sets the type of �check� to appear inside the checkbox.

Parameters:

symbol - the type of check to appear inside the checkbox.

isNoExport

public boolean isNoExport()

Gets the export state for a field.

Returns:

boolean the export state for a field.

setNoExport

public void setNoExport(boolean value)

Sets the export state for a field.

Parameters:

value - the export state for a field.

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

draw

public void draw(PageWriter writer)

Draws the checkbox to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Throws:

GeneratorException - If Form Field with the same name already exist.

Parameters:

writer - PageWriter object to receive the checkbox's output.

See Also:

PageWriter