Package org.jdesktop.swingx

Class JXMultiSplitPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.jdesktop.swingx.JXMultiSplitPane
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
@JavaBean public class JXMultiSplitPane extends JPanel
All properties in this class are bound: when a properties value is changed, all PropertyChangeListeners are fired.
Author:
Hans Muller, Luan O'Carroll
See Also:

  • Constructor Details

    • JXMultiSplitPane

      public JXMultiSplitPane()
      Creates a MultiSplitPane with it's LayoutManager set to to an empty MultiSplitLayout.

    • JXMultiSplitPane

      public JXMultiSplitPane(MultiSplitLayout layout)
      Creates a MultiSplitPane.
      Parameters:
      layout - the new split pane's layout

  • Method Details

    • getMultiSplitLayout

      public final MultiSplitLayout getMultiSplitLayout()
      A convenience method that returns the layout manager cast to MutliSplitLayout.
      Returns:
      this MultiSplitPane's layout manager
      See Also:

    • setModel

      public final void setModel(MultiSplitLayout.Node model)
      A convenience method that sets the MultiSplitLayout model. Equivalent to getMultiSplitLayout.setModel(model)
      Parameters:
      model - the root of the MultiSplitLayout model
      See Also:

    • setDividerSize

      public final void setDividerSize(int dividerSize)
      A convenience method that sets the MultiSplitLayout dividerSize property. Equivalent to getMultiSplitLayout().setDividerSize(newDividerSize).
      Parameters:
      dividerSize - the value of the dividerSize property
      See Also:

    • getDividerSize

      public final int getDividerSize()
      A convenience method that returns the MultiSplitLayout dividerSize property. Equivalent to getMultiSplitLayout().getDividerSize().
      Returns:
      dividerSize
      See Also:

    • setContinuousLayout

      public void setContinuousLayout(boolean continuousLayout)
      Sets the value of the continuousLayout property. If true, then the layout is revalidated continuously while a divider is being moved. The default value of this property is true.
      Parameters:
      continuousLayout - value of the continuousLayout property
      See Also:

    • isContinuousLayout

      public boolean isContinuousLayout()
      Returns true if dragging a divider only updates the layout when the drag gesture ends (typically, when the mouse button is released).
      Returns:
      the value of the continuousLayout property
      See Also:

    • activeDivider

      public MultiSplitLayout.Divider activeDivider()
      Returns the Divider that's currently being moved, typically because the user is dragging it, or null.
      Returns:
      the Divider that's being moved or null.

    • getDividerPainter

      public JXMultiSplitPane.DividerPainter getDividerPainter()
      The DividerPainter that's used to paint Dividers on this MultiSplitPane. This property may be null.
      Returns:
      the value of the dividerPainter Property
      See Also:

    • setDividerPainter

      public void setDividerPainter(JXMultiSplitPane.DividerPainter dividerPainter)
      Sets the DividerPainter that's used to paint Dividers on this MultiSplitPane. The default DividerPainter only draws the activeDivider (if there is one) and then, only if continuousLayout is false. The value of this property is used by the paintChildren method: Dividers are painted after the MultiSplitPane's children have been rendered so that the activeDivider can appear "on top of" the children.
      Parameters:
      dividerPainter - the value of the dividerPainter property, can be null
      See Also:

    • paintComponent

      protected void paintComponent(Graphics g)
      Calls the UI delegate's paint method, if the UI delegate is non-null. We pass the delegate a copy of the Graphics object to protect the rest of the paint code from irrevocable changes (for example, Graphics.translate).

      If you override this in a subclass you should not make permanent changes to the passed in Graphics. For example, you should not alter the clip Rectangle or modify the transform. If you need to do these operations you may find it easier to create a new Graphics from the passed in Graphics and manipulate it. Further, if you do not invoker super's implementation you must honor the opaque property, that is if this component is opaque, you must completely fill in the background in a non-opaque color. If you do not honor the opaque property you will likely see visual artifacts.

      The passed in Graphics object might have a transform other than the identify transform installed on it. In this case, you might get unexpected results if you cumulatively apply another transform.

      Overrides:
      paintComponent in class JComponent
      Parameters:
      g - the Graphics object to protect
      See Also:

    • setBackgroundPainter

      public void setBackgroundPainter(Painter<? super JComponent> p)
      Specifies a Painter to use to paint the background of this JXPanel. If p is not null, then setOpaque(false) will be called as a side effect. A component should not be opaque if painters are being used, because Painters may paint transparent pixels or not paint certain pixels, such as around the border insets.

    • getBackgroundPainter

      public Painter<? super JComponent> getBackgroundPainter()

    • isPaintBorderInsets

      public boolean isPaintBorderInsets()

    • setPaintBorderInsets

      public void setPaintBorderInsets(boolean paintBorderInsets)

    • paintChildren

      protected void paintChildren(Graphics g)
      Uses the DividerPainter (if any) to paint each Divider that overlaps the clip Rectangle. This is done after the call to super.paintChildren() so that Dividers can be rendered "on top of" the children.

      Overrides:
      paintChildren in class JComponent

    • getMaxNodeSize

      protected Dimension getMaxNodeSize(MultiSplitLayout msl, MultiSplitLayout.Node n)
      Set the maximum node size. This method can be overridden to limit the size of a node during a drag operation on a divider. When implementing this method in a subclass the node instance should be checked, for example: class MyMultiSplitPane extends JXMultiSplitPane { protected Dimension getMaxNodeSize( MultiSplitLayout msl, Node n ) { if (( n instanceof Leaf ) && ((Leaf)n).getName().equals( "top" )) return msl.maximumNodeSize( n ); return null; } }
      Parameters:
      msl - the MultiSplitLayout used by this pane
      n - the node being resized
      Returns:
      the maximum size or null (by default) to ignore the maximum size.

    • getMinNodeSize

      protected Dimension getMinNodeSize(MultiSplitLayout msl, MultiSplitLayout.Node n)
      Set the minimum node size. This method can be overridden to limit the size of a node during a drag operation on a divider.
      Parameters:
      msl - the MultiSplitLayout used by this pane
      n - the node being resized
      Returns:
      the maximum size or null (by default) to ignore the maximum size.

    • getAccessibleContext

      public AccessibleContext getAccessibleContext()
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class JPanel