Module java.desktop
Package javax.swing.plaf.basic

Class BasicSplitPaneDivider

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.plaf.basic.BasicSplitPaneDivider
All Implemented Interfaces:
ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener
public class BasicSplitPaneDivider extends Container implements PropertyChangeListener
Divider used by BasicSplitPaneUI. Subclassers may wish to override paint to do something more interesting. The border effect is drawn in BasicSplitPaneUI, so if you don't like that border, reset it there. To conditionally drag from certain areas subclass mousePressed and call super when you wish the dragging to begin.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

  • Field Details

    • ONE_TOUCH_SIZE

      protected static final int ONE_TOUCH_SIZE
      Width or height of the divider based on orientation BasicSplitPaneUI adds two to this.
      See Also:

    • ONE_TOUCH_OFFSET

      protected static final int ONE_TOUCH_OFFSET
      The offset of the divider.
      See Also:

    • dragger

      protected BasicSplitPaneDivider.DragController dragger
      Handles mouse dragging message to do the actual dragging.

    • splitPaneUI

      protected BasicSplitPaneUI splitPaneUI
      UI this instance was created from.

    • dividerSize

      protected int dividerSize
      Size of the divider.

    • hiddenDivider

      protected Component hiddenDivider
      Divider that is used for noncontinuous layout mode.

    • splitPane

      protected JSplitPane splitPane
      JSplitPane the receiver is contained in.

    • mouseHandler

      protected BasicSplitPaneDivider.MouseHandler mouseHandler
      Handles mouse events from both this class, and the split pane. Mouse events are handled for the splitpane since you want to be able to drag when clicking on the border of the divider, which is not drawn by the divider.

    • orientation

      protected int orientation
      Orientation of the JSplitPane.

    • leftButton

      protected JButton leftButton
      Button for quickly toggling the left component.

    • rightButton

      protected JButton rightButton
      Button for quickly toggling the right component.

  • Constructor Details

    • BasicSplitPaneDivider

      public BasicSplitPaneDivider(BasicSplitPaneUI ui)
      Creates an instance of BasicSplitPaneDivider. Registers this instance for mouse events and mouse dragged events.
      Parameters:
      ui - an instance of BasicSplitPaneUI

  • Method Details

    • setBasicSplitPaneUI

      public void setBasicSplitPaneUI(BasicSplitPaneUI newUI)
      Sets the SplitPaneUI that is using the receiver.
      Parameters:
      newUI - the new SplitPaneUI

    • getBasicSplitPaneUI

      public BasicSplitPaneUI getBasicSplitPaneUI()
      Returns the SplitPaneUI the receiver is currently in.
      Returns:
      the SplitPaneUI the receiver is currently in

    • setDividerSize

      public void setDividerSize(int newSize)
      Sets the size of the divider to newSize. That is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT. Divider sizes newSize < 0 are ignored.
      Parameters:
      newSize - a new size

    • getDividerSize

      public int getDividerSize()
      Returns the size of the divider, that is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT.
      Returns:
      the size of the divider

    • setBorder

      public void setBorder(Border border)
      Sets the border of this component.
      Parameters:
      border - a new border
      Since:
      1.3

    • getBorder

      public Border getBorder()
      Returns the border of this component or null if no border is currently set.
      Returns:
      the border object for this component
      Since:
      1.3
      See Also:

    • getInsets

      public Insets getInsets()
      If a border has been set on this component, returns the border's insets, else calls super.getInsets.
      Overrides:
      getInsets in class Container
      Returns:
      the value of the insets property.
      See Also:

    • setMouseOver

      protected void setMouseOver(boolean mouseOver)
      Sets whether or not the mouse is currently over the divider.
      Parameters:
      mouseOver - whether or not the mouse is currently over the divider
      Since:
      1.5

    • isMouseOver

      public boolean isMouseOver()
      Returns whether or not the mouse is currently over the divider
      Returns:
      whether or not the mouse is currently over the divider
      Since:
      1.5

    • getPreferredSize

      public Dimension getPreferredSize()
      Returns the preferred size of the divider.
      Overrides:
      getPreferredSize in class Container
      Implementation Note:
      In current implementation, if the splitpane is HORIZONTAL_SPLIT, the preferred size is obtained from width of getDividerSize pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the preferred size is obtained from height of getDividerSize pixels and width of 1 pixel
      Returns:
      a Dimension object containing the preferred size of BasicSplitPaneDivider
      See Also:

    • getMinimumSize

      public Dimension getMinimumSize()
      Returns the minimum size of the divider.
      Overrides:
      getMinimumSize in class Container
      Implementation Note:
      In current implementation, if the splitpane is HORIZONTAL_SPLIT, the minimum size is obtained from width of getDividerSize pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the minimum size is obtained from height of getDividerSize pixels and width of 1 pixel
      Returns:
      a Dimension object containing the minimum size of BasicSplitPaneDivider
      See Also:

    • propertyChange

      public void propertyChange(PropertyChangeEvent e)
      Property change event, presumably from the JSplitPane, will message updateOrientation if necessary.
      Specified by:
      propertyChange in interface PropertyChangeListener
      Parameters:
      e - A PropertyChangeEvent object describing the event source and the property that has changed.

    • paint

      public void paint(Graphics g)
      Paints the divider.
      Overrides:
      paint in class Container
      Parameters:
      g - the specified Graphics window
      See Also:

    • oneTouchExpandableChanged

      protected void oneTouchExpandableChanged()
      Messaged when the oneTouchExpandable value of the JSplitPane the divider is contained in changes. Will create the leftButton and rightButton if they are null and corresponding JSplitPane supports oneTouchExpandable property. Invalidates the corresponding JSplitPane as well.

    • createLeftOneTouchButton

      protected JButton createLeftOneTouchButton()
      Creates and return an instance of JButton that can be used to collapse the left component in the split pane.
      Returns:
      an instance of JButton

    • createRightOneTouchButton

      protected JButton createRightOneTouchButton()
      Creates and return an instance of JButton that can be used to collapse the right component in the split pane.
      Returns:
      an instance of JButton

    • prepareForDragging

      protected void prepareForDragging()
      Message to prepare for dragging. This messages the BasicSplitPaneUI with startDragging.

    • dragDividerTo

      protected void dragDividerTo(int location)
      Messages the BasicSplitPaneUI with dragDividerTo that this instance is contained in.
      Parameters:
      location - a location

    • finishDraggingTo

      protected void finishDraggingTo(int location)
      Messages the BasicSplitPaneUI with finishDraggingTo that this instance is contained in.
      Parameters:
      location - a location