Methods

This section describes members used to manipulate the widget.

dispose()

Removes the widget from the DOM.

element()

Gets the root element of the widget.

Return Value:

Element (jQuery or HTML)

The widget's root element. An HTML element or a jQuery element when you use jQuery.

See Also

focus()

Sets focus to the editor associated with the current Validator object.

getInstance(element)

Gets the widget's instance using a DOM element.

Parameters:
element:

DOM Node

|

jQuery

An element containing the widget.

Return Value:

Object

The widget's instance.

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

Return Value:

Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

eventHandler:

function

The handler to be detached from the specified event.

Return Value:

Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName:

String

The name of the event to be subscribed.

eventHandler:

function

An event handler for the specified event.

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to the specified events.

Parameters:
events:

Object

An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName:

String

The option name or the full path to the option.

Return Value: any

This option value.

See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName:

String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also

option(options)

Sets one or more options.

Parameters:
options:

Object

The options along with their new values.

See Also

reset()

Resets the value and validation result of the editor associated with the current Validator object.

Use this method to "refresh" the editor controlled by the current Validator object. As a result, the editor's value becomes undefined, without validation errors, as it was before validating the editor.

validate()

Validates the value of the editor that is controlled by the current Validator object against the list of the specified validation rules.

Return Value:

Object

An object defining the validation result.

The object returned by the validate() function has the following structure.

  • isValid
    Indicates whether all the rules checked for the validator are satisfied.
  • brokenRule
    The broken rule. The structure of the rule object is described in the validation Rules section.
  • validator
    The current Validator widget.
  • value
    The current editor value.
  • validationRules
    An array of validation rules specified for the current validator. The structure of a rule object is described in the validation Rules section.