Class Alfresco.FormUI
Extends Alfresco.component.Base
Form UI component.
Defined in: form.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.FormUI(htmlId, parentId)
FormUI constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Object container for storing YUI button instances.
|
|
|
The forms runtime instance.
|
|
|
Object container for initialization options
|
- Fields borrowed from class Alfresco.component.Base:
- modules, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
onAddSubmitElement(layer, args)
Adds a submit element to the form runtime instance
|
|
|
onFormRefresh(layer, args)
Form refresh event handler
|
|
|
onJsonPostFailure(response)
Default handler used when submit mode is JSON and the sumbission failed
|
|
|
onJsonPostSuccess(response)
Default handler used when submit mode is JSON and the sumbission was successful
|
|
|
onMandatoryControlValueUpdated(layer, args)
Mandatory control value updated event handler
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onRegisterValidationHandler(layer, args)
Register validation handler event handler
|
|
|
toggleHelpText(event, fieldId)
Toggles help text for a field.
|
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.FormUI(htmlId, parentId)
FormUI constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- parentId
- Returns:
- {Alfresco.FormUI} The new FormUI instance
Field Detail
{object}
buttons
Object container for storing YUI button instances.
{object}
formsRuntime
The forms runtime instance.
{object}
options
Object container for initialization options
Method Detail
onAddSubmitElement(layer, args)
Adds a submit element to the form runtime instance
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onFormRefresh(layer, args)
Form refresh event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onJsonPostFailure(response)
Default handler used when submit mode is JSON and the sumbission failed
- Parameters:
- response
- The response from the submission
onJsonPostSuccess(response)
Default handler used when submit mode is JSON and the sumbission was successful
- Parameters:
- response
- The response from the submission
onMandatoryControlValueUpdated(layer, args)
Mandatory control value updated event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onReady()
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.
Component initialisation, including instantiation of YUI widgets and event listener binding.
onRegisterValidationHandler(layer, args)
Register validation handler event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
toggleHelpText(event, fieldId)
Toggles help text for a field.
- Parameters:
- event
- The user event
- fieldId
- The id of the field to toggle help text for