BiBox

This layout component places its children from left to right for the horizontal box and from top to bottom for the vertical box. This is a fairly advanced layout component that takes preferred, minimum and maximum size of the children into account. It also takes margins into account and it uses margin collapsing so that two adjacent children share the larger margin.

This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiBox .

Constructor

new BiBox ( [ sOrient [ ,sAlign [ ,sPack ] ] ] )

Parameters

Name Type Optional Default Descripton
sOrient String checked Optional orientation of the layout
sAlign String checked Optional alignment of the children
sPack String checked Optional pack value

Properties

Name Type get set Descripton
align String checked checked The align property decides how to size and position the children. This describes the size and position in the orthogonal direction of the box orientation. For a horizontal box this describes the height and top position and for a vertical layout this describes the width and left position

Valid values are:

stretch
start
center
end
orient String checked checked The orientation to layout the children. Valid values are "horizontal" and "vertical". When set to "horizontal", rightToLeft is taken into account.
pack String checked checked This describes how to layout the controls when there are no flexing children and there is any remaining space. Valid values are:

start
center
end

Methods

None.

Events

None.

Static Methods

Name Description
getFlex Returns the dock value for the source
setFlex Sets the attached flex property for the source. A flex value of 0 means that the size is determined by the preferred size and no flexing occurs.

Static Fields

None.

Remarks

Static Method Details

getFlex

Returns the dock value for the source

Syntax

BiBox
 .
 getFlex
 (
 oSource
 )

Parameters

Name Type Optional Default Descripton
oSource BiObject The component to get the dock value for

Return Type

String

setFlex

Sets the attached flex property for the source. A flex value of 0 means that the size is determined by the preferred size and no flexing occurs.

Syntax

BiBox
 .
 setFlex
 (
 oSource,nFlex
 )

Parameters

Name Type Optional Default Descripton
oSource BiObject The component to set the dock value for
nFlex Number The flex value is used to tell how much of the remaining space the component should use.

Return Type

void