This is a container for widgets that allows to assign and show labels near those widgets. The widget is similiar to ``dojox/layout/TableContainer``.
Child widgets can use some context sensitive attributes as explained in the Context Sensitive Properties section.
Table of contents
All user panels - CP and UX1
The aps/FieldSet container allows you to wrap a set of widgets with individual labels and description.
If the value of the required property of a right column element is true, then an asterisk *
symbol will be added to the label of this element in the left column.
Find the nested rules for this widget in the recommended :ref:ui_widget_hierarchy`.
Key specifics:
aps/Button) gets the label attribute that is
displayed as the widget title.aps/Button) gets the optionalText attribute.
The optionalText attribute is a string that is displayed only when required attribute of the child widget
is set to false and there is a label attribute value in this widget.hint attribute, but this attribute is deprecated and replaced by description.description attribute.
That will be a text shown below the origin widget.Depending on the way your widgets are declared, child elements are added as explained in Declarations.
In the simplest case, an aps/FieldSet is just a two-column table:
require(["aps/load", "aps/ready!"],
function(load){
"use strict";
load(["aps/PageContainer", [
["aps/Panel", [
[ "aps/FieldSet", [
[ "aps/Output", { label: "OS", value: "CentOS 6 (x86_64)" } ],
[ "aps/Output", { label: "Source Image", value: "Silver" } ] ]
]
]]
]]);
});
You may disable output of the labels. To do this, you need to set
the showLabels property to false.
require(["aps/load", "aps/ready!"],
function(load){
"use strict";
load(["aps/PageContainer", [
["aps/Panel", [
["aps/FieldSet", { showLabels: false }, [
[ "aps/Output", { label: "OS", value: "CentOS 6 (x86_64)" } ],
[ "aps/Output", { label: "Source Image", value: "Silver" } ]]
]
]]
]]);
});
In addition to grouping widgets, the aps/FieldSet widget may also display a title
(the title property), a description (description) and supplemental
information (hint).
require(["aps/load", "aps/ready!"],
function(load){
"use strict";
load(['aps/PageContainer', [
["aps/Panel", [
["aps/FieldSet", {
title: "Downloads",
description: "Active downloads",
hint: "Speed limit enabled" }, [
["aps/Output", { label: "OS", value: "CentOS 6 (x86_64)" }],
["aps/Output", { label: "Source Image", value: "Silver" }]
]]]]]]);
});
To display a horizontal line above a FieldSet which does not have
a title text, you need to set the title property to true.
require(["aps/load", "aps/ready!"],
function(load){
"use strict";
load(["aps/PageContainer", [
["aps/Panel", [
["aps/FieldSet", { title: true }, [
[ "aps/Output", { label: "OS", value: "CentOS 6 (x86_64)" }],
[ "aps/Output", { label: "Source Image", value: "Silver" }]
]]
]]
]]);
});
require(["aps/FieldSet", "aps/Output", "aps/PageContainer", "aps/ready!"],
function(FieldSet, Output, PageContainer){
"use strict";
var page = new PageContainer();
page.placeAt("main");
var simpleText = new FieldSet({
title: "Form Elements -> Simple Text",
description: "The element is used for showing (not entering) object property."
});
simpleText.addChild(new Output({
label: "Contact name",
value: "Customer Name"
}));
simpleText.addChild(new Output({
label: "E-mail address",
content: "<a href='#'>customer@domain.dom</a>"
}));
simpleText.addChild(new Output({
label: "Status",
content: "<i class='indent-icon'><img src='ok.png' alt></i><span>Active</span>"
}));
simpleText.addChild(new Output({
label: "Traffic",
value: "0 B/month used of Unlimited"
}));
page.addChild(simpleText);
page.startup();
});
| PROPERTY | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|
| collapsed | boolean | false | If this property value is set to “false”, the inner part of the widget is visible. |
| collapsible | boolean | false | A container may provide a user an ability to collapse its content and leave only the title visible. |
| description | string | “” | Text under the header of the Container and over the content of the Container. |
| 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. |
| hint | string | “” | It contains supplemental information. |
| isBusy | boolean | false | If the widget is busy then this property is true. |
| label | string | “” | Text that is shown in aps. |
| showLabels | boolean | true | If true - the widget shows labels of children. |
| title | string | “” | Text that is shown in the header of the Container. |
| visible | boolean | true | If this property value is set to true, then the widget is visible. |
If this property value is set to “false”, the inner part of the widget is visible. Default value: false.
A container may provide a user an ability to collapse its content and leave only the title visible. Default value: false.
Text under the header of the Container and over the content of the Container. Default value: “”.
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.
It contains supplemental information. Deprecated in CCP v2. Default value: “”.
Text that is shown in aps.FieldSet. Don’t shown in the header of the Container. Default value: “”.
If true - the widget shows labels of children. Default value: true.
Text that is shown in the header of the Container. Don’t shown in aps.FieldSet. Default value: “”.
If this property value is set to true, then the widget is visible.
Default value: true.
| METHOD | RETURN | DESCRIPTION |
|---|---|---|
| addChild (child, insertIndex) | undefined
|
Makes the given widget a child of this widget |
| cancel () | object
|
Sets the isBusy property to false |
| destroy () | undefined
|
Destroys this widget |
| focus () | aps/_container
function
|
Focusing on the focusNode of the first suitable 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 the passed widget instance from this widget and destroys it |
| 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 |
Makes the given widget a child of this widget. Inserts specified child widget’s dom node as a child of this widget’s container 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 the passed widget instance from this widget and destroys it. You can also pass in an integer indicating the index within the container to remove (ie, 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.