Previous topic

aps/Store

Next topic

aps/Tab

aps/Switch

Widget that is used to indicate and change the status of other widgets.

Compatibility

Overview

If you want to enable users to switch a plain widget or a widget container to the on/off or enable/disable status, an effective way is to use the aps/Switch widget. Customizing its onClick handler, you can influence the above mentioned widgets.

The status property of the aps/Switch widget allows you to display 3 different static statuses:

  • on

  • off

  • failed to switch

Additionally, it can indicate two intermediate statuses:

  • enabling

  • disabling

A user can toggle the statical status (on/off) of the widget by clicking on the widget.

In the JS code, you can analyze the status property and define the status mapping to its visualization by means of the statusInfo set:

  • status - reflects the current status with the following possible values:

    • on

    • off - default value

    • disabling

    • offByError

    • enabling

  • statusInfo - defines a label for each status. Default values are as follows:

    statusInfo: {
   on: {
     label: "ON"
   },
   disabling: {
     label: "OFF"
   },
   off: {
     label: "OFF"
   },
   offByError: {
     label: "OFF"
   },
   enabling: {
     label: "ON"
   }
}

Example

The rules of transition between statuses are defined in the onClick method. You can redefine it as in the following example.

RUN DEMO

require(["aps/load", "aps/ready!"],
    function(load) {
    load(["aps/Panel", [
        ["aps/FieldSet", [
            ["aps/Switch", {
                onClick: function(){
                    var self = this;
                    switch(this.status){
                        case "on":
                            this.set("status", "disabling");
                            setTimeout(function(){ self.set("status", "off"); }, 700);
                            break;
                        case "disabling":
                            break;
                        case "off":
                            this.set("status", "enabling");
                            setTimeout(function(){ self.set("status", "on"); }, 700);
                            break;
                        case "offByError":
                            this.set("status", "enabling");
                            setTimeout(function(){ self.set("status", "on"); }, 700);
                            break;
                        case "enabling":
                            break;
                    }
                }
    }]]]]]);
});

Public Properties

PROPERTY

TYPE

DEFAULT

DESCRIPTION

disabled

boolean

false

Specifies if the widget will respond to user input.

gridSize

string

undefined

This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles.

isBusy

boolean

false

If the widget is busy then this property is true.

label

string

“”

Text that is shown as a label if the widget is placed inside a aps/FieldSet.

status

string

off

Reflects the current status.

statusInfo

object

{}}

Describes statuses.

visible

boolean

true

If this property value is set to true, then the widget is visible.

disabled boolean

Specifies if the widget will respond to user input.

Default value: false.

gridSize string

This specifies the widget width that is relevant only for widgets inside Container, FieldSet, or Tiles. In other cases it will be ignored.

gridSize string contains few options with number values (from 1 to 12) separated by spaces, which specify the grid size of the widget in different layouts:

- md - desktop

- xs - phone

For example, gridSize: “md-4 xs-2”.

All values below 1, e.g. “md-0”, will be replaced with the empty string (“”), values above 12, e.g. “md-14”, will be reduced to 12 (“md-12”).

Default value: undefined.

isBusy boolean

If the widget is busy then this property is true.

Default value: false.

label string

Text that is shown as a label if the widget is placed inside a aps/FieldSet.

Default value: “”.

status string

Reflects the current status. Possible values are: on, off, disabling, offByError, enabling. Default value: “off”.

statusInfo object

Describes statuses. For instance, statusInfo.on.label is a text displayed when the current status is “on”. Default value: {}}.

visible boolean

If this property value is set to true, then the widget is visible.

Default value: true.

Public Methods

METHOD

RETURN

DESCRIPTION

cancel ()
object

Sets the isBusy property to false

destroy ()
undefined

Destroys this widget

get ()
any

Get a property of the Stateful instance

getParents ()
array

Discover and return all parents of the widget

placeAt ()
dijit/_widgetbase
function

Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions

set ()
object
function

Set a property of the Stateful instance

startup ()
undefined

Gets started after the DOM fragment is added to the document

cancel

Sets the isBusy property to false.

Return: object

destroy

Destroys this widget. Will also destroy any resources (including widgets) registered via this.own(). This method will also destroy internal widgets such as those created from a template.

Return: undefined

get

Get a property of the Stateful instance. Get a named property of the Stateful object. The property may potentially be retrieved via a getter method in subclasses.

In the base class, this just retrieves the object’s property.

Return: any

getParents

Discover and return all parents of the widget.

Return: array

placeAt

Place this widget somewhere in the DOM based on standard dojo/dom-construct::place() conventions. A convenience function providing a simple shorthand mechanism to put an existing (or newly created) widget somewhere in the DOM, and allow chaining.

Return: dijit/_widgetbase function

set

Set a property of the Stateful instance. Sets named properties of the stateful object and notifies the watchers of the property. A programmatic setter may be defined in subclasses.

Return: object function

startup

Gets started after the DOM fragment is added to the document Called after the widget and its children have been created and added to the page, and all related widgets have finished their create() cycle, up through postCreate().

Note that startup() may be called while the widget is still hidden, for example if the widget is inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. For widgets that need to do layout, it’s best to put that layout code inside resize(), and then extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible.

Return: undefined

Public Events

EVENT

RETURN

DESCRIPTION

onClick ()
undefined

The method is called when a user clicks on the widget

onClick

The method is called when a user clicks on the widget.

aps/Tab →