Class ecm.widget.layout.BaseLayout

Extends dijit.layout._Widget, dijit._TemplatedMixin, dijit._WidgetsInTemplateMixin.
Provides the base class from which all other layout widgets are derived. New layout widgets can extend this BaseLayout widget to obtain base layout functionality. Base functionality includes:

Ability to enable demo and debug modes
Processing and error dialog setup
Login/Logout Handling
Session timeout handling

Layouts that extend the ecm.widget.layout.BaseLayout class must define a template. This template must include an instance of the ecm.widget.LoginPane class and a main display panel within a Dojo stack container. See the ecm.widget.layout.MainLayout class for an example.

Defined in: <ecm\widget\layout\BaseLayout.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.layout.BaseLayout()

Method Summary

Method Attributes	Method Name and Description
	constructor()
	createErrorDialog() Creates the error dialog used to render error messages in this layout
	createWarningDialog() Creates the dialog used to render warning messages in this layout.
	destroy()
	focus()
	getAvailableFeatures() Returns an array of identifiers of the features supported by this layout.
	postCreate()
	setDebugMode(val) Sets debug level according to the supplied value.
	setDemoMode(val) Sets demo mode according to the supplied value.
	setFeatures(features, defaultFeature) Sets the features to be displayed by this layout.
	setShowWarnings(showWarnings) Enables the automatic display of warning messages added to the desktop.

Constructor Detail

ecm.widget.layout.BaseLayout()

Method Detail

constructor()

createErrorDialog()

Creates the error dialog used to render error messages in this layout

createWarningDialog()

Creates the dialog used to render warning messages in this layout.

Since:: 2.0.3.3

destroy()

focus()

getAvailableFeatures()

Returns an array of identifiers of the features supported by this layout.

postCreate()

setDebugMode(val)

Sets debug level according to the supplied value.

Parameters:
val: Boolean value indicating whether debug mode is enabled or disabled.

setDemoMode(val)

Sets demo mode according to the supplied value.

Parameters:
val: Boolean value indicating whether demo mode is enabled or disabled.

setFeatures(features, defaultFeature)

Sets the features to be displayed by this layout. Implemented by subclasses. The BaseLayout implementation does nothing.

Parameters:
features: an array of identifiers for the features supported by this layout.
defaultFeature: the identifier of the feature to initially show

setShowWarnings(showWarnings)

Enables the automatic display of warning messages added to the desktop.

Parameters:
showWarnings: Indicates whether to automatically display warning messages added to the desktop

Since:: 2.0.3.3