W3cubDocs

/OpenJDK 21

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.

Nested Class Summary

Modifier and Type Class Description
protected class  BasicSplitPaneDivider.DividerLayout
Used to layout a BasicSplitPaneDivider.
protected class  BasicSplitPaneDivider.DragController
Handles the events during a dragging session for a HORIZONTAL_SPLIT oriented split pane.
protected class  BasicSplitPaneDivider.MouseHandler
MouseHandler is responsible for converting mouse events (released, dragged...) into the appropriate DragController methods.
protected class  BasicSplitPaneDivider.VerticalDragController
Handles the events during a dragging session for a VERTICAL_SPLIT oriented split pane.

Nested classes/interfaces declared in class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces declared in class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Modifier and Type Field Description
protected int dividerSize
Size of the divider.
protected BasicSplitPaneDivider.DragController dragger
Handles mouse dragging message to do the actual dragging.
protected Component hiddenDivider
Divider that is used for noncontinuous layout mode.
protected JButton leftButton
Button for quickly toggling the left component.
protected BasicSplitPaneDivider.MouseHandler mouseHandler
Handles mouse events from both this class, and the split pane.
protected static final int ONE_TOUCH_OFFSET
The offset of the divider.
protected static final int ONE_TOUCH_SIZE
Width or height of the divider based on orientation BasicSplitPaneUI adds two to this.
protected int orientation
Orientation of the JSplitPane.
protected JButton rightButton
Button for quickly toggling the right component.
protected JSplitPane splitPane
JSplitPane the receiver is contained in.
protected BasicSplitPaneUI splitPaneUI
UI this instance was created from.

Fields declared in class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields declared in interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructor Description
BasicSplitPaneDivider(BasicSplitPaneUI ui)
Creates an instance of BasicSplitPaneDivider.

Method Summary

Modifier and Type Method Description
protected JButton createLeftOneTouchButton()
Creates and return an instance of JButton that can be used to collapse the left component in the split pane.
protected JButton createRightOneTouchButton()
Creates and return an instance of JButton that can be used to collapse the right component in the split pane.
protected void dragDividerTo(int location)
Messages the BasicSplitPaneUI with dragDividerTo that this instance is contained in.
protected void finishDraggingTo(int location)
Messages the BasicSplitPaneUI with finishDraggingTo that this instance is contained in.
BasicSplitPaneUI getBasicSplitPaneUI()
Returns the SplitPaneUI the receiver is currently in.
Border getBorder()
Returns the border of this component or null if no border is currently set.
int getDividerSize()
Returns the size of the divider, that is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT.
Insets getInsets()
If a border has been set on this component, returns the border's insets, else calls super.getInsets.
Dimension getMinimumSize()
Returns the minimum size of the divider.
Dimension getPreferredSize()
Returns the preferred size of the divider.
boolean isMouseOver()
Returns whether or not the mouse is currently over the divider
protected void oneTouchExpandableChanged()
Messaged when the oneTouchExpandable value of the JSplitPane the divider is contained in changes.
void paint(Graphics g)
Paints the divider.
protected void prepareForDragging()
Message to prepare for dragging.
void propertyChange(PropertyChangeEvent e)
Property change event, presumably from the JSplitPane, will message updateOrientation if necessary.
void setBasicSplitPaneUI(BasicSplitPaneUI newUI)
Sets the SplitPaneUI that is using the receiver.
void setBorder(Border border)
Sets the border of this component.
void setDividerSize(int newSize)
Sets the size of the divider to newSize.
protected void setMouseOver(boolean mouseOver)
Sets whether or not the mouse is currently over the divider.

Methods declared in class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getListeners, getMaximumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

Methods declared in class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/plaf/basic/BasicSplitPaneDivider.html