Class idx.layout._Dockable

Mix-in class for dockable child widgets.
Defined in: <idx\layout\_Dockable.js>.

Constructor Summary

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

Field Summary

Field Attributes Field Name and Description
 
delay 
Dragging pixel amount before starting undocking.
 
dockArea 
Docking area.
 
dragNode 
Node that users can drag
 
topicId 
Topic ID for events being published during undocking/docking operations.

Method Summary

Method Attributes Method Name and Description
 
beforeDock()
Callback to be called before docking.
 
onDock(region)
Callback to be called on docking.
 
onUndock(region)
Callback to be called on undocking.
 
position(x, y)
Positions the widget.

Constructor Detail

idx.layout._Dockable()

Field Detail

{Number} delay

Dragging pixel amount before starting undocking.
Default Value:
10

{String} dockArea

Docking area. One of "left", "right", "top", "bottom", and "float"
Default Value:
""

{Element} dragNode

Node that users can drag
Default Value:
null

{String} topicId

Topic ID for events being published during undocking/docking operations. Specify this to differentiate if using two or more DockContainer.
Default Value:
""

Method Detail

beforeDock()

Callback to be called before docking.

onDock(region)

Callback to be called on docking.
Parameters:
{String} region

onUndock(region)

Callback to be called on undocking.
Parameters:
{String} region

position(x, y)

Positions the widget.
Parameters:
{Numner} x
y