Class idx.app.ConsoleLayout


Extends dijit._LayoutWidget, dijit._Templated, idx.app._ConsoleLoaderMixin.
Templated Widget for a basic InfoSphere styled application Uses supporting mixin to dynamically load from a registry and populate the UI in this template.
Defined in: <idx\app\ConsoleLayout.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 

Field Summary

Field Attributes Field Name and Description
 
Flag indicating if status bar area at bottom of console is visible
 
whether about link should be displayed or not
 
msg 
NLS messages
 
topic 
Dojo Topic name for notifications relating to application control
<constant>  
user name in marquee
<constant>  
vendor logo in marquee
<constant>  
vendor name in marquee
<constant>  
expanded marquee welcome message

Method Summary

Method Attributes Method Name and Description
 
addChild(child, index)
Extends parent method by adding in a resize after the child node is added.
 
Default constructor Note: If user sets inherited field "title".
 
Prepares this object to be garbage-collected
 
 
Method called when 'about' link is clicked
 
Method called when 'help' link is clicked
 
Method called when 'log out' link is clicked
 
Post rendering processing.
 
removeChild(child)
Extends parent method
 
resize(changeSize, resultSize)
Resize method that extends parent by also sizing the children

Constructor Detail

idx.app.ConsoleLayout()

Field Detail

{boolean} hasStatusBar

Flag indicating if status bar area at bottom of console is visible
Default Value:
false

{boolean} includeAbout

whether about link should be displayed or not
Default Value:
true

{Object} msg

NLS messages

{String} topic

Dojo Topic name for notifications relating to application control

<constant> {String} username

user name in marquee
Default Value:
null

<constant> {String} vendorLogo

vendor logo in marquee
Default Value:
"/resources/claro/vendorLogoWhite.png"

<constant> {String} vendorName

vendor name in marquee
Default Value:
"IBM ®"

<constant> {String} welcome

expanded marquee welcome message
Default Value:
""

Method Detail

addChild(child, index)

Extends parent method by adding in a resize after the child node is added.
Parameters:
{Object} child
{int} index
See:
dijit.layout._LayoutWidget.addChild

constructor(args)

Default constructor Note: If user sets inherited field "title". it will be used as the frame marquee/banner name as well as browser title (document.title).
Parameters:
{Object} args

destroy()

Prepares this object to be garbage-collected

layout()

See:
dijit.layout._LayoutWidget.layout

onAbout()

Method called when 'about' link is clicked

onHelp()

Method called when 'help' link is clicked

onLogout()

Method called when 'log out' link is clicked

postCreate()

Post rendering processing. Uses mixin to dynamically populate console

removeChild(child)

Extends parent method
Parameters:
{Object} child
See:
dijit.layout._LayoutWidget.removeChild

resize(changeSize, resultSize)

Resize method that extends parent by also sizing the children
Parameters:
{Object} changeSize
{Object} resultSize
See:
dijit.layout._LayoutWidget.resize