aps/Message

Displays a status message.

This widget should be used ONLY in ``aps/MessageList``. See also the example in MessageList.

Compatibility

All user panels - CP and UX1

Overview

Types

Visual appearance of a message depends on its type, which is specified by the type property. There are standard types of messages:

Type	CCP version
danger	[1, 2]
warning	[1, 2]
info	[1, 2]
progress	[1]
success	[1, 2]
limits	[1]

For the full list of properties and methods refer to the Public Properties section.

Contents

A message may contain:

• Information - presented as plain text or as HTML. It is defined by the description property.

  RUN DEMO

  require(["aps/PageContainer", "aps/Message", "aps/ready!"],
    function(PageContainer, Message){
      "use strict";
  
      var page = new PageContainer({}, "main");
  
      page.get("messageList").addChild(new Message({
         description:   "Warning: Description is not entered",
         type:          "limits"
      }));
  
      page.startup();
  });
  

• Close icon - if the closeable property is set to true, then a cross displays at the upper-right corner of a message. You can close the message by clicking the cross.

  RUN DEMO

  require(["aps/PageContainer", "aps/Message", "aps/ready!"],
    function(PageContainer, Message){
      "use strict";
  
      var page = new PageContainer({}, "main");
  
      page.get("messageList").addChild(new Message({
         description:   "Text displayed on the screen",
         type:          "limits",
         closeable:     true
      }));
  
      page.startup();
  });
  

• Child elements - depending on the way your widgets are declared, child elements are defined as follows:

  • Nested array (declaration with help of the loader);
  • Using the addChild method (programmatic declaration);
  • A hierarchy of widgets corresponding to the hierarchy of DOMNodes (declarative syntax).

More detailed information on widget declaration see in Declarations.

Like all widgets that may have child elements, the MessageList widget has the removeChild method for removing a single child element and the removeAll method for removing all child elements.

Example

RUN DEMO

require(["aps/load", "aps/ready!"],
    function(load) {
        "use strict";

        load(["aps/PageContainer", [
            ["aps/Message", {
                description: "Warning<a href=\"javascript:void(0)\">Link</a>",
                escapeHTML: false,
                type: "warning"
            }],
            ["aps/Message", {
                description: "Error<a href=\"javascript:void(0)\">Link</a>",
                escapeHTML: false,
                type: "danger"
            }],
            ["aps/Message", {
                description: "Info<a href=\"javascript:void(0)\">Link</a>",
                escapeHTML: false,
                type: "info"
            }],
            ["aps/Message", {
                    description: "Limits<a href=\"javascript:void(0)\">Link</a>",
                escapeHTML: false,
                    type: "success"
                },
                [
                    ["aps/Button", {
                        label: "Button load"
                    }]
                ]
            ]
        ]]);
});

Public Properties

PROPERTY	TYPE	DEFAULT	DESCRIPTION
closeable	boolean	true	If true a closing icon will be shown.
description	string	“”	Simple text or innerHTML that describes message content.
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.
type	string	info	Type of display message.
visible	boolean	true	If this property value is set to true, then the widget is visible.

closeable boolean

If true a closing icon will be shown. Default value: true.

description string

Simple text or innerHTML that describes message content. Default value: “”.

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: “”.

type string

Type of display message. This information determines the icon and color of a message. Suppotred values are “warning”, “error”, “info”, “progress”, “update”, “limits”. Default value: “info”.

visible boolean

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

Default value: true.

Public Methods

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/_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 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

addChild

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 widget

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

focus

Focusing the focusable child

Return: aps/_containerbase function

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

getChildren

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

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

removeAll

Remove all children in the widget.

Return: undefined

removeChild

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

reset

Resets the widget.

Return: undefined

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

validate

Called by oninit, onblur, and onkeypress. Show missing or invalid messages if appropriate, and highlight textbox field.

Return: boolean

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/Memory

aps/MessageList →