selectWidget Class Reference

A pull-down select widget. More...

#include "remoto!stdlib:js/widgets/widgets/selectWidget.js"

Inheritance diagram for selectWidget:

Public Member Functions
	selectWidget (d)
	applyOptions ()
	Apply option changes to an existing selectWidget, like from a diff. More...
	createWidget ()
	Create the widget and apply options. More...
	setOptions ()
	set the option list for this select widget More...
Public Member Functions inherited from widget
	widget (d)
	widget contstructor More...
	activate ()
	Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism. More...
	applyOptions ()
	Apply option changes to an existing widget, like from a diff. More...
	arrowMessage (m)
	Create an arrowMessage and point its arrow at this widget's position on screen. More...
	createHTML ()
	Create the HTML representation of this object, including the label and form field. More...
	createLabel ()
	Create the label jQuery object. More...
	createWidget ()
	Create the widget jQuery object. More...
	deactivate ()
	Deactivate the widget, which will unbind input events from their callbacks. More...
	destroy ()
	Destroy this widget. More...
	disable ()
	Disable this widget. More...
	doChange ()
	Collect changes to the value of this widget and call this widget's _change method, if it exists, after a period of the user's uifreqency has expired. More...
	enable ()
	Enable this widget. More...
	sync ()
	Sync the visible value with the internal value. More...
	validate ()
	Validate the value of this widget using the _validator function. More...
setter	immediateValue
	Set the value of this widget, and trigger the doChange method without waiting. More...
getter	value
	Return the internal value of this widget, which may not be the same as what is displayed in the interface. More...
getter	defaultValue
	Return the default value of this widget. More...
getter	visibleWidget
	Return the visible jQuery object for this widget. More...
getter	isDefault
	Return whether or not this widget's value is its default value. More...
getter	nonDefaultValue
	Return the value of this widget, or return undefined if it contains the default value. More...
setter	validator
	Set this widget's validator function. More...
setter	error
	Set the error value of this widget. More...
setter	activeUser
	Set the activeUser of this widget. More...
getter	enabled
	Return true or false based on _enabled state. More...
getter	hidden
	The hidden state of this widget. More...

Detailed Description

A pull-down select widget.

Options should be provided in the options.options field as an array of text+value objects:

{
     "type":"select",
     "value":"something",
     "options": {
        "options": [
                { "text":"Something Here", value:"something"    },
                { "text":"Something Else", value:"else"         }
        ]
     }
}

Options:

• options - A list of objects in the form `{ text:"text","value":"value" }, provided in the order they are to appear in the pull-down.
• allowOther - if set to true, an additional text field will appear below the select field when "other" is selected in the pull-down. Any value is possible for the "other" value.
• enabled - Enable or disable this field
• searchable - Enable or disable a search field
• autofocus - when a form is opened, automatically give focus to this field. If multiple fields have autofocus, the result is undefined.

Constructor & Destructor Documentation

selectWidget()

selectWidget

(

d

)

Parameters

d

DOCME

Member Function Documentation

applyOptions()

applyOptions

(

)

Apply option changes to an existing selectWidget, like from a diff.

This will set the options list, is present, or call the base class implementation widget::applyOptions().

See also

widget::applyOptions

createWidget()

createWidget

(

)

Create the widget and apply options.

Returns

The select widget jQuery object

Optionally creates the "other" field depending on the field's value.

setOptions()

setOptions

(

)

set the option list for this select widget

---

The documentation for this class was generated from the following file:

• selectWidget.js