BiSplitPane

A split pane is used to show two components with a splitter between them. The splitter between the components can be dragged and in that way the components are resized. In right-to-left mode, with horizontal orientation, the components switch places.

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

Constructor

new BiSplitPane ( [ sOrientation [ ,oLeftComponent [ ,oRightComponent ] ] ] )

Parameters

NameTypeOptionalDefaultDescripton
sOrientationStringcheckedThe orientation of the split pane. Valid values are horizontal and vertical.
oLeftComponentBiComponentcheckedThe component to place to the left of the splitter. If the orientation is vertical this is placed at the top.
oRightComponentBiComponentcheckedThe component to place to the right of the splitter. If the orientation is vertical this is placed at the bottom.

Properties

NameTypegetsetDescripton
bottomComponentBiComponentcheckedcheckedThe component below (or to the right if hoizontal orientation) the splitter. This property is the same as rightComponent.
bottomVisibleBooleancheckedcheckedSets whether to show the bottom component. If this is false the top component will take up the entire space of the split pane and the splitter will be hidden. This property is the same as rightVisible.
dividerLocationNumbercheckedcheckedThe location, in pixels, of the splitter from the left if horizontal orientation and from the top if vertical orientation. If right to left is used this is from the right instead of from the left.
dividerLocationPercentNumbercheckedcheckedSimilar to dividerLocation but using percent instead of pixels.
dividerSizeNumbercheckedcheckedThe width of the divider (height if vertical orientation)
fixedComponentStringcheckedcheckedThe component to fix size for. Valid values are "left", "right" and "none". The value none will make both components resize relative to each other. You can set this with the values "first" and "top", which are then translated to "left", just as the values "second" and "bottom" are translated to "right". Default value is "left"
leftComponentBiComponentcheckedcheckedThe component to the left (or top if vertical orientation) of the splitter. This property is the same as topComponent.
leftVisibleBooleancheckedcheckedWhether to show the left component. If this is false the right component will take up the entire space of the split pane and the splitter will be hidden.
orientationStringcheckedcheckedThe orientation of the split pane. Valid values are horizontal and vertical. If horizontal is used the components are placed to the left and to the right of the splitter respectively. When vertical the components are placed above and below. When using horizontal and right to left the position of the left and right components are switched.
rightComponentBiComponentcheckedcheckedThe component to the right (or bottom if vertical orientation) of the splitter. This property is the same as bottomComponent.
rightVisibleBooleancheckedcheckedWhether to show the right component. If this is false the left component will take up the entire space of the split pane and the splitter will be hidden.
topComponentBiComponentcheckedcheckedThe component above (or to the left if horizontal orientation) of the splitter. This property is the same as leftComponent.
topVisibleBooleancheckedcheckedSets whether to show the top component. If this is false the bottom component will take up the entire space of the split pane and the splitter will be hidden. This property is the same as leftVisible.

Methods

None.

Events

NameTypeBubblesDescripton
dividerlocationchangedBiEventThis is fired when then dividerLocation is changed

Static Methods

None.

Static Fields

None.

Remarks

Using continuousLayout might be slow if the resizing of the components requires too much calculation. If this is the case set this property to false.