Package swingtree

Class UIForSplitPane<P extends JSplitPane>

java.lang.Object
swingtree.UIForAnything<UIForSplitPane<P>,P,JComponent>
swingtree.UIForAnySwing<UIForSplitPane<P>,P>
swingtree.UIForSplitPane<P>
Type Parameters:
P - The type of JSplitPane that this UIForSplitPane is configuring.
public final class UIForSplitPane<P extends JSplitPane> extends UIForAnySwing<UIForSplitPane<P>,P>
A SwingTree builder node designed for configuring JSplitPane instances.

  • Method Details

    • _state

      protected swingtree.BuilderState<P> _state()
      Description copied from class: UIForAnything
      Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.
      Specified by:
      _state in class UIForAnything<UIForSplitPane<P extends JSplitPane>,P extends JSplitPane,JComponent>
      Returns:
      The state of the builder.

    • _newBuilderWithState

      protected UIForSplitPane<P> _newBuilderWithState(swingtree.BuilderState<P> newState)
      Description copied from class: UIForAnything
      An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.
      Specified by:
      _newBuilderWithState in class UIForAnything<UIForSplitPane<P extends JSplitPane>,P extends JSplitPane,JComponent>
      Parameters:
      newState - The new state which should be stored inside the new builder instance.
      Returns:
      A new builder instance with the provided state stored inside it.

    • withLayoutOrientation

      public final UIForSplitPane<P> withLayoutOrientation(UI.Align align)
      Sets the layout of the two components in the split pane to either be placed left to right (horizontal split) or on top of each other (vertical split). If you want to control this property dynamically through a bound property, then consider using the withLayoutOrientation(Val) method.
      You can also directly construct a split pane with the desired layout through the UIFactoryMethods.splitPane(UI.Align) and UIFactoryMethods.splitPane(Val) factory methods.
      Parameters:
      align - The alignment of the components in the split pane, which determines the layout of the split pane.
      Returns:
      This very instance, which enables builder-style method chaining.
      Throws:
      IllegalArgumentException - if the provided alignment is null.

    • withLayoutOrientation

      public final UIForSplitPane<P> withLayoutOrientation(sprouts.Val<UI.Align> align)
      Dynamically sets the layout of the two components in the split pane to either be placed left to right (horizontal split) or on top of each other (vertical split). This method binds the supplied layout property to the split pane, which means that when the property changes its UI.Align, then the layout of the split pane will be updated accordingly. If you want to set a fixed layout that does not change dynamically, then consider using the withLayoutOrientation(UI.Align) method.
      You can also directly construct a split pane with the desired layout through the UIFactoryMethods.splitPane(UI.Align) and UIFactoryMethods.splitPane(Val) factory methods.
      Parameters:
      align - A property dynamically determining the alignment of the components in the split pane, which determines the layout of the split pane.
      Returns:
      This very instance, which enables builder-style method chaining.
      Throws:
      IllegalArgumentException - if align is null.

    • withDividerAt

      public final UIForSplitPane<P> withDividerAt(int location)
      Sets the location of the divider. This is passed off to the look and feel implementation, and then listeners are notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via setLastDividerLocation.
      Parameters:
      location - An int specifying a UI-specific value (typically a pixel count)
      Returns:
      This very instance, which enables builder-style method chaining.

    • withDividerAt

      public final UIForSplitPane<P> withDividerAt(sprouts.Val<Integer> location)
      Sets the location of the divider in the form of a property, which can be dynamically update the divide. This is passed off to the look and feel implementation, and then listeners are notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via setLastDividerLocation.
      Parameters:
      location - A property dynamically determining a UI-specific value (typically a pixel count)
      Returns:
      This very instance, which enables builder-style method chaining.
      Throws:
      IllegalArgumentException - if location is null.

    • withDividerSize

      public final UIForSplitPane<P> withDividerSize(int size)
      Sets the size of the divider.
      Parameters:
      size - An integer giving the size of the divider in pixels
      Returns:
      This very instance, which enables builder-style method chaining.

    • withDividerSize

      public final UIForSplitPane<P> withDividerSize(sprouts.Val<Integer> size)
      Sets the size of the divider in the form of a property, which can be dynamically update.
      Parameters:
      size - A property dynamically determining the size of the divider in pixels
      Returns:
      This very instance, which enables builder-style method chaining.
      Throws:
      IllegalArgumentException - if size is null.

    • withDivisionOf

      public final UIForSplitPane<P> withDivisionOf(double percentage)
      Sets the location of the divider based on a percentage value. So if the split pane split is aligned horizontally, the divider will be set to the percentage of the height of the split pane. If the split pane is aligned vertically, the divider will be set to the percentage of the width of the split pane.

      Note that a component listener is installed to the split pane's size temporarily, so that the divider location can be calculated when the split pane is sized by the layout manager for the first time. This is because before the layout manager did its thing, there was no way to know the actual location of the divider based on the percentage. So keep in mind that changes to the divider location immediately after this method is called will be overridden by said listener!

      A change of the divider location is ultimately passed off to the look and feel implementation, where listeners are then notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via JSplitPane.setLastDividerLocation(int).

      Parameters:
      percentage - A double value between 0 and 1, representing the percentage of the split pane's
      Returns:
      This very instance, which enables builder-style method chaining.

    • withDivisionOf

      public final UIForSplitPane<P> withDivisionOf(sprouts.Val<Double> percentage)
      Updates the location of the divider based on a percentage property which means that if the split pane split is aligned horizontally, the divider will be set to the percentage of the height of the split pane and if the split pane is aligned vertically, the divider will be set to the percentage of the width of the split pane.

      This method binds the property uni-directionally, which means that the property will be observed by the split pane, but the split pane will not change the property (see withDivisionOf(Var) for a bidirectional variant).

      A change of the divider location is ultimately passed off to the look and feel implementation, where listeners are then notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via JSplitPane.setLastDividerLocation(int).

      Note that the percentage is calculated based on the split pane's current size, so if the split pane is resized, the divider location will be recalculated in order to honor the percentage.

      Parameters:
      percentage - A property dynamically determining a double value between 0 and 1, representing the percentage of the split pane's
      Returns:
      This very instance, which enables builder-style method chaining.

    • withDivisionOf

      public final UIForSplitPane<P> withDivisionOf(sprouts.Var<Double> percentage)
      Updates the location of the divider based on a percentage property which means that if the split pane split is aligned horizontally, the divider will be set to the percentage of the height of the split pane. If, however, the split pane is aligned vertically, then the divider will be set to the percentage of the width of the split pane.

      Note that this binds the property to the location of the divider bidirectionally, which means that the value inside the property will be updated when the divider location is changed by the user and the divider location will be updated when the property changes in the business logic.

      A change of the divider location is ultimately passed off to the look and feel implementation, where listeners are then notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via JSplitPane.setLastDividerLocation(int).

      Note that the percentage is calculated based on the split pane's current size, so if the split pane changes its size, the divider location will be recalculated.

      Parameters:
      percentage - A property dynamically determining a double value between 0 and 1, representing the percentage of the split pane's
      Returns:
      This very instance, which enables builder-style method chaining.