com.cete.dynamicpdf.pageelements.forms
Class FormElement

java.lang.Object
  |
  +--com.cete.dynamicpdf.PageElement
        |
        +--com.cete.dynamicpdf.pageelements.forms.FormElement

Direct Known Subclasses:

Button, CheckBox, ListBoxField, RadioButton, TextField

public abstract class FormElement

extends PageElement

Class represents the base class for all the form field page elements.

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

Constructor Summary

protected

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

Method Summary

RgbColor	getBackgroundColor() Gets the fill/background color of a form field.
DeviceColor	getBorderColor() Gets the border color of a form field.
BorderStyle	getBorderStyle() Gets the BorderStyle.
float	getHeight() Gets the height of a form field.
java.lang.String	getMappingName() Gets an mapping name, of a form field.
java.lang.String	getName() Gets the name of a form field.
int	getRotate() Gets the angle of a form field.
DeviceColor	getTextColor() Gets the color of the text of the field.
java.lang.String	getToolTip() Gets an alternate field name, of a form field.
float	getWidth() Gets the width of a form field.
float	getX() Gets the X coordinate of a form field.
float	getY() Gets the Y coordinate of a form field.
boolean	isPrintable() Gets the form field printable status.
boolean	isReadOnly() Gets the read only property status of the form field.
boolean	isVisible() Gets the form field visible status.
void	setBackgroundColor(RgbColor bgColor) Sets the fill/background color of a form field.
void	setBorderColor(DeviceColor borderColor) Sets the border color of a form field.
void	setBorderStyle(BorderStyle borderStyle) Sets the BorderStyle
void	setHeight(float height) Sets the height of a form field.
void	setMappingName(java.lang.String mapName) Sets an mapping name, of the form field.
void	setName(java.lang.String name) Sets the name of a form field.
void	setPrintable(boolean printable) Sets the form field printable on pdf.
void	setReadOnly(boolean value) Sets the read only property of the form field.
void	setRotate(int rotate) Sets the angle of a form field.
void	setTextColor(DeviceColor textColor) Sets the color of the text for the field.
void	setToolTip(java.lang.String tooltip) Sets an alternate field name, of a form field.
void	setVisible(boolean visible) Sets the form field visible on pdf.
void	setWidth(float width) Sets the width of a form field.
void	setX(float fltX) Sets the X coordinate of a form field.
void	setY(float fltY) Sets the Y coordinate of a form field.

Methods inherited from class com.cete.dynamicpdf.PageElement

draw, getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

FormElement

protected FormElement(java.lang.String name,
                      float x,
                      float y,
                      float width,
                      float height)

Creates a new instance of FormElement.

Parameters:

name - Name of a form field.

x - X coordinate of a form field.

y - Y coordinate of a form field.

width - Width of a form field.

height - Height of a form field.

Method Detail

getX

public float getX()

Gets the X coordinate of a form field.

setX

public void setX(float fltX)

Sets the X coordinate of a form field.

getY

public float getY()

Gets the Y coordinate of a form field.

setY

public void setY(float fltY)

Sets the Y coordinate of a form field.

getWidth

public float getWidth()

Gets the width of a form field.

setWidth

public void setWidth(float width)

Sets the width of a form field.

getHeight

public float getHeight()

Gets the height of a form field.

setHeight

public void setHeight(float height)

Sets the height of a form field.

getRotate

public int getRotate()

Gets the angle of a form field.

setRotate

public void setRotate(int rotate)

Sets the angle of a form field. Default is 0, effective entries are 90, 180 and 270.

Throws:

GeneratorException - If angle is not multiple of 90.

getName

public java.lang.String getName()

Gets the name of a form field.

setName

public void setName(java.lang.String name)

Sets the name of a form field.

getToolTip

public java.lang.String getToolTip()

Gets an alternate field name, of a form field.

setToolTip

public void setToolTip(java.lang.String tooltip)

Sets an alternate field name, of a form field.

getMappingName

public java.lang.String getMappingName()

Gets an mapping name, of a form field.

setMappingName

public void setMappingName(java.lang.String mapName)

Sets an mapping name, of the form field.

setTextColor

public void setTextColor(DeviceColor textColor)

Sets the color of the text for the field.

getTextColor

public DeviceColor getTextColor()

Gets the color of the text of the field.

isReadOnly

public boolean isReadOnly()

Gets the read only property status of the form field.

setReadOnly

public void setReadOnly(boolean value)

Sets the read only property of the form field.

getBorderStyle

public BorderStyle getBorderStyle()

Gets the BorderStyle.

setBorderStyle

public void setBorderStyle(BorderStyle borderStyle)

Sets the BorderStyle

See Also:

BorderStyle

setBorderColor

public void setBorderColor(DeviceColor borderColor)

Sets the border color of a form field.

getBorderColor

public DeviceColor getBorderColor()

Gets the border color of a form field.

setBackgroundColor

public void setBackgroundColor(RgbColor bgColor)

Sets the fill/background color of a form field.

getBackgroundColor

public RgbColor getBackgroundColor()

Gets the fill/background color of a form field.

setVisible

public void setVisible(boolean visible)

Sets the form field visible on pdf. By default its true.

isVisible

public boolean isVisible()

Gets the form field visible status.

setPrintable

public void setPrintable(boolean printable)

Sets the form field printable on pdf. By default its true.

isPrintable

public boolean isPrintable()

Gets the form field printable status.