FormPanel¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A visualization Panel of type Form
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| FormPanel | addButtonField(varname, label) | FormButtonField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addCheckboxField(varname, label) | FormCheckboxField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addColorGradientPickerField(varname, label) | FormGradientColorPickerField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addColorPickerField(varname, label) | FormColorPickerField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addDateField(varname, label) | FormDateField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addDateRangeField(varname, label) | FormDateRangeField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addDateTimeField(varname, label) | FormDateTimeField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addDivField(varname, label) | FormDivField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addFileUploadField(varname, label) | FormUploadField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addImageField(varname, label) | FormImageField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addMultiCheckboxField(varname, label) | FormMultiCheckboxField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addMultiSelectField(varname, label) | FormMultiSelectField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| Panel | addPanelNextToMe(position, configuration) | DividerPanel | Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned. This Panel's Parent must be transient. |
| FormPanel | addPasswordField(varname, label) | FormPasswordField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addRadioButtonField(varname, label) | FormRadioField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addRangeSliderField(varname, label, min, max, step) | FormRangeSliderField | Adds a transient Range Slider Field. |
| FormPanel | addSelectField(varname, label) | FormSelectField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addSliderField(varname, label, min, max, step) | FormSliderField | Adds a transient Slider Field. |
| FormPanel | addTextAreaField(varname, label) | FormDivField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addTextField(varname, label) | FormTextField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addTimeField(varname, label) | FormTimeField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| FormPanel | addTimeRangeField(varname, label) | FormTimeRangeField | Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_) |
| Panel | bringToFront() | Object | Makes this panel visible and bring its containing window to the front. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns commandUid (String) on success, otherwise null. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns the commandUid (String) for this command call or null on failure. |
| Panel | callRelationship(relationshipName) | Boolean | Reruns the relationship targeting this panel based on name. Returns true on success. |
| Panel | callRelationshipId(relationshipId) | Boolean | Reruns the relationship targeting this panel based on id. Returns true on success. |
| Panel | clearUserSelection() | Object | Clears the user's selection. |
| Panel | close() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient. |
| FormPanel | createJsCallback(buttonId, attributes) | String | Generates javascript that can be embedded in the HTML and used to make callbacks. |
| Panel | deletePanel() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient |
| Panel | exportConfig() | Map | Exports this panel's configuration to a map. |
| Panel | exportConfig(includeRelationships, includeDatamodels) | Map | Exports this panel's configuration to a map, with the options to include external relationships and external datamodels. |
| Panel | exportConfigIncludeExternalRelationships() | Map | Exports this panels configuration with external relationships |
| Panel | exportUserPreferences() | Map | Exports this panel's user preferences to a map. |
| 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. |
| Panel | getCurrentRelationship() | Relationship | Returns the Relationship object currently applied to this panel. |
| 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 |
| Panel | getDatamodels() | Object | Returns a set of datamodels that were used in this panel. |
| Panel | getDownstreamMode() | String | Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL. |
| FormPanel | getField(varName) | FormField | Return the field associate varName, or null. |
| FormPanel | getFieldValue(varName) | Object | Return the value of the field with the associated varName. |
| FormPanel | getFieldValues() | Map | Return a map of IDs to values for all fields of this form. |
| FormPanel | getFields() | List | Returns a list of fields. |
| FormPanel | getFieldsVariableNames() | List | Returns a list of fields' variable names. |
| 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. |
| FormPanel | getHtml() | String | get the HTML for this panel |
| Panel | getId() | String | Returns this panel's ID (as defined in settings). |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| Panel | getLayout() | Layout | Returns layout that owns this panel. |
| Panel | getLocation() | Rectangle | Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header. |
| Panel | getMenu() | MenuItem | Returns this panel's root custom context menu. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| Panel | getParent() | Panel | Returns the parent panel of this panel. |
| Panel | getStyle(styleKey) | String | Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found. |
| Panel | getStyle(styleKey, index) | String | Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound. |
| Panel | getStyleNumber(styleKey) | Number | Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric. |
| Panel | getStyleSet() | StyleSet | Returns the StyleSet for this panel. |
| Panel | getTitle() | String | Returns this panel's title |
| FormPanel | getTransientFields() | List | Returns a list of transient fields. |
| Panel | getType() | String | Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types. |
| Panel | getUid() | String | Returns this panel's ami-generated ID. |
| Panel | getValue(key) | Object | Returns the value associated with key from this portlet's attributes. Returns null if key does not exist. |
| Panel | getWindow() | Window | Returns the window that owns this panel. |
| FormPanel | importField(config) | FormField | add a transient field to this panel. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| Panel | isPoppedOut() | Boolean | Returns true if this panel is popped out. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Panel | isUndocked() | Boolean | Returns true if this panel is undocked. |
| Panel | isVisible() | Boolean | Returns true if this panel is visible. |
| Panel | minimize() | Object | Minimizes the window, same as calling getWindow().minimize(). |
| FormPanel | removeField(varname) | Boolean | Removes a transient field given the field's name. |
| FormPanel | resetFieldPositions() | Boolean | Reset all fields in form to default positions specified in field editor. |
| FormPanel | resetFields() | Boolean | Resets the field value to its initial state. For example, a Radio Button field that is set to ON will be reset to its initial state, which is OFF; a Check Box field that is checked will have its box unchecked. |
| Panel | setDownstreamMode(mode) | String | Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL. |
| FormPanel | setHtml(html) | String | Set the HTML for this panel, returns old html |
| Panel | setTitle(title) | Boolean | Sets the title of the panel with the given value |
| Panel | setValue(key, value) | Boolean | Adds the key value pair to this portlet's attributes and return true if successful. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
addButtonField(varname,label)¶
FormButtonField FormPanel::addButtonField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addCheckboxField(varname,label)¶
FormCheckboxField FormPanel::addCheckboxField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addColorGradientPickerField(varname,label)¶
FormGradientColorPickerField FormPanel::addColorGradientPickerField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addColorPickerField(varname,label)¶
FormColorPickerField FormPanel::addColorPickerField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addDateField(varname,label)¶
FormDateField FormPanel::addDateField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addDateRangeField(varname,label)¶
FormDateRangeField FormPanel::addDateRangeField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addDateTimeField(varname,label)¶
FormDateTimeField FormPanel::addDateTimeField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addDivField(varname,label)¶
FormDivField FormPanel::addDivField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addFileUploadField(varname,label)¶
FormUploadField FormPanel::addFileUploadField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addImageField(varname,label)¶
FormImageField FormPanel::addImageField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addMultiCheckboxField(varname,label)¶
FormMultiCheckboxField FormPanel::addMultiCheckboxField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addMultiSelectField(varname,label)¶
FormMultiSelectField FormPanel::addMultiSelectField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addPasswordField(varname,label)¶
FormPasswordField FormPanel::addPasswordField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addRadioButtonField(varname,label)¶
FormRadioField FormPanel::addRadioButtonField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addRangeSliderField(varname,label,min,max,step)¶
FormRangeSliderField FormPanel::addRangeSliderField(String varname, String label, Number min, Number max, Number step)
Description¶
Adds a transient Range Slider Field.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String | |
| min | Number | |
| max | Number | |
| step | Number |
addSelectField(varname,label)¶
FormSelectField FormPanel::addSelectField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addSliderField(varname,label,min,max,step)¶
FormSliderField FormPanel::addSliderField(String varname, String label, Number min, Number max, Number step)
Description¶
Adds a transient Slider Field.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String | |
| min | Number | |
| max | Number | |
| step | Number |
addTextAreaField(varname,label)¶
FormDivField FormPanel::addTextAreaField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addTextField(varname,label)¶
FormTextField FormPanel::addTextField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addTimeField(varname,label)¶
FormTimeField FormPanel::addTimeField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
addTimeRangeField(varname,label)¶
FormTimeRangeField FormPanel::addTimeRangeField(String varname, String label)
Description¶
Adds a transient field. Not the varname will be prefixed with the transient prefix (default is TRANSIENT_)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | |
| label | String |
createJsCallback(buttonId,attributes)¶
String FormPanel::createJsCallback(String buttonId, Object ... attributes)
Description¶
Generates javascript that can be embedded in the HTML and used to make callbacks.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| buttonId | String | id of the button to execute button press on |
| attributes | Object ... | list of attributes to include |
getField(varName)¶
FormField FormPanel::getField(String varName)
Description¶
Return the field associate varName, or null.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varName | String | fieldVarName |
getFieldValue(varName)¶
Object FormPanel::getFieldValue(String varName)
Description¶
Return the value of the field with the associated varName.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varName | String | fieldVarName |
getFieldValues()¶
Map FormPanel::getFieldValues()
Description¶
Return a map of IDs to values for all fields of this form.
getFields()¶
Description¶
Returns a list of fields.
getFieldsVariableNames()¶
List FormPanel::getFieldsVariableNames()
Description¶
Returns a list of fields' variable names.
getHtml()¶
Description¶
get the HTML for this panel
getTransientFields()¶
List FormPanel::getTransientFields()
Description¶
Returns a list of transient fields.
importField(config)¶
FormField FormPanel::importField(Map config)
Description¶
add a transient field to this panel.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| config | Map | the field's config, see FormField::exportConfig() |
removeField(varname)¶
Boolean FormPanel::removeField(String varname)
Description¶
Removes a transient field given the field's name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| varname | String | the field's name |
resetFieldPositions()¶
Boolean FormPanel::resetFieldPositions()
Description¶
Reset all fields in form to default positions specified in field editor.
resetFields()¶
Boolean FormPanel::resetFields()
Description¶
Resets the field value to its initial state. For example, a Radio Button field that is set to ON will be reset to its initial state, which is OFF; a Check Box field that is checked will have its box unchecked.
setHtml(html)¶
String FormPanel::setHtml(String html)
Description¶
Set the HTML for this panel, returns old html
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| html | String |