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(previousIndex,event)

Parameters:

• {int} previousIndex

• {JSEvent} event

---

API

getDividerLocation()

Gets the divider location in pixels.

Example:

var dividerSize = myElement.dividerSize

Returns: double ** the size in pixels

---

getDividerSize()

Gets the divider size in pixels.

Example:

var dividerSize = myElement.dividerSize

Returns: int ** the size in pixels

---

getLeftForm()

Returns the left form of the split pane.

Example:

var leftForm = myElement.getLeftForm();

Returns: formscope Left form of the split pane

---

getLeftFormMinSize()

Gets left form minimum size in pixels.

Example:

var left = myElement.leftFormMinSize

Returns: int

---

getRelativeDividerLocation()

Gets the divider location in percentage when the component is visible.

Example:

var divRelativeLocation = myElement.getRelativeDividerLocation()

Returns: double ** the location in percentage

---

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:

var resizeWeight = myElement.resizeWeight

Returns: double

---

getRightForm()

Returns the right form of the split pane.

Example:

var rightForm = myElement.getRightForm();

Returns: formscope Right form of the split pane

---

getRightFormMinSize()

Gets right form minimum size in pixels.

Example:

var right = myElement.rightFormMinSize

Returns: int

---

setDividerLocation(location)

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:

myElement.dividerLocation = 0.75;
myElement.dividerLocation = 100;

Parameters:

• {double} location

---

setDividerSize(size)

Sets divider size in pixels.

Example:

myElement.dividerSize = 10;

Parameters:

• {int} size

---

setLeftForm(form,relation)

Set a relationless or related form as left panel.

Example:

myElement.setLeftForm(forms.orders);

Parameters:

• {object} form ** form the specified form or form name you wish to add as left panel

• {object} [relation]

Returns: boolean Value indicating if pane was successfully added

---

setLeftFormMinSize(minSize)

Sets left form minimum size in pixels.

Example:

myElement.leftFormMinSize = 100;

Parameters:

• {int} minSize

---

setResizeWeight(resizeWeight)

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:

myElement.resizeWeight = 10;

Parameters:

• {double} resizeWeight

---

setRightForm(form,relation)

Set a relationless or related form as right panel.

Example:

myElement.setRightForm(forms.orders);

Parameters:

• {object} form ** form the specified form or form name you wish to add as right panel

• {object} [relation]

Returns: boolean Value indicating if pane was successfully added

---

setRightFormMinSize(minSize)

Sets right form minimum size in pixels.

Example:

myElement.rightFormMinSize = 100;

Parameters:

• {int} minSize

---

Types

pane

scripting type: CustomType<servoyextra-splitpane.pane>

• containsFormId

  • Type: form

• relationName

  • Type: relation

---