Overview  Package   Class  Tree  Deprecated  Index  Help 
DynamicPDF by ceTe Software
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.cete.dynamicpdf.pageelements.forms
Class FormElement

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.forms.FormElement
Direct Known Subclasses:
Button, CheckBox, ChoiceField, RadioButton, Signature, TextField
public abstract class FormElement
extends TaggablePageElement

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:

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.
 FormFieldOutput getOutput()
          Gets output options for the field.
 AnnotationReaderEvents getReaderEvents()
          Gets the reader events of the annotation.
 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 setOutput(FormFieldOutput value)
          sets output options for the 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 setTag(Tag tag)
          Sets the structure element of the form element.
 void setTextColor(DeviceColor textColor)
          Sets the color of the text for the field.
 void setToolTip(java.lang.String tooltip)
          Sets tool tip 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.pageelements.TaggablePageElement
draw, 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

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.

Returns:
the X coordinate of a form field.

setX

public void setX(float fltX)
Sets the X coordinate of a form field.

Parameters:
fltX - the X coordinate of a form field.

getY

public float getY()
Gets the Y coordinate of a form field.

Returns:
the Y coordinate of a form field.

setY

public void setY(float fltY)
Sets the Y coordinate of a form field.

Parameters:
fltY - the Y coordinate of a form field.

getWidth

public float getWidth()
Gets the width of a form field.

Returns:
the width of a form field.

setWidth

public void setWidth(float width)
Sets the width of a form field.

Parameters:
width - the width of a form field.

getHeight

public float getHeight()
Gets the height of a form field.

Returns:
the height of a form field.

setHeight

public void setHeight(float height)
Sets the height of a form field.

Parameters:
height - the height of a form field.

getRotate

public int getRotate()
Gets the angle of a form field.

Returns:
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.
Parameters:
rotate - the angle of a form field.

getName

public java.lang.String getName()
Gets the name of a form field.

Returns:
the name of a form field.

setName

public void setName(java.lang.String name)
Sets the name of a form field.

Parameters:
name - the name of a form field.

getToolTip

public java.lang.String getToolTip()
Gets an alternate field name, of a form field.

Returns:
the tool tip of a form field.

setToolTip

public void setToolTip(java.lang.String tooltip)
Sets tool tip of a form field.

Parameters:
tooltip - the tool tip of a form field.

getMappingName

public java.lang.String getMappingName()
Gets an mapping name, of a form field.

Returns:
the mapping name of a form field.

setMappingName

public void setMappingName(java.lang.String mapName)
Sets an mapping name, of the form field.

Parameters:
mapName - the mapping name, of a form field.

setTextColor

public void setTextColor(DeviceColor textColor)
Sets the color of the text for the field.

Parameters:
textColor - the color, of a form field.

getTextColor

public DeviceColor getTextColor()
Gets the color of the text of the field.

Returns:
the color of the text of the field.

isReadOnly

public boolean isReadOnly()
Gets the read only property status of the form field.

Returns:
the read only property status of the form field.

setReadOnly

public void setReadOnly(boolean value)
Sets the read only property of the form field.

Parameters:
value - the read only property of the form field.

getBorderStyle

public BorderStyle getBorderStyle()
Gets the BorderStyle.

Returns:
the border style of the field.

setBorderStyle

public void setBorderStyle(BorderStyle borderStyle)
Sets the BorderStyle

Parameters:
borderStyle - the border style of the field.
See Also:
BorderStyle

setBorderColor

public void setBorderColor(DeviceColor borderColor)
Sets the border color of a form field.

Parameters:
borderColor - the border style of the field.

getBorderColor

public DeviceColor getBorderColor()
Gets the border color of a form field.

Returns:
the border color of a form field.

setBackgroundColor

public void setBackgroundColor(RgbColor bgColor)
Sets the fill/background color of a form field.

Parameters:
bgColor - fill/background the border style of the field.

getBackgroundColor

public RgbColor getBackgroundColor()
Gets the fill/background color of a form field.

Returns:
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.

Parameters:
visible - the form field visible property.

isVisible

public boolean isVisible()
Gets the form field visible status.

Returns:
the form field visible status.

setPrintable

public void setPrintable(boolean printable)
Sets the form field printable on pdf. By default its true.

Parameters:
printable - the form field printable status.

isPrintable

public boolean isPrintable()
Gets the form field printable status.

Returns:
the form field printable status.

getReaderEvents

public AnnotationReaderEvents getReaderEvents()
Gets the reader events of the annotation.

Returns:
the reader events of the annotation.

setTag

public void setTag(Tag tag)
Sets the structure element of the form element.

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

Overrides:
setTag in class TaggablePageElement
Parameters:
tag - a structure element for taggable form element.

getOutput

public FormFieldOutput getOutput()
Gets output options for the field.

setOutput

public void setOutput(FormFieldOutput value)
sets output options for the field.

Overview  Package   Class  Tree  Deprecated  Index  Help 
DynamicPDF by ceTe Software
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
API Reference for DynamicPDF v10.04 for Java generated on September 25, 2019
© Copyright 2019, ceTe Software