Class idx.border.BorderLayout
Defined in: <idx\border\BorderLayout.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Utility module for helping widgets that wish to use a border-container layout.
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The node representing the bottom region of the border.
|
|
The node representing the center region of the border layout.
|
|
The idx.border.BorderDesign describing the type of border layout being employed.
|
|
The node representing the outer frame of the border.
|
|
The node representing the left region of the border.
|
|
The node representing the right region of the border.
|
|
The node representing the top region of the border.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
computeOptimalHeight(excludeCenter)
Computers the optimal height of the frame node, optionally excluding the center region from
the calculation.
|
|
computeOptimalWidth(excludeCenter)
Computers the optimal width of the frame node, optionally excluding the center region from
the calculation.
|
|
constructor(args)
Constructs an instance with the specified arguments.
|
|
layout()
Performs the layout with the nodes specified in the constructor to this instance
by assigning the border and center nodes the proper styling.
|
|
setOptimalHeight(excludeCenter)
Sets the optimal height on the framing node based on the computed optimal heights of the regions.
|
|
Sets the optimal width and height on the framing node based on the computed optimal widths and
heights of the regions.
|
|
setOptimalWidth(excludeCenter)
Sets the optimal width on the framing node based on the computed optimal widths of the regions.
|
Constructor Detail
idx.border.BorderLayout()
Utility module for helping widgets that wish to use a border-container layout.
This module allows you to create an instance and set the nodes that represent
the various regions. It also provides more border layout options that the
standard border container (see idx.border.BorderDesign)
Field Detail
{Node} bottomNode
The node representing the bottom region of the border. If not specified then this region is
assumed to be absent.
{Node} centerNode
The node representing the center region of the border layout. This node is required.
{idx.border.BorderDesign} design
The idx.border.BorderDesign describing the type of border layout being employed. If
this is specified as a String in the constructor, then an attempt is made to create
a BorderDesign instance from it.
{Node} frameNode
The node representing the outer frame of the border. This node is required.
{Node} leftNode
The node representing the left region of the border. If not specified then this region is
assumed to be absent.
{Node} rightNode
The node representing the right region of the border. If not specified then this region is
assumed to be absent.
{Node} topNode
The node representing the top region of the border. If not specified then this region is
assumed to be absent.
Method Detail
computeOptimalHeight(excludeCenter)
Computers the optimal height of the frame node, optionally excluding the center region from
the calculation.
- Parameters:
- {Boolean} excludeCenter
- Set to true of the center region should be excluded in the calculation and false if it should be included.
computeOptimalWidth(excludeCenter)
Computers the optimal width of the frame node, optionally excluding the center region from
the calculation.
- Parameters:
- {Boolean} excludeCenter
- Set to true of the center region should be excluded in the calculation and false if it should be included.
constructor(args)
Constructs an instance with the specified arguments.
- Parameters:
- {Object} args
- The arguments to mix in.
layout()
Performs the layout with the nodes specified in the constructor to this instance
by assigning the border and center nodes the proper styling.
setOptimalHeight(excludeCenter)
Sets the optimal height on the framing node based on the computed optimal heights of the regions.
- Parameters:
- {Boolean} excludeCenter
- Set to true of the center region should be excluded in the calculation and false if it should be included.
setOptimalSize()
Sets the optimal width and height on the framing node based on the computed optimal widths and
heights of the regions.
setOptimalWidth(excludeCenter)
Sets the optimal width on the framing node based on the computed optimal widths of the regions.
- Parameters:
- {Boolean} excludeCenter
- Set to true of the center region should be excluded in the calculation and false if it should be included.