Reference > Classes

FormField¶

Definition¶

1	`FormField var = .... ;`

Extends¶

Extended By¶

Description¶

Represents a field within a FormPanel.

Method Summary¶

Owner	Name	Return Type	Description
FormField	exportConfig()	Map	Exports this field's configuration to a map.
FormField	focus()	Boolean	Requests user input be focused on this field, will make panel visible if necessary. Returns false if this field can not be focused. Note that the focus is not immediate, meaning a call to isFocused() directly after calling focus may still return false
DashboardResource	getCallback(callbackName)	Callback	Returns a callback by name
DashboardResource	getCallbacks()	Map	Returns a map of all callback definitions.
DashboardResource	getChildren()	List	Returns a list of the child dashboard resources.
Object	getClassName()	String	Returns the string name of this object's class type.
FormField	getCssClass()	String	Returns the CSS class.
DashboardResource	getDRI()	String	Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
DashboardResource	getDashboardResourceType()	String	Returns the Dashboard Resource Type as a string
FormField	getDisabled()	Boolean	Returns true if field is disabled, false otherwise.
FormField	getDisplayMode()	String	DEPRECATED, use isVisible instead. Returns display type of field. Will return "ABSOLUTE" if field is displayed using absolute positioning. Will return "HTML" if field is displayed using form HTML.
FormField	getFieldValue(varName)	Object	Returns the value of the field with the associated varName for the form that owns this field.
DashboardResource	getFormula(formulaName)	Formula	Returns a Formula given the formula name.
DashboardResource	getFormulaNames()	Set	Returns a set of the names of all formulas for this object.
DashboardResource	getFormulas()	Map	Returns a map of all available formulas for this object. The key is the formula name.
DashboardResource	getLRI()	String	Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
FormField	getLabel()	String	Returns the label associated with this field.
FormField	getLabelTooltip()	String	Returns the tooltip associated with this field's label.
DashboardResource	getOwner()	DashboardResource	Returns the DashboardResource that owns this object.
FormField	getPanel()	FormPanel	Returns the panel that contains this field.
FormField	getPosition()	Rectangle	Returns a Rectangle object representing the field's position as (x,y,w,h).
FormField	getStyleSet()	StyleSet	Returns the StyleSet for this form field.
FormField	getValue()	Object	Returns the value associated with this field.
FormField	getVariableName()	String	Returns the variable name associated with this field.
DashboardResource	invokeCallback(callbackName, args)	Object	Executes the specified callback definition and returns the result from the callback.
FormField	isAtDefaultPosition()	Boolean	Returns whether field is at the default position specified in field editor.
FormField	isFocused()	Boolean	Returns true if this field has focus, false otherwise.
FormField	isTransient()	Boolean	Returns whether a field is transient.
FormField	isVisible()	Boolean	Returns true if this field is visible, false otherwise.
FormField	resetCssClass()	Boolean	Resets CSS class to default (as configured in AMI editor).
FormField	resetDisabled()	Boolean	Resets the disabled flag to default (as configured in AMI editor).
FormField	resetPosition()	Boolean	Resets field position to default position specified in field editor.
FormField	setCssClass(cssStyle)	Boolean	Sets CSS class. Returns empty string for no css.
FormField	setDisabled(disabled)	Boolean	Set the disabled status of the field (true for disabling, false for enabling).
FormField	setDisplayMode(mode)	Boolean	DEPRECATED, use setVisible instead. Sets display mode of field. Setting to "ABSOLUTE" will display field using absolute positioning. Setting to "HTML" will allow field to be displayed using the form HTML. Any other input will throw an exception.
FormField	setFieldValue(key, value)	Boolean	Sets the key value pair to this portlet's attributes and returns true if successful. For key, put in the field's variable name, then set the value.
FormField	setLabelTooltip(tooltip)	Boolean	Sets the label tooltip.
FormField	setPosition(x, y, w, h)	Boolean	Sets the field position. Specify (x,y) position, width, and height in pixels. Passing null to an argument is equivalent to not setting a value for that specific argument.
FormField	setPosition(rect)	Boolean	Sets the position, if the position is null then resets the overrides
FormField	setValue(value)	Boolean	Set this field's value. This is a generic set method that is available for every field in AMI. For FormRangeSlider and FormImage field, it is advisable to use their own setValue() method.
FormField	setVisible(visible)	Boolean	Sets the visibility of this field. Returns false iff the argument is null, true otherwise.
Object	toJson()	String	Returns a json representation of this object.

Method Definitions¶

exportConfig()¶

Map FormField::exportConfig()

Description¶

Exports this field's configuration to a map.

focus()¶

Boolean FormField::focus()

Description¶

Requests user input be focused on this field, will make panel visible if necessary. Returns false if this field can not be focused. Note that the focus is not immediate, meaning a call to isFocused() directly after calling focus may still return false

getCssClass()¶

String FormField::getCssClass()

Description¶

Returns the CSS class.

getDisabled()¶

Boolean FormField::getDisabled()

Description¶

Returns true if field is disabled, false otherwise.

getDisplayMode()¶

String FormField::getDisplayMode()

Description¶

DEPRECATED, use isVisible instead. Returns display type of field. Will return "ABSOLUTE" if field is displayed using absolute positioning. Will return "HTML" if field is displayed using form HTML.

getFieldValue(varName)¶

Object FormField::getFieldValue(String varName)

Description¶

Returns the value of the field with the associated varName for the form that owns this field.

Parameter Definition¶

Name	Type	Description
varName	String	fieldVarName

getLabel()¶

String FormField::getLabel()

Description¶

Returns the label associated with this field.

getLabelTooltip()¶

String FormField::getLabelTooltip()

Description¶

Returns the tooltip associated with this field's label.

getPanel()¶

FormPanel FormField::getPanel()

Description¶

Returns the panel that contains this field.

getPosition()¶

Rectangle FormField::getPosition()

Description¶

Returns a Rectangle object representing the field's position as (x,y,w,h).

getStyleSet()¶

StyleSet FormField::getStyleSet()

Description¶

Returns the StyleSet for this form field.

getValue()¶

Object FormField::getValue()

Description¶

Returns the value associated with this field.

getVariableName()¶

String FormField::getVariableName()

Description¶

Returns the variable name associated with this field.

isAtDefaultPosition()¶

Boolean FormField::isAtDefaultPosition()

Description¶

Returns whether field is at the default position specified in field editor.

isFocused()¶

Boolean FormField::isFocused()

Description¶

Returns true if this field has focus, false otherwise.

isTransient()¶

Boolean FormField::isTransient()

Description¶

Returns whether a field is transient.

isVisible()¶

Boolean FormField::isVisible()

Description¶

Returns true if this field is visible, false otherwise.

resetCssClass()¶

Boolean FormField::resetCssClass()

Description¶

Resets CSS class to default (as configured in AMI editor).

resetDisabled()¶

Boolean FormField::resetDisabled()

Description¶

Resets the disabled flag to default (as configured in AMI editor).

resetPosition()¶

Boolean FormField::resetPosition()

Description¶

Resets field position to default position specified in field editor.

setCssClass(cssStyle)¶

Boolean FormField::setCssClass(String cssStyle)

Description¶

Sets CSS class. Returns empty string for no css.

Parameter Definition¶

Name	Type	Description
cssStyle	String

setDisabled(disabled)¶

Boolean FormField::setDisabled(Boolean disabled)

Description¶

Set the disabled status of the field (true for disabling, false for enabling).

Parameter Definition¶

Name	Type	Description
disabled	Boolean	true to disable, false to enable

setDisplayMode(mode)¶

Boolean FormField::setDisplayMode(String mode)

Description¶

DEPRECATED, use setVisible instead. Sets display mode of field. Setting to "ABSOLUTE" will display field using absolute positioning. Setting to "HTML" will allow field to be displayed using the form HTML. Any other input will throw an exception.

Parameter Definition¶

Name	Type	Description
mode	String	Display mode

setFieldValue(key,value)¶

Boolean FormField::setFieldValue(String key, Object value)

Description¶

Sets the key value pair to this portlet's attributes and returns true if successful. For key, put in the field's variable name, then set the value.

Parameter Definition¶

Name	Type	Description
key	String
value	Object

setLabelTooltip(tooltip)¶

Boolean FormField::setLabelTooltip(String tooltip)

Description¶

Sets the label tooltip.

Parameter Definition¶

Name	Type	Description
tooltip	String

setPosition(x,y,w,h)¶

Boolean FormField::setPosition(Integer x, Integer y, Integer w, Integer h)

Description¶

Sets the field position. Specify (x,y) position, width, and height in pixels. Passing null to an argument is equivalent to not setting a value for that specific argument.

Parameter Definition¶

Name	Type	Description
x	Integer	x-coordinate
y	Integer	y-coordinate
w	Integer	Width
h	Integer	Height

setPosition(rect)¶

Boolean FormField::setPosition(Rectangle rect)

Description¶

Sets the position, if the position is null then resets the overrides

Parameter Definition¶

Name	Type	Description
rect	Rectangle	rectangle

setValue(value)¶

Boolean FormField::setValue(Object value)

Description¶

Set this field's value. This is a generic set method that is available for every field in AMI. For FormRangeSlider and FormImage field, it is advisable to use their own setValue() method.

Parameter Definition¶

Name	Type	Description
value	Object	value

setVisible(visible)¶

Boolean FormField::setVisible(Boolean visible)

Description¶

Sets the visibility of this field. Returns false iff the argument is null, true otherwise.

Parameter Definition¶

Name	Type	Description
visible	Boolean	true for visible, false for hidden.