com.alee.laf.splitpane

Class WebSplitPaneDivider

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.alee.extended.WebComponent<C,U>

com.alee.extended.WebContainer<WebSplitPaneDivider,WSplitPaneDividerUI>

com.alee.laf.splitpane.WebSplitPaneDivider

All Implemented Interfaces:

LanguageEventMethods, LanguageMethods, SettingsMethods, Styleable, ToolTipMethods, ContainerMethods<WebSplitPaneDivider>, EventMethods, FontMethods<WebSplitPaneDivider>, MethodExtension, SizeMethods<WebSplitPaneDivider>, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener

public class WebSplitPaneDivider
extends WebContainer<WebSplitPaneDivider,WSplitPaneDividerUI>
implements PropertyChangeListener

Divider component used by WSplitPaneUI. This is a better implementation of default Swing BasicSplitPaneDivider. Problem with th default implementation is that it is based on Container and therefore cannot be properly styled.

Author:

Scott Violet, Mikle Garin

See Also:

SplitPaneDescriptor, WSplitPaneDividerUI, WebSplitPaneDividerUI, ISplitPanePainter, SplitPanePainter, WebSplitPane, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WebSplitPaneDivider.DividerLayout LayoutManager for WebSplitPaneDivider.
protected class	WebSplitPaneDivider.DragController Handles the events during a dragging session for a JSplitPane.HORIZONTAL_SPLIT oriented split pane.
protected class	WebSplitPaneDivider.MouseHandler MouseHandler is responsible for converting mouse events (released, dragged...) into the appropriate DragController methods.
protected class	WebSplitPaneDivider.OneTouchActionHandler Listeners installed on the one touch expandable buttons.
class	WebSplitPaneDivider.OneTouchButton Custom one-touch button.
protected class	WebSplitPaneDivider.VerticalDragController Handles the events during a dragging session for a JSplitPane.VERTICAL_SPLIT oriented split pane.

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dividerSize Preferred size of the divider.
protected WebSplitPaneDivider.DragController	dragger Handles mouse dragging message to do the actual dragging.
protected Component	hiddenDivider Divider that is used for noncontinuous layout mode.
protected WebButton	leftButton Button for quickly toggling the left component.
protected WebSplitPaneDivider.MouseHandler	mouseHandler Handles mouse events from both this class, and the split pane.
protected int	orientation Orientation of the JSplitPane.
protected WebButton	rightButton Button for quickly toggling the right component.
static String	SPLIT_PANE_PROPERTY Property identifying JSplitPane this divider is attached to.
protected JSplitPane	splitPane JSplitPane this divider is used for.
protected WSplitPaneUI	splitPaneUI WSplitPaneUI of the JSplitPane this divider is used for.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.alee.utils.swing.extensions.SizeMethods

UNDEFINED

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebSplitPaneDivider(JSplitPane splitPane) Constructs new WebSplitPaneDivider.
WebSplitPaneDivider(StyleId id, JSplitPane splitPane) Constructs new WebSplitPaneDivider.

Method Summary

Modifier and Type	Method and Description
protected WebButton	createLeftOneTouchButton() Creates and returns new WebButton that can be used to collapse the left component in JSplitPane.
protected WebButton	createRightOneTouchButton() Creates and returns new WebButton that can be used to collapse the right component in JSplitPane.
protected void	dragDividerTo(int location) Messages the WSplitPaneUI with dragDividerTo that this instance is contained in.
protected void	finishDraggingTo(int location) Messages the WSplitPaneUI with finishDraggingTo that this instance is contained in.
StyleId	getDefaultStyleId() Returns default component StyleId.
int	getDividerSize() Returns divider size.
JSplitPane	getSplitPane() Returns JSplitPane this divider is used for.
WSplitPaneUI	getSplitPaneUI() Returns WSplitPaneUI of the JSplitPane this divider is used for.
WSplitPaneDividerUI	getUI() Returns the look and feel (LaF) object that renders this component.
String	getUIClassID()
protected void	prepareForDragging() Message to prepare for dragging.
void	propertyChange(PropertyChangeEvent e)
void	setDividerSize(int size) Sets divider size.
protected void	setSplitPane(JSplitPane splitPane) Sets JSplitPane this divider is attached to.
void	setUI(WSplitPaneDividerUI ui) Sets the LaF object that renders this component.
protected void	updateOneTouchButtons() Updates divider one-touch buttons.
protected void	updateOrientationAndCursor() Updates locally stored JSplitPane orientation and divider cursor.
void	updateUI()

Methods inherited from class com.alee.extended.WebContainer

add, add, add, add, add, contains, equalizeComponentsHeight, equalizeComponentsSize, equalizeComponentsWidth, forEach, getFirstComponent, getLastComponent, remove, remove, removeAll

Methods inherited from class com.alee.extended.WebComponent

addDictionaryListener, addLanguageListener, addStyleListener, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, changeFontSize, getCustomPainter, getFontName, getFontSize, getLanguage, getMargin, getMaximumHeight, getMaximumSize, getMaximumWidth, getMinimumHeight, getMinimumSize, getMinimumWidth, getOriginalMaximumSize, getOriginalMinimumSize, getOriginalPreferredSize, getPadding, getPainterShape, getPreferredHeight, getPreferredSize, getPreferredWidth, getSkin, getStyleId, isBoldFont, isItalicFont, isLanguageSet, isPlainFont, isShapeDetectionEnabled, loadSettings, onDoubleClick, onDragStart, onDragStart, onFocusGain, onFocusLoss, onKeyPress, onKeyPress, onKeyRelease, onKeyRelease, onKeyType, onKeyType, onMenuTrigger, onMouseClick, onMouseClick, onMouseDrag, onMouseDrag, onMouseEnter, onMouseExit, onMousePress, onMousePress, registerSettings, registerSettings, removeDictionaryListener, removeDictionaryListeners, removeLanguage, removeLanguageListener, removeLanguageListeners, removeLanguageUpdater, removeStyleListener, removeToolTip, removeToolTips, removeToolTips, removeToolTips, resetCustomPainter, resetSkin, resetStyleId, saveSettings, setBoldFont, setBoldFont, setCustomPainter, setFontName, setFontSize, setFontSizeAndStyle, setFontSizeAndStyle, setFontStyle, setFontStyle, setItalicFont, setItalicFont, setLanguage, setLanguageUpdater, setMargin, setMargin, setMargin, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setPadding, setPadding, setPadding, setPlainFont, setPlainFont, setPreferredHeight, setPreferredSize, setPreferredWidth, setShapeDetectionEnabled, setSkin, setSkin, setStyleId, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, unregisterSettings, updateLanguage, updateLanguage

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

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

Methods inherited from class java.lang.Object

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

Field Detail

SPLIT_PANE_PROPERTY

public static final String SPLIT_PANE_PROPERTY

Property identifying JSplitPane this divider is attached to.

See Also:

Constant Field Values

splitPane

protected transient JSplitPane splitPane

JSplitPane this divider is used for.

splitPaneUI

protected transient WSplitPaneUI splitPaneUI

WSplitPaneUI of the JSplitPane this divider is used for.

mouseHandler

protected transient WebSplitPaneDivider.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.

dragger

protected transient WebSplitPaneDivider.DragController dragger

Handles mouse dragging message to do the actual dragging.

dividerSize

protected int dividerSize

Preferred size of the divider. Note that this size will be used as minimum but can be exceeded if divider's own preferred size is larger.

hiddenDivider

protected Component hiddenDivider

Divider that is used for noncontinuous layout mode.

orientation

protected int orientation

Orientation of the JSplitPane.

leftButton

protected WebButton leftButton

Button for quickly toggling the left component.

rightButton

protected WebButton rightButton

Button for quickly toggling the right component.

Constructor Detail

WebSplitPaneDivider

public WebSplitPaneDivider(JSplitPane splitPane)

Constructs new WebSplitPaneDivider.

Parameters:

splitPane - JSplitPane this divider is attached to

WebSplitPaneDivider

public WebSplitPaneDivider(StyleId id,
                           JSplitPane splitPane)

Constructs new WebSplitPaneDivider.

Parameters:

id - StyleId

splitPane - JSplitPane this divider is attached to

Method Detail

getDefaultStyleId

@NotNull
public StyleId getDefaultStyleId()

Description copied from interface: Styleable

Returns default component StyleId. This method is asked when initial component StyleId have to be provided.

Specified by:

getDefaultStyleId in interface Styleable

Returns:

default component StyleId

setSplitPane

protected void setSplitPane(JSplitPane splitPane)

Sets JSplitPane this divider is attached to.

Parameters:

splitPane - JSplitPane this divider is attached to

getSplitPane

public JSplitPane getSplitPane()

Returns JSplitPane this divider is used for.

Returns:

JSplitPane this divider is used for

getSplitPaneUI

public WSplitPaneUI getSplitPaneUI()

Returns WSplitPaneUI of the JSplitPane this divider is used for.

Returns:

WSplitPaneUI of the JSplitPane this divider is used for

setDividerSize

public void setDividerSize(int size)

Sets divider size. That will be divider width if for JSplitPane.HORIZONTAL_SPLIT and height for JSplitPane.VERTICAL_SPLIT.

Parameters:

size - new divider size

getDividerSize

public int getDividerSize()

Returns divider size. That is divider width if for JSplitPane.HORIZONTAL_SPLIT and height for JSplitPane.VERTICAL_SPLIT.

Returns:

divider size

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

updateOrientationAndCursor

protected void updateOrientationAndCursor()

Updates locally stored JSplitPane orientation and divider cursor.

updateOneTouchButtons

protected void updateOneTouchButtons()

Updates divider one-touch buttons. Will create the leftButton and rightButton if they are null. Will update leftButton and rightButton decoration states if buttons exist.

createLeftOneTouchButton

protected WebButton createLeftOneTouchButton()

Creates and returns new WebButton that can be used to collapse the left component in JSplitPane.

Returns:

new WebButton that can be used to collapse the left component in JSplitPane

createRightOneTouchButton

protected WebButton createRightOneTouchButton()

Creates and returns new WebButton that can be used to collapse the right component in JSplitPane.

Returns:

new WebButton that can be used to collapse the right component in JSplitPane

prepareForDragging

protected void prepareForDragging()

Message to prepare for dragging. This messages the WSplitPaneUI with startDragging.

dragDividerTo

protected void dragDividerTo(int location)

Messages the WSplitPaneUI with dragDividerTo that this instance is contained in.

Parameters:

location - new divider location

finishDraggingTo

protected void finishDraggingTo(int location)

Messages the WSplitPaneUI with finishDraggingTo that this instance is contained in.

Parameters:

location - last divider location

getUI

public WSplitPaneDividerUI getUI()

Returns the look and feel (LaF) object that renders this component.

Returns:

the WSplitPaneDividerUI object that renders this component

setUI

public void setUI(WSplitPaneDividerUI ui)

Sets the LaF object that renders this component.

Parameters:

ui - WSplitPaneDividerUI

updateUI

public void updateUI()

Specified by:

updateUI in class WebComponent<WebSplitPaneDivider,WSplitPaneDividerUI>

getUIClassID

@NotNull
public String getUIClassID()

Specified by:

getUIClassID in class WebComponent<WebSplitPaneDivider,WSplitPaneDividerUI>