Class ecm.widget.layout.MainLayout


Extends ecm.widget.layout.BaseLayout.
Provides the main layout for IBM Content Navigator or for similar desktop layouts. This class displays the launch bar that contains the features on the left side of the layout.
Defined in: <ecm\widget\layout\MainLayout.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 

Field Summary

Field Attributes Field Name and Description
 
Boolean indicating if the skip navigation links (required for accessibility) should be added to the document.

Method Summary

Method Attributes Method Name and Description
 
Returns an array of identifiers of the features supported by this layout.
 
Returns a handle to the ecm.widget.Banner widget in the layout.
 
Returns a handle to the ecm.widget.GlobalToolbar widget if there is one in the layout.
 
mergeFeatures(availableFeatures, selectedFeatures, defaultFeature)
Regroup features according to user selection.
 
An event invoked when the layout has finished loading.
 
 
setFeatures(selectedFeatures, defaultFeature)
Sets the feature configuration.
Methods borrowed from class ecm.widget.layout.BaseLayout:
constructor, createErrorDialog, createWarningDialog, destroy, focus, setDebugMode, setDemoMode, setShowWarnings

Constructor Detail

ecm.widget.layout.MainLayout()

Field Detail

includeSkipNavigationLinks

Boolean indicating if the skip navigation links (required for accessibility) should be added to the document.

Method Detail

getAvailableFeatures()

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

getBanner()

Returns a handle to the ecm.widget.Banner widget in the layout.
Deprecated:
As of 2.0.3. Use direct access to the banner. For example, myLayout.banner.

getGlobalToolbar()

Returns a handle to the ecm.widget.GlobalToolbar widget if there is one in the layout. It is an optional desktop setting to enable the global toolbar.
Deprecated:
As of 2.0.3. Use direct access to the global toolbar. For example, myLayout.globalToolbar.

mergeFeatures(availableFeatures, selectedFeatures, defaultFeature)

Regroup features according to user selection.
Parameters:
availableFeatures
selectedFeatures
defaultFeature

onLayoutLoaded()

An event invoked when the layout has finished loading.

postCreate()


setFeatures(selectedFeatures, defaultFeature)

Sets the feature configuration.
Parameters:
selectedFeatures
defaultFeature