This widget container is mainly used to align a set of widgets into a column or in a row unlike the aps/Container that aligns widgets only in a row. The allowed child widgets are ``aps/Output`` and ``aps/Status``.
Table of contents
UX1 only
With this widget, it is possible to align widgets containing output text as needed:
aps/ContainerAlso, it is possible to align the output to the left or right position.
require(["aps/load", "aps/Memory", "dojox/mvc/StatefulArray", "aps/ready!"],
function(load, Memory, StatefulArray){
"use strict";
load(
["aps/Tiles", [
["aps/Tile", [
["aps/MultiLine", {
listStyle: 'ordered', // 'unordered', 'unstyled', 'inline'
contentAlign: 'left' // 'right'
}, [
["aps/Output", { content: "VPS-101" }],
["aps/Output", { content: "VPS-102" }],
["aps/Output", { content: "VPS-103" }]
]]]]]]);
});
require(["aps/load", "aps/Memory", "dojox/mvc/StatefulArray", "aps/ready!"],
function(load, Memory, StatefulArray){
"use strict";
load(
["aps/Tiles", [
["aps/Tile", [
["aps/MultiLine", {
listStyle: 'inline', // 'unordered', 'unordered', 'unstyled'
contentAlign: 'left' // 'right'
}, [
["aps/Output", { content: "VPS-102" }],
["aps/Status"]
]]]]]]);
});
| PROPERTY | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|
| contentAlign | string | 'left' | The content alignment. |
| 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. |
| listStyle | string | 'unstyled' | Defines one of the following list styles:
- 'ordered' - in the visual representation, every item will be numbered.
|
| visible | boolean | true | If this property value is set to true, then the widget is visible. |
The content alignment. The possible values are ‘left’ and ‘right’. Default value: ‘left’.
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.
Text that is shown as a label if the widget is placed inside a aps/FieldSet.
Default value: “”.
Defines one of the following list styles:
- 'ordered' - in the visual representation, every item will be numbered.
- 'unordered' - in the visual representation, this will be a list of bullet items.
- 'unstyled' - in the visual representation, this will be a pure list of items without numbers or bullets.
- 'inline' - the list is aligned in a single row.
Default value: 'unstyled'.
If this property value is set to true, then the widget is visible.
Default value: true.
| METHOD | RETURN | DESCRIPTION |
|---|---|---|
| addChild (child, insertIndex) | undefined
|
Adds a given widget to the list |
| cancel () | object
|
Sets the isBusy property to false |
| destroy () | undefined
|
Destroys this widget |
| focus () | aps/_containerbase
function
|
Focusing the focusable child |
| get () | any
|
Get a property of the Stateful instance |
| getChildren () | array
|
Returns all direct children of this widget, i |
| 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 |
| removeAll () | undefined
|
Remove all children in the widget |
| removeChild (widget) | undefined
|
Removes a specified child widget instance from the list and destroys that widget |
| reset () | undefined
|
Resets the widget |
| set () | object
function
|
Set a property of the Stateful instance |
| startup () | undefined
|
Gets started after the DOM fragment is added to the document |
| validate () | boolean
|
Called by oninit, onblur, and onkeypress |
Adds a given widget to the list. Inserts the DOM node of a specified widget as a child to the container DOM node and possibly does other processing (such as layout).
Return: undefined
| ARGUMENT | TYPE | DESCRIPTION |
|---|---|---|
child |
Widget
|
Child widget |
insertIndex |
Number
String
|
Position child in the parent node |
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 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
Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget. Note that it returns not all descendetns, but only the direct children. Analogous to Node.childNodes, except containing widgets rather than DOMNodes.
The result intentionally excludes internally created widgets (a.k.a. supporting widgets) outside of this.containerNode.
Note the returned array is a simple array. The application code should not assume existence of methods like forEach().
Return: array
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
Removes a specified child widget instance from the list and destroys that widget. You can also pass in an array index within the list, for example, ``removeChild(5)`` removes the sixth widget.
Return: undefined
| ARGUMENT | TYPE | DESCRIPTION |
|---|---|---|
widget |
Widget
int
|
Child widget or index |
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
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
Called by oninit, onblur, and onkeypress. Show missing or invalid messages if appropriate, and highlight textbox field.
Return: boolean
| EVENT | RETURN | DESCRIPTION |
|---|---|---|
| onClick () | undefined
|
The method is called when a user clicks on the widget |
The method is called when a user clicks on the widget.