Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when changing multiple component settings at once.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when changing multiple component setting at once.

hide()

Hides the widget.

Return Value: jQuery.Promise
A Promise of the jQuery Deferred object resolved when the widget is hidden.

As an alternative, use the toggle(false) method.

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

repaint()

Redraws the widget.

After performing some external modifications that lead to a change of the widget container's size or visibility, the widget's state may become invalid. In this instance, use the repaint() method to redraw the widget.

show()

Shows the widget.

Return Value: jQuery.Promise
A Promise of the jQuery Deferred object resolved when the widget is shown.

As an alternative, use the toggle(true) method.

toggle(showing)

Shows or hides the widget depending on the Boolean value passed as the parameter.

Parameters:
showing: Boolean
A boolean value that specifies whether to show or hide the widget.
Return Value: Object
A Promise of the jQuery Deferred object resolved when the widget is shown/hidden.

As an alternative, use the show and hide methods.