Class idx.layout.TitlePane

Extends dijit.TitlePane, dijit.layout._LayoutWidget.
Collapsible title pane. This extends the dijit.TitlePane to provide additional features.
Defined in: <idx\layout\TitlePane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	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.
	collapsible Controls whether or not you can collapse the pane.
	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.

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 set state and setup nodes
	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.
	getTitleActionChildren() Returns the children that are in the "titleActions" region.
	layout() Pass through parent layout method Checks to see if single child first.
	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.
	restorePane() Restores this TitlePane to to its previous size.
	set(name, value) Allow replacement of the title node.
	startup() Called at startup to set state, init children and resize when done.
	toggle() Toggles whether the pane is collapsed or open

Constructor Detail

idx.layout.TitlePane()

Field Detail

{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

{boolean} collapsible

Controls whether or not you can collapse the pane. If not collapsible, then even the toggle button is not shown.

Default Value:: true

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.

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 set state and setup nodes

See:: dijit.TitlePane.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

getTitleActionChildren()

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

layout()

Pass through parent layout method Checks to see if single child first.

See:: dijit._Widget.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.TitlePane.postCreate

postMixInProperties()

postMixinProperties - default behavior

See:: dijit.TitlePane.postMixinProperties

removeChild(child)

Extends parent method

Parameters:
{Object} child

See:: dijit.TitlePane.remove3Child

resize(changeSize, resultSize)

Resize method that extends parent by also sizing the children.

Parameters:
{Object} changeSize
{Object} resultSize

See:: dijit.layout._LayoutWidget.resize

restorePane()

Restores this TitlePane to to its previous size.

set(name, value)

Allow replacement of the title node.

Parameters:
{String} name
{String} value

startup()

Called at startup to set state, init children and resize when done.

See:: dijit.TitlePane.startup

toggle()

Toggles whether the pane is collapsed or open

See:: dijit.TitlePane.toggle