UIZE JavaScript Framework

MODULES Uize.Widget.Options

SEARCHEXAMPLESSOURCETO DODEPSTEST

1. Introduction

The Uize.Widget.Options class manages state for a group of option buttons, with support for dynamically rebuilding the UI when the values set changes.

DEVELOPERS: Chris van Rensburg, Jan Borgersen, Ben Ilegbodu, original code contributed by Zazzle Inc.

1.1. Examples

The following example pages are good showcases for the Uize.Widget.Options module...

Dynamic Options - See a demo of an options set widget, where the HTML for the widget's buttons can be dynamically regenerated just by setting new values for the widget.
Options - See how to use the options widget to let the user pick a single option from a set of options by clicking on an option button. Test links are provided.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Widget.Options module...

SEARCH

1.2. Implementation Info

The Uize.Widget.Options module defines the Uize.Widget.Options class, which is a subclass of Uize.Widget.

INHERITANCE CHAIN

Uize.Class −> Uize.Widget −> Uize.Widget.Options

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

forAll | getOptionProperties | getValueNoFromValue | getValueObject

STATE PROPERTIES

ensureValueInValues | optionWidgetClass | optionWidgetProperties | setValueOnMouseover | tentativeRestTime | tentativeValue | tentativeValueNo | value | valueNo | values

1.2.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

updateUi | valueOf | wireUi

STATIC PROPERTIES

Uize.Widget.Options.moduleName | Uize.Widget.Options.nonInheritableStatics | Uize.Widget.Options.undefined

1.2.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

addChild | addChildren | ajax | buildHtml | callInherited | childHtml | childId | confirm | displayNode | fire | flushNodeCache | get | getContainer | getHtml | getInherited | getNode | getNodeStyle | getNodeValue | getProvider | globalizeNode | inform | injectNodeHtml | insertOrWireUi | insertUi | is | isMet | kill | localize | met | nodeId | onChange | once | removeChild | removeNode | removeUi | set | setInherited | setNodeClipRect | setNodeInnerHtml | setNodeOpacity | setNodeProperties | setNodeStyle | setNodeValue | showNode | toggle | unmet | unwire | unwireNode | unwireNodeEventsByMatch | unwireUi | whenever | wire | wireNode

INSTANCE PROPERTIES

showConfirm | showInform

STATE PROPERTIES

built | busy | busyInherited | busyParentTickle | children | container | enabled | enabledInherited | enabledParentTickle | html | idPrefix | idPrefixConstruction | insertionMode | localized | name | nodeMap | parent | wired

STATIC METHODS

Uize.Widget.Options.alphastructor | Uize.Widget.Options.declare | Uize.Widget.Options.doMy | Uize.Widget.Options.dualContextMethods | Uize.Widget.Options.dualContextProperties | Uize.Widget.Options.fire | Uize.Widget.Options.get | Uize.Widget.Options.getBlankImageUrl | Uize.Widget.Options.instanceMethods | Uize.Widget.Options.instanceProperties | Uize.Widget.Options.mixins | Uize.Widget.Options.omegastructor | Uize.Widget.Options.set | Uize.Widget.Options.singleton | Uize.Widget.Options.spawn | Uize.Widget.Options.stateProperties | Uize.Widget.Options.staticMethods | Uize.Widget.Options.staticProperties | Uize.Widget.Options.subclass | Uize.Widget.Options.toggle | Uize.Widget.Options.treeInheritedStateProperties | Uize.Widget.Options.unwire | Uize.Widget.Options.wire

STATIC PROPERTIES

Uize.Widget.Options.busyParentTickle | Uize.Widget.Options.enabledParentTickle | Uize.Widget.Options.isWired | Uize.Widget.Options.pathToResources

1.2.4. Modules Directly Under This Namespace

Uize.Widget.Options.Accordion | Uize.Widget.Options.FilterGroup | Uize.Widget.Options.Popup | Uize.Widget.Options.Selector | Uize.Widget.Options.Tabbed

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Widget.Options module.

2. Instance Methods

2.1. addChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.2. addChildren

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.3. ajax

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.4. buildHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.5. callInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.6. childHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.7. childId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.8. confirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.9. displayNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.10. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.11. flushNodeCache

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.12. forAll

An iterator method that is provided as a convenience and that lets you iterate over all the option buttons for the instance.

SYNTAX

myInstance.forAll (iterationFUNC);

The function specified in the iterationFUNC parameter will be called on each iteration and can expect to receive two parameters for the current iteration: an object reference to the option button widget, and an integer representing the index of the option. The function does not need to return any value. However, if the function wishes to terminate the iteration, it can return the boolean value false.

EXAMPLE

myOptionsWidget.forAll (
  function (optionButton,optionNo) {
    optionButton.set ({enabled: optionNo % 2 ? 'inherit' : false});
  }
);

In the above example, the forAll instance method is being used to iterate over all the option buttons in order to disable every second option button - not a terribly practical example, but it illustrates the usage.

IMPLEMENTATION INFO

this feature was introduced in this module

2.13. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.14. getContainer

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.15. getHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.16. getInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.17. getNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.18. getNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.19. getNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.20. getOptionProperties

A hook method for subclasses to provide additional state properties to add to the general optionWidgetProperties for a specific child option button widget. The base implementation returns null.

SYNTAX

optionPropertiesOBJ = myInstance.getOptionProperties (valueNoINT, valueObjectOBJ);

valueNoINT contains the child widget button index. valueObjectOBJ is the object in the values state property at index valueNoINT.

This hook method is useful when a Uize.Widget.Options subclass wants specific data from each value object within the values state property passed to the option button child widget when it is created. This data is added to the optionWidgetProperties which are common accross all option buton child widgets.

EXAMPLE

_class.instanceMethods ({
  getOptionProperties:function (valueNo, valueObject) {
    return Uize.copyInto(
      _superclass.doMy (this,'getOptionProperties',[valueNo,valueObject]) || {},
      {
        value:valueObject.name,
        valueDetails:valueObject.valueDetails
      }
    );
  }
});

In the above example, the getOptionProperties hook method was overridden in a subclass to add value and valueDetails properties to the state properties that will be set on the option button child widget. These values are retrieved from the valueObjectOBJ.

IMPLEMENTATION INFO

this feature was introduced in this module

2.21. getProvider

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.22. getValueNoFromValue

Returns an integer, representing the index of the specified value in the values set. If the specified value is not one of the values in the values set, then this method returns -1.

SYNTAX

valueNoINT = myInstance.getValueNoFromValue (valueANYTYPE);

NOTES

See related getValueObject instance method

IMPLEMENTATION INFO

this feature was introduced in this module

2.23. getValueObject

Returns an object, representing the data attached to the specified value in the values set. If the specified value is not one of the values in the values set, then this method returns null.

SYNTAX

valueObjOBJ = myInstance.getValueObject (valueANYTYPE);

NOTES

See related getValueNoFromValue instance method

IMPLEMENTATION INFO

this feature was introduced in this module

2.24. globalizeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.25. inform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.26. injectNodeHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.27. insertOrWireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.28. insertUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.29. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.30. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.31. kill

Inherited from Uize.Widget, but introduced in Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Class)

2.32. localize

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.33. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.34. nodeId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.35. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.36. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.37. removeChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.38. removeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.39. removeUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.40. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.41. setInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.42. setNodeClipRect

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.43. setNodeInnerHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.44. setNodeOpacity

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.45. setNodeProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.46. setNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.47. setNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.48. showNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.49. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.50. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.51. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.52. unwireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.53. unwireNodeEventsByMatch

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.54. unwireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.55. updateUi

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget)

2.56. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

2.57. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.58. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.59. wireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.60. wireUi

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget)

3. Instance Events

3.1. Before Value Change

This event fires just as an option button is clicked, but before the value state property for the instance is updated.

This event offers the handler the opportunity to cancel the value change. The event contains a "value" property (which is the new value that would be set) and a "valueNo" property (which is the index of the new value that would be set). To cancel the set action, the handler can set the event object's "cancel" property to true. The handler can inspect the "value" and "valueNo" properties of the event to determine if the value change should be permitted.

3.2. Option Event

Fires each time an event fires for one of the option button child widgets.

When this event fires, the event object will have a "value" property whose value corresponds to the value associated with the option, as well as a "childEvent" property that carries the event object associated with the option button event.

4. State Properties

the initial value is undefined

NOTES

4.1. built

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.2. busy

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.3. busyInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.4. busyParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.5. children

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.6. container

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.7. enabled

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.8. enabledInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.9. enabledParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.10. ensureValueInValues

A boolean, indicating whether or not the value of the value state property should be one of the values within the values state property.

When this property is set to true, the value state property will be enforced to be within the values state property. If the value state property is set with a value not within the values state property, the first value within the values state property will be chosen. When this is property is set to false, the value is no longer restricted to be one of the values within the values state property.

NOTES

the initial value is false

IMPLEMENTATION INFO

this feature was introduced in this module

4.11. html

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.12. idPrefix

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.13. idPrefixConstruction

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.14. insertionMode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.15. localized

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.16. name

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.17. nodeMap

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.18. optionWidgetClass

An object reference to a widget class that should be used for the option buttons.

By default, the Uize.Widget.Button class is used for the option buttons. However, in some cases you may wish to use a class with richer functionality for the option buttons. You can create such a class by subclassing the Uize.Widget.Button class. If the widget class to be used for the option buttons is not a subclass of Uize.Widget.Button, then it will at least have to provide an equivalent interface in order to work with the Uize.Widget.Options class.

NOTES

when this property is set to null or left undefined, then the Uize.Widget.Button class will be used for option buttons
see the companion optionWidgetProperties state property
the initial value is undefined

IMPLEMENTATION INFO

this feature was introduced in this module

4.19. optionWidgetProperties

An object, specifying values for state properties that should be used when creating option button child widgets.

The optionWidgetProperties property lets you specify values for state properties that will be common to all option button widgets that are created. This can be useful in cases where you are using the optionWidgetClass state property to use a widget class other than Uize.Widget.Button for the option buttons, and where that other widget class may provide further configurability through additional state properties beyond what the Uize.Widget.Button class provides. In such cases, option button instances that are created for a particular Uize.Widget.Options instance can be configured for that instance by specifying state property values through the optionWidgetProperties property.

NOTES

see the companion optionWidgetClass state property
the initial value is undefined

IMPLEMENTATION INFO

this feature was introduced in this module

4.20. parent

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.21. setValueOnMouseover

A boolean, indicating whether or not the value of the value state property should be set when the user rests the mouse over an option, instead of the values of the tentativeValue and tentativeValueNo state properties.

When this property is set to true, the value state property will be set when the user rests the mouse over an option. When this property is set to false, null, 0, or left undefined, then the values of the tentativeValue and tentativeValueNo properties will be set.

When setValueOnMouseover is set to true, the user will not be required to click in order for a selection to be made. In such a case, if the tentativeRestTime property is set to 0, then the value property will be set immediately on mousing over an option. When tentativeRestTime is set to a value greater than 0, then the user will have to rest the mouse on the option for the amount of time specified by the tentativeRestTime property before the value property is set. Of course, the user can still click immediately after mousing over the option to expedite selection.

IMPLEMENTATION INFO

this feature was introduced in this module

4.22. tentativeRestTime

An integer, representing the time (in milliseconds) that the user must remain moused over an option button before the tentativeValue state property will be set to the value corresponding to that button.

NOTES

the special value of 0 indicates that the tentativeValue mechanism should be disabled
the initial value is 0

IMPLEMENTATION INFO

this feature was introduced in this module

4.23. tentativeValue

A value of any type, that represents the current value that is tentatively being set / considered by the user.

NOTES

the initial value is null
whenever the value state property is set, this property is also set to the same value
in "resting" state (i.e. when the user is not interacting with the widget), this property will have the same value as the value state property

IMPLEMENTATION INFO

this feature was introduced in this module

4.24. tentativeValueNo

An integer, representing the index of the current tentativeValue in the values set.

NOTES

the initial value is -1
when no value is selected, this property is set to -1
this property is read-only

IMPLEMENTATION INFO

this feature was introduced in this module

4.25. value

A simple type value (string, boolean, or number), that should either match one of the values in an array of simple type values specified by the values state property, or should match the name property of one of the objects in an array of object type values specified by the values state property.

NOTES

the initial value is null
whenever this property is set, the tentativeValue state property is set to the same value

IMPLEMENTATION INFO

this feature was introduced in this module

4.26. valueNo

An integer, representing the index of the current value in the values set.

NOTES

the initial value is -1
when no value is selected, this property is set to -1
this property is read-only

IMPLEMENTATION INFO

this feature was introduced in this module

4.27. values

An array of simple type values (string, boolean, or number) or objects, representing the value set for the widget.

EXAMPLE 1

myOptions.set ({values:['orange','avocadoPear','sweetPotato']});

In the above example, the values for myOptions is being set to an array of strings. In order to select the sweet potato value, one would use the statement myOptions.set ({value:'sweetPotato'}).

EXAMPLE 2

myOptions.set ({
  values:[
    {
      name:'orange',
      displayName:'Orange',
      category:'fruit'
    },
    {
      name:'avocadoPear',
      displayName:'Avocado Pear',
      category:'fruit'
    },
    {
      name:'sweetPotato',
      displayName:'Sweet Potato',
      category:'vegetable'
    }
  ]
});

When an array of objects is specified for the values state property, each object should contain a name property. Then, when setting a value for the value state property, the object from the values array will be selected whose name property matches the value of the value state property. In the above example, the values for myOptions is being set to an array of objects. In order to select the sweet potato value now, one would use the statement myOptions.set ({value:'sweetPotato'}).

NOTES

if this property is changed once the widget is already wired, then the widget will be unwired and then wired again
the initial value is [] (an empty array)

IMPLEMENTATION INFO

this feature was introduced in this module

4.28. wired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5. Instance Properties

5.1. showConfirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.2. showInform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

6. Static Methods

6.1. Uize.Widget.Options.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.2. Uize.Widget.Options.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.3. Uize.Widget.Options.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.4. Uize.Widget.Options.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.5. Uize.Widget.Options.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.6. Uize.Widget.Options.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.7. Uize.Widget.Options.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.8. Uize.Widget.Options.getBlankImageUrl

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.9. Uize.Widget.Options.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.10. Uize.Widget.Options.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.11. Uize.Widget.Options.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.12. Uize.Widget.Options.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.13. Uize.Widget.Options.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.14. Uize.Widget.Options.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.15. Uize.Widget.Options.spawn

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.16. Uize.Widget.Options.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.17. Uize.Widget.Options.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.18. Uize.Widget.Options.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.19. Uize.Widget.Options.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.20. Uize.Widget.Options.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.21. Uize.Widget.Options.treeInheritedStateProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.22. Uize.Widget.Options.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.23. Uize.Widget.Options.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

7. Static Properties

7.1. Uize.Widget.Options.busyParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

7.2. Uize.Widget.Options.enabledParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

7.3. Uize.Widget.Options.isWired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

7.4. Uize.Widget.Options.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

7.5. Uize.Widget.Options.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

7.6. Uize.Widget.Options.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

7.7. Uize.Widget.Options.undefined

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget)
this static feature is inherited by subclasses