FormFieldFacade

Inheritance: java.lang.Object

public final class FormFieldFacade

Class for representing field properties.

Constructors

Constructor	Description
FormFieldFacade()

Fields

Field	Description
BORDER_WIDTH_UNDIFIED	Undefined border width.
BORDER_WIDTH_UNDEFINED	Undefined border width.
BORDER_WIDTH_THIN	Defines a thin border width.
BORDER_WIDTH_MEDIUM	Defines a medium border width.
BORDER_WIDTH_THICK	Defines a thick border width.
BORDER_STYLE_SOLID	Defines a solid border style.
BORDER_STYLE_DASHED	Defines a dashed border style.
BORDER_STYLE_BEVELED	Defines a beveled border style.
BORDER_STYLE_INSET	Defines an inseted border style.
BORDER_STYLE_UNDERLINE	Defines an underlined border style.
BORDER_STYLE_UNDEFINED	Undefined border style.
ALIGN_LEFT	Defines aglignment to left style.
ALIGN_CENTER	Defines aglignment to center style.
ALIGN_RIGHT	Defines aglignment to right style.
ALIGN_UNDEFINED	Undefined aglignment style.
ALIGN_JUSTIFIED	Defines text justification alignment style.
ALIGN_TOP	Defines vertical aglignment as top style.
ALIGN_MIDDLE	Defines vertical aglignment as middle style.
ALIGN_BOTTOM	Defines vertical aglignment as bottom style.
CHECK_BOX_STYLE_CIRCLE	Defines a circle check box style.
CHECK_BOX_STYLE_CHECK	Defines the shape of a check box field when it checked.
CHECK_BOX_STYLE_CROSS	Defines a cross check box style.
CHECK_BOX_STYLE_DIAMOND	Defines a diamond check box style.
CHECK_BOX_STYLE_STAR	Defines a star check box style.
CHECK_BOX_STYLE_SQUARE	Defines a square check box style.
CHECK_BOX_STYLE_UNDEFINED	Defines an undefined check box style.

Methods

Method	Description
getBorderColor()	Gets color of a field border.
setBorderColor(Color value)	Sets color of a field border.
getBorderStyle()	Gets style of a field border.
setBorderStyle(int value)	Sets style of a field border.
getBorderWidth()	Get width of a field border.
setBorderWidth(float value)	Set width of a field border.
getFont()	Gets the font style type of a field text.
setFont(FontStyle value)	Sets the font style type of a field text.
getCustomFont()	Gets the name of the font when this is non-standart (other then 14 standard fonts).
setCustomFont(String value)	Sets the name of the font when this is non-standart (other then 14 standard fonts).
getFontSize()	Gets the size of a field text.
setFontSize(float value)	Sets the size of a field text.
getTextColor()	Get the color of the field text.
setTextColor(Color value)	Set the color of the field text.
getTextEncoding()	Get the text encoding type of the field text.
setTextEncoding(int value)	Set the EncodingType text encoding type of the field text.
getAlignment()	Get the alignment of a field text, default is left alignment.
setAlignment(int value)	Set the alignment of a field text, default is left alignment.
getRotation()	Get the rotation of a field text.
setRotation(int value)	Set the rotation of a field text.
getCaption()	Get the normal caption of form field.
setCaption(String value)	Set the normal caption of form field.
getButtonStyle()	Get the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
setButtonStyle(int value)	Set the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
getBox()	Get a rectangle object holding field’s location.
setBox(Rectangle value)	Set a rectangle object holding field’s location.
getPosition()	Get a rectangle object holding field’s location.
setPosition(float[] value)	Set a rectangle object holding field’s location.
getPageNumber()	Get an integer value holding the number of page on which field locates.
setPageNumber(int value)	Set an integer value holding the number of page on which field locates.
getItems()	Get an array of string, each representing an option of a combo box/list/radio box field.
setItems(String[] value)	Set an array of string, each representing an option of a combo box/list/radio box field.
getExportItems()	Get the options for adding a list/combo/radio box
setExportItems(String[][] value)	Set the options for adding a list/combo/radio box
getBackgroundColor()	Get the color of a field background, default is white.
setBackgroundColor(Color value)	Set the color of a field background, default is white.
reset()	Reset all visual attribtues to empty value.
getBackgroudColor()	Obsolete property.
setBackgroudColor(Color value)	Obsolete property.

FormFieldFacade()

public FormFieldFacade()

BORDER_WIDTH_UNDIFIED

public static final float BORDER_WIDTH_UNDIFIED

Undefined border width.

BORDER_WIDTH_UNDEFINED

public static final float BORDER_WIDTH_UNDEFINED

Undefined border width.

BORDER_WIDTH_THIN

public static final float BORDER_WIDTH_THIN

Defines a thin border width.

BORDER_WIDTH_MEDIUM

public static final float BORDER_WIDTH_MEDIUM

Defines a medium border width.

BORDER_WIDTH_THICK

public static final float BORDER_WIDTH_THICK

Defines a thick border width.

BORDER_STYLE_SOLID

public static final int BORDER_STYLE_SOLID

Defines a solid border style.

BORDER_STYLE_DASHED

public static final int BORDER_STYLE_DASHED

Defines a dashed border style.

BORDER_STYLE_BEVELED

public static final int BORDER_STYLE_BEVELED

Defines a beveled border style.

BORDER_STYLE_INSET

public static final int BORDER_STYLE_INSET

Defines an inseted border style.

BORDER_STYLE_UNDERLINE

public static final int BORDER_STYLE_UNDERLINE

Defines an underlined border style.

BORDER_STYLE_UNDEFINED

public static final int BORDER_STYLE_UNDEFINED

Undefined border style.

ALIGN_LEFT

public static final int ALIGN_LEFT

Defines aglignment to left style.

ALIGN_CENTER

public static final int ALIGN_CENTER

Defines aglignment to center style.

ALIGN_RIGHT

public static final int ALIGN_RIGHT

Defines aglignment to right style.

ALIGN_UNDEFINED

public static final int ALIGN_UNDEFINED

Undefined aglignment style.

ALIGN_JUSTIFIED

public static final int ALIGN_JUSTIFIED

Defines text justification alignment style.

ALIGN_TOP

public static final int ALIGN_TOP

Defines vertical aglignment as top style.

ALIGN_MIDDLE

public static final int ALIGN_MIDDLE

Defines vertical aglignment as middle style.

ALIGN_BOTTOM

public static final int ALIGN_BOTTOM

Defines vertical aglignment as bottom style.

CHECK_BOX_STYLE_CIRCLE

public static final int CHECK_BOX_STYLE_CIRCLE

Defines a circle check box style.

CHECK_BOX_STYLE_CHECK

public static final int CHECK_BOX_STYLE_CHECK

Defines the shape of a check box field when it checked.

CHECK_BOX_STYLE_CROSS

public static final int CHECK_BOX_STYLE_CROSS

Defines a cross check box style.

CHECK_BOX_STYLE_DIAMOND

public static final int CHECK_BOX_STYLE_DIAMOND

Defines a diamond check box style.

CHECK_BOX_STYLE_STAR

public static final int CHECK_BOX_STYLE_STAR

Defines a star check box style.

CHECK_BOX_STYLE_SQUARE

public static final int CHECK_BOX_STYLE_SQUARE

Defines a square check box style.

CHECK_BOX_STYLE_UNDEFINED

public static final int CHECK_BOX_STYLE_UNDEFINED

Defines an undefined check box style.

getBorderColor()

public Color getBorderColor()

Gets color of a field border.

Returns: Color - color of a field border.

setBorderColor(Color value)

public void setBorderColor(Color value)

Sets color of a field border.

Parameters:

Parameter	Type	Description
value	java.awt.Color	color of a field border.

getBorderStyle()

public int getBorderStyle()

Gets style of a field border.

Returns: int - style of a field border.

setBorderStyle(int value)

public void setBorderStyle(int value)

Sets style of a field border.

Parameters:

Parameter	Type	Description
value	int	style of a field border.

getBorderWidth()

public float getBorderWidth()

Get width of a field border.

Returns: float - width of a field border.

setBorderWidth(float value)

public void setBorderWidth(float value)

Set width of a field border.

Parameters:

Parameter	Type	Description
value	float	width of a field border.

getFont()

public FontStyle getFont()

Gets the font style type of a field text.

Returns: FontStyle - FontStyle element

setFont(FontStyle value)

public void setFont(FontStyle value)

Sets the font style type of a field text.

Parameters:

Parameter	Type	Description
value	FontStyle	FontStyle

getCustomFont()

public String getCustomFont()

Gets the name of the font when this is non-standart (other then 14 standard fonts).

Returns: java.lang.String - String value

setCustomFont(String value)

public void setCustomFont(String value)

Sets the name of the font when this is non-standart (other then 14 standard fonts).

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

getFontSize()

public float getFontSize()

Gets the size of a field text.

Returns: float - float value

setFontSize(float value)

public void setFontSize(float value)

Sets the size of a field text.

Parameters:

Parameter	Type	Description
value	float	float value

getTextColor()

public Color getTextColor()

Get the color of the field text.

Returns: Color - Color element

setTextColor(Color value)

public void setTextColor(Color value)

Set the color of the field text.

Parameters:

Parameter	Type	Description
value	java.awt.Color	Color element

getTextEncoding()

public int getTextEncoding()

Get the text encoding type of the field text.

Returns: int - EncodingType element

setTextEncoding(int value)

public void setTextEncoding(int value)

Set the EncodingType text encoding type of the field text.

Parameters:

Parameter	Type	Description
value	int	EncodingType element

getAlignment()

public int getAlignment()

Get the alignment of a field text, default is left alignment.

Returns: int - int value

setAlignment(int value)

public void setAlignment(int value)

Set the alignment of a field text, default is left alignment.

Parameters:

Parameter	Type	Description
value	int	int value

getRotation()

public int getRotation()

Get the rotation of a field text.

Returns: int - int value

setRotation(int value)

public void setRotation(int value)

Set the rotation of a field text.

Parameters:

Parameter	Type	Description
value	int	int value

getCaption()

public String getCaption()

Get the normal caption of form field.

Returns: java.lang.String - String value

setCaption(String value)

public void setCaption(String value)

Set the normal caption of form field.

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

getButtonStyle()

public int getButtonStyle()

Get the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.

Returns: int - int value

setButtonStyle(int value)

public void setButtonStyle(int value)

Set the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.

Parameters:

Parameter	Type	Description
value	int	int value

getBox()

public Rectangle getBox()

Get a rectangle object holding field’s location.

Returns: Rectangle - Rectangle element

setBox(Rectangle value)

public void setBox(Rectangle value)

Set a rectangle object holding field’s location.

Parameters:

Parameter	Type	Description
value	java.awt.Rectangle	Rectangle element

getPosition()

public float[] getPosition()

Get a rectangle object holding field’s location.

Returns: float[] - array of float value

setPosition(float[] value)

public void setPosition(float[] value)

Set a rectangle object holding field’s location.

Parameters:

Parameter	Type	Description
value	float[]	array of float value

getPageNumber()

public int getPageNumber()

Get an integer value holding the number of page on which field locates.

Returns: int - int value

setPageNumber(int value)

public void setPageNumber(int value)

Set an integer value holding the number of page on which field locates.

Parameters:

Parameter	Type	Description
value	int	int value

getItems()

public String[] getItems()

Get an array of string, each representing an option of a combo box/list/radio box field.

Returns: java.lang.String[] - array of String value

setItems(String[] value)

public void setItems(String[] value)

Set an array of string, each representing an option of a combo box/list/radio box field.

Parameters:

Parameter	Type	Description
value	java.lang.String[]	array of String value

getExportItems()

public String[][] getExportItems()

Get the options for adding a list/combo/radio box

Returns: java.lang.String[][] - array of String value

setExportItems(String[][] value)

public void setExportItems(String[][] value)

Set the options for adding a list/combo/radio box

Parameters:

Parameter	Type	Description
value	java.lang.String[][]	array of String value

getBackgroundColor()

public Color getBackgroundColor()

Get the color of a field background, default is white.

Returns: Color - Color element

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Set the color of a field background, default is white.

Parameters:

Parameter	Type	Description
value	java.awt.Color	Color element

reset()

public void reset()

Reset all visual attribtues to empty value.

getBackgroudColor()

public Color getBackgroudColor()

Obsolete property. Use BackgroundColor. This method is Deprecated.

Returns: Color - background color

setBackgroudColor(Color value)

public void setBackgroudColor(Color value)

Obsolete property. Use BackgroundColor. This method is Deprecated.

Parameters:

Parameter	Type	Description
value	java.awt.Color	background color