FormTitleField¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A static heading field within a FormPanel, breaking a long form into labelled sections. It collects no input.
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| FormField | clearError() | Boolean | Clears the error message on this field. |
| DashboardResource | commit() | Object | Commits transient changes, promoting overrides to persisted values. If transient, makes permanent. |
| 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 |
| FormField | getAnchors() | Map | The field's current position keys, in the same vocabulary setAnchors() accepts. Only the keys actually in force are present, so the set of keys returned tells you which anchoring mode the field is in. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbackNames() | List | Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI. |
| 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 an object 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 | getError() | String | Returns the error message currently shown against this field, or null if it has none. |
| 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. |
| FormField | getOwner() | FormPanel | Returns the FormPanel 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. |
| FormTitleField | getValue() | String | Returns this title field's heading text. |
| FormField | getVariableName() | String | Returns the variable name associated with this field. |
| FormField | hasError() | Boolean | Returns true if this field currently has an error message, false otherwise. |
| 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. |
| FormTitleField | resetValue() | Boolean | If setValue has been called (overriding the heading), this sets the heading back to the layout's original text. |
| FormField | setAnchors(anchors) | Boolean | Set this field's position by anchor, rather than as a fixed box. Which keys you supply decides how the field behaves when the panel resizes: left+width is fixed forever, left+right keeps a fixed gutter each side and stretches, leftPct+rightPct tracks the panel proportionally. Vertical works the same with top/bottom/height. minWidth/maxWidth (and the height pair) clamp whatever those keys work out to, so a proportional field neither collapses on a narrow panel nor sprawls on a wide one. On a field positioned by anchors they clamp that field alone and take no space from its neighbours, so a floor big enough to matter will overlap them and a cap leaves a hole beside them; if the field is a member of a layout group, the group divides its box so the floor is met without overlapping and hands back what the cap refused. This replaces the whole position spec and any key you omit is cleared. |
| 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 | setError(error) | Boolean | Shows an error message against this field. Passing null or an empty message clears it. The message is never saved with the layout. Depending on the field's Error Indication style, the field itself may also be recoloured. |
| 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 |
| FormTitleField | setValue(value) | Boolean | Set this title field's heading text. |
| FormField | setVisible(visible) | Boolean | Sets the visibility of this field. Returns false iff the argument is null, true otherwise. |
| Object | toJson() | String | Returns a string of a json representation of this object. |
| FormField | validate() | Boolean | Calls onValidate() on this field, showing the returned message as the field's error or clearing it when nothing is returned. A field with no onValidate() is left alone, so an error set by setError() is not cleared, and it passes. A validator that queries a datasource suspends this script until it answers, and a validator that throws fails the field with 'Unexpected Error'. Returns true if the field passed. |
Method Definitions¶
clearError()¶
Boolean FormField::clearError()
Description¶
Clears the error message on this field.
commit()¶
Object DashboardResource::commit()
Description¶
Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.
exportConfig()¶
Description¶
Exports this field's configuration to a map.
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
getAnchors()¶
Description¶
The field's current position keys, in the same vocabulary setAnchors() accepts. Only the keys actually in force are present, so the set of keys returned tells you which anchoring mode the field is in.
getCallback(callbackName)¶
Callback DashboardResource::getCallback(String callbackName)
Description¶
Returns a callback by name
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
getCallbackNames()¶
List DashboardResource::getCallbackNames()
Description¶
Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.
getCallbacks()¶
Map DashboardResource::getCallbacks()
Description¶
Returns a map of all callback definitions.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getClassName()¶
Description¶
Returns the string name of this object's class type.
getCssClass()¶
String FormField::getCssClass()
Description¶
Returns the CSS class.
getDRI()¶
String DashboardResource::getDRI()
Description¶
Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.
getDashboardResourceType()¶
String DashboardResource::getDashboardResourceType()
Description¶
Returns the Dashboard Resource Type as a string
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.
getError()¶
Description¶
Returns the error message currently shown against this field, or null if it has none.
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 |
getFormula(formulaName)¶
Formula DashboardResource::getFormula(String formulaName)
Description¶
Returns a Formula given the formula name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formulaName | String | name of the formula to return |
getFormulaNames()¶
Set DashboardResource::getFormulaNames()
Description¶
Returns a set of the names of all formulas for this object.
getFormulas()¶
Map DashboardResource::getFormulas()
Description¶
Returns a map of all available formulas for this object. The key is the formula name.
getLRI()¶
String DashboardResource::getLRI()
Description¶
Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
getLabel()¶
Description¶
Returns the label associated with this field.
getLabelTooltip()¶
String FormField::getLabelTooltip()
Description¶
Returns the tooltip associated with this field's label.
getOwner()¶
FormPanel FormField::getOwner()
Description¶
Returns the FormPanel that owns this object.
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()¶
String FormTitleField::getValue()
Description¶
Returns this title field's heading text.
getVariableName()¶
String FormField::getVariableName()
Description¶
Returns the variable name associated with this field.
hasError()¶
Description¶
Returns true if this field currently has an error message, false otherwise.
invokeCallback(callbackName,args)¶
Object DashboardResource::invokeCallback(String callbackName, Object ... args)
Description¶
Executes the specified callback definition and returns the result from the callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
| args | Object ... | arguments |
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.
resetValue()¶
Boolean FormTitleField::resetValue()
Description¶
If setValue has been called (overriding the heading), this sets the heading back to the layout's original text.
setAnchors(anchors)¶
Boolean FormField::setAnchors(Map anchors)
Description¶
Set this field's position by anchor, rather than as a fixed box. Which keys you supply decides how the field behaves when the panel resizes: left+width is fixed forever, left+right keeps a fixed gutter each side and stretches, leftPct+rightPct tracks the panel proportionally. Vertical works the same with top/bottom/height. minWidth/maxWidth (and the height pair) clamp whatever those keys work out to, so a proportional field neither collapses on a narrow panel nor sprawls on a wide one. On a field positioned by anchors they clamp that field alone and take no space from its neighbours, so a floor big enough to matter will overlap them and a cap leaves a hole beside them; if the field is a member of a layout group, the group divides its box so the floor is met without overlapping and hands back what the cap refused. This replaces the whole position spec and any key you omit is cleared.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| anchors | Map | position keys, same vocabulary as the panel JSON: left, right, width, leftPct, rightPct, widthPct, horizontalOffsetPct, top, bottom, height, topPct, bottomPct, heightPct, verticalOffsetPct, maxWidth, maxHeight, minWidth, minHeight |
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 |
setError(error)¶
Boolean FormField::setError(String error)
Description¶
Shows an error message against this field. Passing null or an empty message clears it. The message is never saved with the layout. Depending on the field's Error Indication style, the field itself may also be recoloured.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| error | String | The message to show, or null to clear it. |
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 FormTitleField::setValue(Object value)
Description¶
Set this title field's heading text.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| value | Object | heading text |
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. |
toJson()¶
Description¶
Returns a string of a json representation of this object.
validate()¶
Description¶
Calls onValidate() on this field, showing the returned message as the field's error or clearing it when nothing is returned. A field with no onValidate() is left alone, so an error set by setError() is not cleared, and it passes. A validator that queries a datasource suspends this script until it answers, and a validator that throws fails the field with 'Unexpected Error'. Returns true if the field passed.