Class idx.layout.ButtonBar

Extends dijit._LayoutWidget, dijit._TemplatedMixin.
Button Bar Widget. Provides a button bar where buttons can be added to a "primary" and/or "secondary" region. The added buttons inherit the "placement" value of "primary" or "secondary. Currently ButtonBar does not have a "toolbar" or "special" region for a toolbar & special styling, respectively.
Defined in: <idx\layout\ButtonBar.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	alignment The alignment indicates the positioning of the primary buttons (either in in the "leading" or "trailing" position).
	defaultRegion The default region to place buttons that have no specified region.
	directionSensitive Indicates whether or not the button bar should be sensitive to the direction of the widget.
	primaryClass The CSS class applied as the first class to the container for the primary buttons.
	secondaryClass The CSS class applied as the first class to the container for the secondary buttons.

Method Summary

Method Attributes	Method Name and Description
	addChild(child, index) Specializes parent method by calling resize afterwards.
	buildRendering() Overridden to set state and setup nodes
	constructor(args, node) Handles the reading any attributes passed via markup.
	destroy() Override to cleanup handles.
	focus() Focuses the first button from the button bar that is not disabled and not hidden.
	layout() Pass through parent layout method
	onAnyClick(button, event) This function is called whenever any one of the buttons contained within is clicked.
	postCreate() postCreate - default behavior
	postMixInProperties() Overrides dijit._Widget.postMixInProperties() to ensure that the dijit._Widget.attr() function is called for each property that was set.
	removeChild(child) Specializes parent method by searching through primary and secondary buttons to find the button of interest for removal.
	startup() Called at startup to set state, init children and resize when done.

Constructor Detail

idx.layout.ButtonBar()

Field Detail

{String} alignment

The alignment indicates the positioning of the primary buttons (either in in the "leading" or "trailing" position). Whether the leading position is on the left or the right depends on the BiDi state. Settings this attribute to an unrecognized value will cause it to default to "leading". This is also changes the order in which the buttons are added.

Default Value:: "leading"

{String} defaultRegion

The default region to place buttons that have no specified region. This can be either "primary" or "secondary".

Default Value:: "primary"

directionSensitive

Indicates whether or not the button bar should be sensitive to the direction of the widget. In many themes, the button bar uses an "inline" layout which means the "leadingNode" and "trailingNode" automatically align themselves properly for right-to-left or left-to-right display. However, if the ButtonBar is not "inline" in some themes, then it may be neccessary to flip the meaning of "leading" and "trailing" if a right-to-left direction is detected.

{String} primaryClass

The CSS class applied as the first class to the container for the primary buttons.

Default Value:: "primary"

{String} secondaryClass

The CSS class applied as the first class to the container for the secondary buttons.

Default Value:: "secondary"

Method Detail

addChild(child, index)

Specializes parent method by calling resize afterwards.

Parameters:
{Widget} child
{int} index

See:: dijit._Widget.addChild

buildRendering()

Overridden to set state and setup nodes

See:: dijit._Widget.buildRendering

constructor(args, node)

Handles the reading any attributes passed via markup.

Parameters:
{Object} args
{Object} node

destroy()

Override to cleanup handles.

focus()

Focuses the first button from the button bar that is not disabled and not hidden.

layout()

Pass through parent layout method

See:: dijit._Widget.layout

onAnyClick(button, event)

This function is called whenever any one of the buttons contained within is clicked.

Parameters:
{Widget} button: The button that was clicked.
{Event} event: The click event which may be a double-click or single-click.

postCreate()

postCreate - default behavior

See:: dijit._Widget.postCreate

postMixInProperties()

Overrides dijit._Widget.postMixInProperties() to ensure that the dijit._Widget.attr() function is called for each property that was set.

See:: dijit._Widget.postMixInProperties

removeChild(child)

Specializes parent method by searching through primary and secondary buttons to find the button of interest for removal.

Parameters:
{Widget} child

See:: dijit._Widget.removeChild

startup()

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

See:: dijit._Widget.startup