Split Pane
(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent
This is a reference page; many components have detailed usage guides here.
Properties
divLocation
Sets the initial splitter div location, between 0 and 1 is a percentange, more than 1 is a value in pixels.
Type: double Default Value: -1
divSize
Size of the splitter div - in pixels.
Type: int Default Value: 5
enabled
Type: enabled Default Value: true
pane1
Type: pane
pane1MinSize
Type: int Default Value: 30
pane2
Type: pane
pane2MinSize
Type: int Default Value: 30
panes
Type: pane[]
readOnly
Type: protected
resizeWeight
Type: double Default Value: 0
responsiveHeight
Minimum height of the splitpane, set only in responsive forms.
Type: int Default Value: 300
splitType
Type: int Default Value: 0
styleClass
Type: styleclass
tabSeq
Type: tabseq
visible
Type: visible
Events
onChangeMethodID
Parameters:
API
getDividerLocation
Gets the divider location in pixels.
@example
@return the size in pixels
Returns: double
getDividerSize
Gets the divider size in pixels.
@example
@return the size in pixels
Returns: int
getLeftForm
Returns the left form of the split pane.
@example
@return {FormScope} left form of the split pane
Returns: formscope
getLeftFormMinSize
Gets left form minimum size in pixels.
@example
Returns: int
getRelativeDividerLocation
Gets the divider location in percentage when the component is visible.
@example
@return the location in percentage
Returns: double
getResizeWeight
Gets the resize weight, which specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space
@example
Returns: double
getRightForm
Returns the right form of the split pane.
@example
@return {FormScope} right form of the split pane
Returns: formscope
getRightFormMinSize
Gets right form minimum size in pixels.
@example
Returns: int
setDividerLocation
Sets divider location. If location is less then 1 then the location will be considered at (location * 100) percent of the split pane from left, otherwise it will represent the pixels from left.
@example
Parameters:
location double
setDividerSize
Sets divider size in pixels.
@example
Parameters:
size int
setLeftForm
Set a relationless or related form as left panel.
@example
@param form the specified form or form name you wish to add as left panel @return {Boolean} value indicating if pane was successfully added
Parameters:
Returns: boolean
setLeftFormMinSize
Sets left form minimum size in pixels.
@example
Parameters:
minSize int
setResizeWeight
Sets the resize weight, which specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space
@example
Parameters:
resizeWeight double
setRightForm
Set a relationless or related form as right panel.
@example
@param form the specified form or form name you wish to add as right panel @return {Boolean} value indicating if pane was successfully added
Parameters:
Returns: boolean
setRightFormMinSize
Sets right form minimum size in pixels.
@example
Parameters:
minSize int
Types
pane
scripting type: CustomType<servoyextra-splitpane.pane>
Last updated