RapidContext :: JavaScript API

Constructor Summary
	`new FormValidator(attrs) → {Widget}` Creates a new form validator widget.

Method Summary
	`addAll(…child)` Adds one or more children to this widget.
	`addChildNode(child)` Adds a single child DOM node to this widget.
	`addClass(…cls)` Adds the specified CSS class names to this HTML DOM node.
	`addError(field, message)` Adds a validation error message for the specified field.
	`animate(opts)` Performs a visual effect animation on this widget.
	`blurAll()` Blurs (unfocuses) this DOM node and all relevant child nodes.
	`destroy()` The internal widget destructor function.
	`disable()` Disables this widget if it was previously enabled.
	`enable()` Enables this widget if it was previously disabled.
	`getChildNodes() → {Array}` Returns an array with all child DOM nodes.
	`hasClass(…cls) → {boolean}` Checks if this HTML DOM node has the specified CSS class names.
	`hide()` Hides this widget node if it was previously visible.
	`isDisabled() → {boolean}` Checks if this widget is disabled.
	`isHidden() → {boolean}` Checks if this widget node is hidden.
	`removeAll()` Removes all children to this widget.
	`removeChildNode(child)` Removes a single child DOM node from this widget.
	`removeClass(…cls)` Removes the specified CSS class names from this HTML DOM node.
	`reset()` Resets this form validator.
	`setAttrs(attrs)` Updates the widget or HTML DOM node attributes.
	`setStyle(styles)` Updates the CSS styles of this HTML DOM node.
	`show()` Shows this widget node if it was previously hidden.
	`toggleClass(…cls) → {boolean}` Toggles adding and removing the specified CSS class names to and from this HTML DOM node.
	`uid() → {string}` Returns the unique identifier for this DOM node.
	`verify(field, valueopt) → {boolean}` Verifies a form field with this validator.

Constructor

new FormValidator(attrs) → {Widget}

Creates a new form validator widget.

Properties:

Name	Type	Description
`name`	{string}	The form field name to validate.
`message`	{string}	The default validation message.
`validator`	{function}	The validator function in use.

Parameters:

Name Type Description

attrs

{Object}

the widget and node attributes

Properties

Name	Type	Attributes	Description
`name`	{string}		the form field name to validate
`mandatory`	{boolean}	<optional>	the mandatory field flag, defaults to `true`
`regex`	{string\|RegExp}	<optional>	the regular expression to match the field value against, defaults to `null`
`display`	{string}	<optional>	the validator display setting (either "none", "icon", "text" or "both"), defaults to "both"
`message`	{string}	<optional>	the message to display, defaults to the validator function error message
`validator`	{function}	<optional>	the validator function
`hidden`	{boolean}	<optional>	the hidden widget flag, defaults to `false`

Returns:

{Widget} the widget DOM node

Examples:

JavaScript

var field = RapidContext.Widget.TextField({ name: "name", placeholder: "Your Name Here" });
var attrs = { name: "name", message: "Please enter your name to proceed." };
var valid = RapidContext.Widget.FormValidator(attrs);
var exampleForm = RapidContext.Widget.Form({}, field, valid);

User Interface XML

<Form id="exampleForm">
  <TextField name="name" placeholder="Your Name Here" />
  <FormValidator name="name" message="Please enter your name to proceed." />
</Form>

Source:

RapidContext_Widget_FormValidator.js, line 62

Extends

RapidContext.Widget

Methods

addAll(…child)

Adds one or more children to this widget. This method will flatten any arrays among the arguments and ignores any null or undefined arguments. Any DOM nodes or widgets will be added to the end, and other objects will be converted to a text node first. Subclasses should normally override the addChildNode() method instead of this one, since that is the basis for DOM node insertion.

Parameters:

Name	Type	Attributes	Description
`child`	{string\|Node\|Array}	<repeatable>	the children to add

Inherited From:

RapidContext.Widget#addAll

Source:

RapidContext_Widget.js, line 570

addChildNode(child)

Adds a single child DOM node to this widget. This method is sometimes overridden by child widgets in order to hide or control intermediate DOM nodes required by the widget.

Parameters:

Name	Type	Description
`child`	{Widget\|Node}	the DOM node to add

Inherited From:

RapidContext.Widget#addChildNode

Source:

RapidContext_Widget.js, line 534

addClass(…cls)

Adds the specified CSS class names to this HTML DOM node.

Parameters:

Name	Type	Attributes	Description
`cls`	{string\|Array}	<repeatable>	the CSS class names to add

Inherited From:

RapidContext.Widget#addClass

Source:

RapidContext_Widget.js, line 333

addError(field, message)

Adds a validation error message for the specified field. If the field is already invalid, this method will not do anything.

Note that this method is normally not called directly, instead the validation is performed by the RapidContext.Widget.Form widget.

Parameters:

Name	Type	Description
`field`	{Widget\|Node}	the field DOM node
`message`	{string}	the validation error message

See:

RapidContext.Widget.Form#validate

Source:

RapidContext_Widget_FormValidator.js, line 198

animate(opts)

Performs a visual effect animation on this widget. This is implemented using the MochiKit.Visual effect package. All options sent to this function will be passed on to the appropriate MochiKit.Visual function.

Parameters:

Name Type Description

opts

{Object}

the visual effect options

Properties

Name	Type	Description
`effect`	{string}	the MochiKit.Visual effect name
`queue`	{string}	the MochiKit.Visual queue handling, defaults to "replace" and a unique scope for each widget (see `MochiKit.Visual` for full options)

Inherited From:

RapidContext.Widget#animate

Deprecated:

Use CSS animations instead.

Example:

widget.animate({ effect: "fade", duration: 0.5 });
widget.animate({ effect: "Move", transition: "spring", y: 300 });

Source:

RapidContext_Widget.js, line 492

blurAll()

Blurs (unfocuses) this DOM node and all relevant child nodes. This function will recursively blur all <a>, <button>, <input>, <textarea> and <select> child nodes found.

Inherited From:: RapidContext.Widget#blurAll
Source:: RapidContext_Widget.js, line 510

destroy()

The internal widget destructor function. This method should only be called by destroyWidget() and may be overridden by subclasses. By default this method does nothing.

Inherited From:: RapidContext.Widget#destroy
Source:: RapidContext_Widget.js, line 194

disable()

Disables this widget if it was previously enabled. This method is equivalent to calling setAttrs({ disabled: true }).

Inherited From:: RapidContext.Widget#disable
Source:: RapidContext_Widget.js, line 424

enable()

Enables this widget if it was previously disabled. This is equivalent to calling setAttrs({ disabled: false }).

Inherited From:: RapidContext.Widget#enable
Source:: RapidContext_Widget.js, line 416

getChildNodes() → {Array}

Returns an array with all child DOM nodes. Note that the array is a real JavaScript array, not a dynamic NodeList. This method is sometimes overridden by child widgets in order to hide intermediate DOM nodes required by the widget.

Returns:: {Array} the array of child DOM nodes
Inherited From:: RapidContext.Widget#getChildNodes
Source:: RapidContext_Widget.js, line 522

hasClass(…cls) → {boolean}

Checks if this HTML DOM node has the specified CSS class names. Note that more than one CSS class name may be checked, in which case all must be present.

Parameters:

Name	Type	Attributes	Description
`cls`	{string\|Array}	<repeatable>	the CSS class names to check

Returns:

{boolean} true if all CSS classes were present, or false otherwise

Inherited From:

RapidContext.Widget#hasClass

Source:

RapidContext_Widget.js, line 315

hide()

Hides this widget node if it was previously visible. This method is equivalent to calling setAttrs({ hidden: true }). It is safe for all types of widgets, since it only adds the widgetHidden CSS class instead of setting the display style property.

Inherited From:: RapidContext.Widget#hide
Source:: RapidContext_Widget.js, line 470

isDisabled() → {boolean}

Checks if this widget is disabled. This method checks both the "widgetDisabled" CSS class and the disabled property. Changes to the disabled status can be made with enable(), disable() or setAttrs().

Returns:: {boolean} true if the widget is disabled, or false otherwise
Inherited From:: RapidContext.Widget#isDisabled
Source:: RapidContext_Widget.js, line 395

isHidden() → {boolean}

Checks if this widget node is hidden. This method checks for the existence of the widgetHidden CSS class. It does NOT check the actual widget visibility (the display style property set by animations for example).

Returns:: {boolean} true if the widget is hidden, or false otherwise
Inherited From:: RapidContext.Widget#isHidden
Source:: RapidContext_Widget.js, line 437

removeAll()

Removes all children to this widget. This method will also destroy and child widgets and disconnect all signal listeners. This method uses the getChildNodes() and removeChildNode() methods to find and remove the individual child nodes.

Inherited From:: RapidContext.Widget#removeAll
Source:: RapidContext_Widget.js, line 582

removeChildNode(child)

Removes a single child DOM node from this widget. This method is sometimes overridden by child widgets in order to hide or control intermediate DOM nodes required by the widget.

Note that this method will NOT destroy the removed child widget, so care must be taken to ensure proper child widget destruction.

Parameters:

Name	Type	Description
`child`	{Widget\|Node}	the DOM node to remove

Inherited From:

RapidContext.Widget#removeChildNode

Source:

RapidContext_Widget.js, line 553

removeClass(…cls)

Removes the specified CSS class names from this HTML DOM node. Note that this method will not remove any class starting with "widget".

Parameters:

Name	Type	Attributes	Description
`cls`	{string\|Array}	<repeatable>	the CSS class names to remove

Inherited From:

RapidContext.Widget#removeClass

Source:

RapidContext_Widget.js, line 353

reset()

Resets this form validator. This will hide any error messages and mark all invalidated fields as valid.

Note that this method is normally not called directly, instead the validation is reset by the RapidContext.Widget.Form widget.

See:: RapidContext.Widget.Form#validateReset
Source:: RapidContext_Widget_FormValidator.js, line 133

setAttrs(attrs)

Updates the widget or HTML DOM node attributes.

Parameters:

Name Type Description

attrs

{Object}

the widget and node attributes to set

Properties

Name	Type	Attributes	Description
`name`	{string}	<optional>	the form field name to validate
`mandatory`	{boolean}	<optional>	the mandatory field flag
`regex`	{string\|RegExp}	<optional>	the regular expression to match the field value against
`display`	{string}	<optional>	the validator display setting (either "none", "icon", "text" or "both")
`message`	{string}	<optional>	the message to display
`validator`	{function}	<optional>	the validator function
`hidden`	{boolean}	<optional>	the hidden widget flag

Overrides:

RapidContext.Widget#setAttrs

Source:

RapidContext_Widget_FormValidator.js, line 90

setStyle(styles)

Updates the CSS styles of this HTML DOM node. This method is identical to MochiKit.Style.setStyle, but uses "this" as the first argument.

Parameters:

Name	Type	Description
`styles`	{Object}	an object with the styles to set

Inherited From:

RapidContext.Widget#setStyle

Example:

widget.setStyle({ "font-size": "bold", "color": "red" });

Source:

RapidContext_Widget.js, line 294

show()

Shows this widget node if it was previously hidden. This method is equivalent to calling setAttrs({ hidden: false }). It is safe for all types of widgets, since it only removes the widgetHidden CSS class instead of setting the display style property.

Inherited From:: RapidContext.Widget#show
Source:: RapidContext_Widget.js, line 460

toggleClass(…cls) → {boolean}

Toggles adding and removing the specified CSS class names to and from this HTML DOM node. If all the CSS classes are already set, they will be removed. Otherwise they will be added.

Parameters:

Name	Type	Attributes	Description
`cls`	{string\|Array}	<repeatable>	the CSS class names to remove

Returns:

{boolean} true if the CSS classes were added, or false otherwise

Inherited From:

RapidContext.Widget#toggleClass

Source:

RapidContext_Widget.js, line 376

uid() → {string}

Returns the unique identifier for this DOM node. If a node id has already been set, that id will be returned. Otherwise a new id will be generated and assigned to the widget DOM node.

Returns:: {string} the the unique DOM node identifier
Inherited From:: RapidContext.Widget#uid
Source:: RapidContext_Widget.js, line 182

verify(field, valueopt) → {boolean}

Verifies a form field with this validator. If the form field value doesn't match this validator, the field will be invalidated until this validator is reset.

Note that this method is normally not called directly, instead the validation is performed by the RapidContext.Widget.Form widget.

Parameters:

Name	Type	Attributes	Description
`field`	{Widget\|Node}		the form field DOM node
`value`	{string}	<optional>	the form field value to check

Returns:

{boolean} true if the form validated successfully, or false if the validation failed

See:

RapidContext.Widget.Form#validate

Source:

RapidContext_Widget_FormValidator.js, line 158

Class RapidContext.Widget.FormValidator

.Widget.FormValidator(attrs) → {Widget}

Constructor

new FormValidator(attrs) → {Widget}

Properties

Extends

Methods

addAll(…child)

addChildNode(child)

addClass(…cls)

addError(field, message)

animate(opts)

Properties

blurAll()

destroy()

disable()

enable()

getChildNodes() → {Array}

hasClass(…cls) → {boolean}

hide()

isDisabled() → {boolean}

isHidden() → {boolean}

removeAll()

removeChildNode(child)

removeClass(…cls)

reset()

setAttrs(attrs)

Properties

setStyle(styles)

show()

toggleClass(…cls) → {boolean}

uid() → {string}

verify(field, valueopt) → {boolean}