Methods

This section describes 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 you are changing multiple component settings at once.

An object representing device parameters, or an array of objects representing device parameters, or a function that provides information on the current device as an input parameter and returning a Boolean value.

The defaultOptions method is a static method supported by the widget class. The following code demonstrates how to specify default options for all buttons in the application executed on the iOS platform.

element()

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 you change multiple component setting at once.

field()

focus()

Sets focus to the input element representing the widget.

NOTE

In the mobile Safari browser, it is impossible to set focus programmatically. You can find more information about this here. You can, however, accomplish this task using PhoneGap when building a native package. Set the KeyboardDisplayRequiresUserAction preference to false in the config.xml file with Cordova settings.

registerKeyHandler(key, handler)

The handler function is called when the specified key is pressed if the widget is focused.

The key argument accepts the following values.

"backspace"

"tab"

"enter"

"escape"

"pageUp"

"pageDown"

"end"

"home"

"leftArrow"

"upArrow"

"rightArrow"

"downArrow"

"del"

"space"

"F"

"A"

"asterisk"

"minus"

NOTE

If you specify a custom handler for a key, the default handler for this key is canceled.

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.