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.

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);

This event fires just as an option button is clicked, but before the value set-get 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.

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.

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

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

The optionWidgetProperties property lets you specify values for set-get 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 set-get 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 set-get 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 set-get property values through the optionWidgetProperties property.

NOTES

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

When this property is set to true, the value set-get 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.

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

NOTES

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

NOTES

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

NOTES

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 set-get property, or should match the name property of one of the objects in an array of object type values specified by the values set-get property.

NOTES

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

NOTES

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 set-get property, each object should contain a name property. Then, when setting a value for the value set-get property, the object from the values array will be selected whose name property matches the value of the value set-get 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