Class idx.layout.HeaderPane

Extends dijit._TemplatedMixin, dijit.layout.ContentPane, dijit.layout._LayoutWidget.
HeaderPane widget. Provides a non-collapsible container for a region of application content.
Defined in: <idx\layout\HeaderPane.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	idx.layout.HeaderPane()

Field Summary

Field Attributes	Field Name and Description
	autoHeight Set this to true when the HeaderPane should compute its height as a function of the height of its contained content.
	autoHideActions Set this to true if you want the actions in the title to disappear when the pane is not focused or hovered.
	closable Specifies whether the pane should have a button added to the title actions region with placement=toolbar and buttonType=close with that button's "onClick" event linked to this title pane's close() method.
	contentFocus Set this to false if you want focus to path straght through to the child widgets without having keyboard navigation stop at the content region to allow screan readers to easily read the content.
	defaultActionDisplay The default action displayMode to be set on buttons for the default actions such as "closable", "resizable", "helpURL, and "refreshable".
	helpURL URL for a help document.
	refreshable Specifies whether the pane is refreshable.
	resizable Specifies whether the pane is resizable.
	resizeDuration Sets the interval in milliseconds for animating the resize event if resizable.
	tabIndex The tab index to use for selecting the content area to help with keyboard scrolling navigation.

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.
	buildRendering() Overridden to call setup nodes after calling parent.
	constructor(args, node) Constructor Handles the reading any attributes passed via markup.
	destroy() Overridden to handle destorying the many handles and actions associated with the HeaderPane.
	get(name, value) Allow replacement of the title node.
	getMajorActionChildren() Returns the children that are in the "majorActions" region.
	getMinorActionChildren() Returns the children that are in the "minorActions" region.
	getTitleActionChildren() Returns the children that are in the "titleActions" region.
	layout() Pass through to call the idx.border.BorderLayout 'layout' method
	maximizePane(container) Maximizes this TitlePane to fill its container, typically a parent or ancestor node.
	onMaximize() Callback to be called when maximized.
	onRefresh(pane, href, deferred) Attach to this to be alerted to "refresh" button events.
	onRestore() Callback to be called when restored.
	postCreate() postCreate - default behavior
	postMixInProperties() postMixinProperties - default behavior
	removeChild(child) Extends parent method
	resize(changeSize, resultSize) Resize method that extends parent by also sizing the children as well as calling the contained borderLayout 'layout' method.
	restorePane() Restores this TitlePane to to its previous size.
	set(name, value) Allow replacement of the title node.
	setOptimalSize() Call this method to have the HeaderPane adjust its size to what is optimizal to display its content.
	startup() Called at startup to create an idx.border.BorderLayout given the input arguments.

Constructor Detail

idx.layout.HeaderPane()

See:: idx.border.BorderLayout

Field Detail

{boolean} autoHeight

Set this to true when the HeaderPane should compute its height as a function of the height of its contained content.

Default Value:: false

{boolean} autoHideActions

Set this to true if you want the actions in the title to disappear when the pane is not focused or hovered.

Default Value:: true

{Boolean} closable

Specifies whether the pane should have a button added to the title actions region with placement=toolbar and buttonType=close with that button's "onClick" event linked to this title pane's close() method.

Default Value:: false

contentFocus

Set this to false if you want focus to path straght through to the child widgets without having keyboard navigation stop at the content region to allow screan readers to easily read the content.

defaultActionDisplay

The default action displayMode to be set on buttons for the default actions such as "closable", "resizable", "helpURL, and "refreshable". This can control whether you view buttons only, buttons and icons or icons only. You can set the default display mode globally for the "toolbar" buttons using idx.buttons.

{String} helpURL

URL for a help document. If provided then a button is added to the title actions with the placement=toolbar and buttonType=help with the button's "onClick" event configured to open a new browser window with the specified URL.

Default Value:: ""

{Boolean} refreshable

Specifies whether the pane is refreshable. If so, then a button is added to the title actions region with placement=toolbar and buttonType=refresh with the button's "onClick" event linked to this title pane's "refreshPane" function.

Default Value:: false

{Boolean} resizable

Specifies whether the pane is resizable. If so, then a button is added to the title actions region with placement=toolbar and buttonType=maxRestore with the button's "onClick" event linked to this title pane's "maximizePane" and "restorePane" funtions.

Default Value:: false

resizeDuration

Sets the interval in milliseconds for animating the resize event if resizable. If this is set to zero (0) or a negative number then no animation is used.

tabIndex

The tab index to use for selecting the content area to help with keyboard scrolling navigation.

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.TitlePane.addChild

buildRendering()

Overridden to call setup nodes after calling parent.

See:: dijit.layout.ContentPane.buildRendering

constructor(args, node)

Constructor Handles the reading any attributes passed via markup.

Parameters:
{Object} args
{Object} node

destroy()

Overridden to handle destorying the many handles and actions associated with the HeaderPane.

get(name, value)

Allow replacement of the title node.

Parameters:
{String} name
{String} value

getMajorActionChildren()

Returns the children that are in the "majorActions" region.

getMinorActionChildren()

Returns the children that are in the "minorActions" region.

getTitleActionChildren()

Returns the children that are in the "titleActions" region.

layout()

Pass through to call the idx.border.BorderLayout 'layout' method

See:: dijit.layout.ContentPane.layout

maximizePane(container)

Maximizes this TitlePane to fill its container, typically a parent or ancestor node.

Parameters:
container: -- The container to fill.

onMaximize()

Callback to be called when maximized.

onRefresh(pane, href, deferred)

Attach to this to be alerted to "refresh" button events.

Parameters:
pane
href
deferred

onRestore()

Callback to be called when restored.

postCreate()

postCreate - default behavior

See:: dijit.layout.ContentPane.postCreate

postMixInProperties()

postMixinProperties - default behavior

See:: dijit.layout.ContentPane.postMixinProperties

removeChild(child)

Extends parent method

Parameters:
{Object} child

See:: dijit.layout.ContentPane.addChild

resize(changeSize, resultSize)

Resize method that extends parent by also sizing the children as well as calling the contained borderLayout 'layout' method.

Parameters:
{Object} changeSize
{Object} resultSize

See:: dijit.layout.ContentPane.resize

restorePane()

Restores this TitlePane to to its previous size.

set(name, value)

Allow replacement of the title node.

Parameters:
{String} name
{String} value

setOptimalSize()

Call this method to have the HeaderPane adjust its size to what is optimizal to display its content.

startup()

Called at startup to create an idx.border.BorderLayout given the input arguments.