Module javafx.controls
Package javafx.scene.control

Class SplitPane

  • All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    @DefaultProperty("items")
public class SplitPane
extends Control

    A control that has two or more sides, each separated by a divider, which can be dragged by the user to give more space to one of the sides, resulting in the other side shrinking by an equal amount.

    Nodes can be positioned horizontally next to each other, or stacked vertically. This can be controlled by setting the orientationProperty().

    The dividers in a SplitPane have the following behavior

    • Dividers cannot overlap another divider
    • Dividers cannot overlap a node.
    • Dividers moving to the left/top will stop when the node's min size is reached.
    • Dividers moving to the right/bottom will stop when the node's max size is reached.

    Nodes needs to be placed inside a layout container before they are added into the SplitPane. If the node is not inside a layout container the maximum and minimum position of the divider will be the maximum and minimum size of the content.

    A divider's position ranges from 0 to 1.0(inclusive). A position of 0 will place the divider at the left/top most edge of the SplitPane plus the minimum size of the node. A position of 1.0 will place the divider at the right/bottom most edge of the SplitPane minus the minimum size of the node. A divider position of 0.5 will place the the divider in the middle of the SplitPane. Setting the divider position greater than the node's maximum size position will result in the divider being set at the node's maximum size position. Setting the divider position less than the node's minimum size position will result in the divider being set at the node's minimum size position. Therefore the value set in setDividerPosition(int, double) and setDividerPositions(double...) may not be the same as the value returned by getDividerPositions().

    If there are more than two nodes in the SplitPane and the divider positions are set in such a way that the dividers cannot fit the nodes the dividers will be automatically adjusted by the SplitPane.

    For example we have three nodes whose sizes and divider positions are 

     Node 1: min 25 max 100
 Node 2: min 100 max 200
 Node 3: min 25 max 50
 divider 1: 0.40
 divider 2: 0.45

    The result will be Node 1 size will be its pref size and divider 1 will be positioned 0.40, Node 2 size will be its min size and divider 2 position will be the min size of Node 2 plus divider 1 position, and the remaining space will be given to Node 3.

    SplitPane sets focusTraversable to false.

    Example:

    
 SplitPane sp = new SplitPane();
 final StackPane sp1 = new StackPane();
 sp1.getItems().add(new Button("Button One"));
 final StackPane sp2 = new StackPane();
 sp2.getItems().add(new Button("Button Two"));
 final StackPane sp3 = new StackPane();
 sp3.getItems().add(new Button("Button Three"));
 sp.getItems().addAll(sp1, sp2, sp3);
 sp.setDividerPositions(0.3f, 0.6f, 0.9f);
    Since:
    JavaFX 2.0

    • Property Detail

      • orientation

        public final ObjectProperty<Orientation> orientationProperty
        The orientation for the SplitPane.
        Returns:
        the orientation property for the SplitPane

    • Constructor Detail

      • SplitPane

        public SplitPane()
        Creates a new SplitPane with no content.

      • SplitPane

        public SplitPane​(Node... items)
        Creates a new SplitPane with the given items set as the content to split between one or more dividers.
        Parameters:
        items - The items to place inside the SplitPane.
        Since:
        JavaFX 8u40

    • Method Detail

      • setResizableWithParent

        public static void setResizableWithParent​(Node node,
                                          Boolean value)
        Sets a node in the SplitPane to be resizable or not when the SplitPane is resized. By default all node are resizable. Setting value to false will prevent the node from being resized.
        Parameters:
        node - A node in the SplitPane.
        value - true if the node is resizable or false if not resizable.
        Since:
        JavaFX 2.1

      • isResizableWithParent

        public static Boolean isResizableWithParent​(Node node)
        Return true if the node is resizable when the parent container is resized false otherwise.
        Default value:
        true
        Parameters:
        node - A node in the SplitPane.
        Returns:
        true if the node is resizable false otherwise.
        Since:
        JavaFX 2.1

      • setOrientation

        public final void setOrientation​(Orientation value)

        This property controls how the SplitPane should be displayed to the user. Orientation.HORIZONTAL will result in two (or more) nodes being placed next to each other horizontally, whilst Orientation.VERTICAL will result in the nodes being stacked vertically.

        Parameters:
        value - the orientation value

      • getOrientation

        public final Orientation getOrientation()
        The orientation for the SplitPane.
        Returns:
        The orientation for the SplitPane.

      • orientationProperty

        public final ObjectProperty<Orientation> orientationProperty()
        The orientation for the SplitPane.
        Returns:
        the orientation property for the SplitPane

      • getItems

        public ObservableList<Node> getItems()
        Returns an ObservableList which can be use to modify the contents of the SplitPane. The order the nodes are placed into this list will be the same order in the SplitPane.
        Returns:
        the list of items in this SplitPane.

      • getDividers

        public ObservableList<SplitPane.Divider> getDividers()
        Returns an unmodifiable list of all the dividers in this SplitPane.
        Returns:
        the list of dividers.

      • setDividerPosition

        public void setDividerPosition​(int dividerIndex,
                               double position)
        Sets the position of the divider at the specified divider index.
        Parameters:
        dividerIndex - the index of the divider.
        position - the divider position, between 0.0 and 1.0 (inclusive).

      • setDividerPositions

        public void setDividerPositions​(double... positions)
        Sets the position of the divider
        Parameters:
        positions - the divider position, between 0.0 and 1.0 (inclusive).

      • getDividerPositions

        public double[] getDividerPositions()
        Returns an array of double containing the position of each divider.
        Returns:
        an array of double containing the position of each divider.

      • createDefaultSkin

        protected Skin<?> createDefaultSkin()
        Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).
        Overrides:
        createDefaultSkin in class Control
        Returns:
        new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
        Returns:
        The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
        Since:
        JavaFX 8.0

      • getInitialFocusTraversable

        protected Boolean getInitialFocusTraversable()
        Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden as by default UI controls have focus traversable set to true, but that is not appropriate for this control.
        Overrides:
        getInitialFocusTraversable in class Control
        Returns:
        the initial focus traversable state of this control
        Since:
        9