Class ProcessField

Object
   |
   +--MoreMotionObject
         |
         +--ProcessField

Direct Known Subclasses:

HiddenBox, FileBox, EditArea, ComboEditBox, SuggestBox, OptionBox, ListBox, TextBox, EditBox, ComboBox, NumberDialog, CheckBox, DateBox, NumberBox, ImageBox, DateDialog

class ProcessField

extends MoreMotionObject

Represents a Process Field.
Defined in Process.js

Field Detail

elm

Object elm

needsValueCloning

Boolean needsValueCloning

This flag denotes that the value of this field should be set additionally by calling the setValue() method after the process record that this field resides in is cloned. Usually this flag needs to be set for the fields that wraps one or more HTML SELECT elements

props

Object props

ProcessField Properties Object



nonBlank	Flag that specifies that this field must contain a value
isNumber	Flag that specifies that this field must contain a valid number
validValues	The valid values that can be entered into this Process Field. The values should be separated with ";" characters. e.g. "AAA;BBB;CCC". If the value of this Process Field is number then number ranges can be defined. e.g. "1:20;30:40".
valHandler	The name of the Validation Handler Function. If this property is defined then it is called by the validate() method of this object and this object is passed to it as the parameter. Example: function MyValidationHandler(field) { if (field.elm.value.indexOf("x") == -1) { alert("Error!") return false; } return true; }
valErrorHandler	The name of the event handler function. If this property is present and if the validation of this Process Field fails then this handler is invoked to handle the error and an Exception object passed to it. The handler should return normally if it handles the error or throw the Exception object. Example: function MyErrorHandler(ex) { if (ex.code == "CANNOT_BE_BLANK") return; throw ex; }

ProcessField

ProcessField(node)

Parameters:
node - the DOM Element node that is wrapped by this field

appendRequestParams

void appendRequestParams(acc,prefix)

Appends the request parameters and their values to the given request parameter accumulator.

This method is called prior to the submit of the request either with Ajax or with regular Http. Depending on the type of the process field one or more request parameters can be appended to the parameter accumulator.

Parameters:
acc - The RequestParameterAccumulator object
prefix - The prefix to be put in front of the parameter name(s)

checkHasValidValue

Boolean checkHasValidValue(elmToValidate,elmToFocus)

Checks if this Process Field has a valid value. The valid values need to be specified with validValues property prior to callling this method.

Parameters:
elmToValidate - The HTML Element object whose value to be checked
elmToFocus - The HTML Element object to focus when validation fails

Returns:
true is the validation is successful false otherwise.

checkValueIsAvailable

Boolean checkValueIsAvailable(elmToValidate,elmToFocus)

Checks if this Process Field has a value.

Parameters:
elmToValidate - The HTML Element object whose value to be checked
elmToFocus - The HTML Element object to focus when validation fails

Returns:
true is the validation is successful false otherwise.

checkValueIsNumber

Boolean checkValueIsNumber(elmToValidate,elmToFocus)

Checks if the value of this Process Field is a valid number.

Parameters:
elmToValidate - The HTML Element object whose value to be checked
elmToFocus - The HTML Element object to focus when validation fails

Returns:
true is the validation is successful false otherwise.

clear

void clear()

Clears the value of this Process Field.

focusTab

void focusTab()

If this Process Field is located in a TabPanel this method instructs the TabManager to focus to that Tab. Otherwise no action is taken.

getCaption

Object getCaption()

Returns the caption of this field

getRecord

ProcessRecord getRecord()

Returns the Process Record that this Process Field resides in

getValue

Object getValue()

Returns the value of this field

isModified

Boolean isModified()

Returns true if this Process Field is modified by the user false otherwise.

notify

Boolean notify(elm, msgCode, msgArg1, msgArg2, msgArg3)

Focuses on the specified HTML Element and notifies the user with the specified message.

Parameters:
elm - The HTML Element object to focus
msgCode - The message code
msgArg1 - The message argument 1
msgArg2 - The message argument 2
msgArg3 - The message argument 3

Returns:
true if valErrorHandler property is defined and the error handler covered the error false otherwise.

notifyEx

Boolean notifyEx(elm, ex)

Focuses on the specified HTML Element and notifies the user with the specified message.

Parameters:
elm - The HTML Element object to focus
ex - The Exception to notify

Returns:
true if valErrorHandler property is defined and the error handler covered the error false otherwise.

reset

void reset(silent)

Resets the value of this Process Field.

Parameters:
silent - Boolean value true if there is no change in the modification status of the field

runValidationHandler

Boolean runValidationHandler()

Runs the Validation Handler Function defined for this Process Field.

Returns:
true is the validation is successful false otherwise.

setModified

void setModified()

Adds the name of this field to the modified fields list of the parent ProcessRecord if the value of this field is different that the initial value.

setValue

void setValue(value)

Sets the value of this field.

Parameters:
value - The value to set to the field.

validate

Boolean validate()

Validates this Process Field with the built-in validation methods that are applicable to the type of the Process Field.

See checkValueIsAvailable
See checkMaxLength
See checkValueIsNumber
See checkHasValidValue
See runValidationHandler