com.mucommander.ui.layout
Class ProportionalSplitPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JSplitPane
                  com.mucommander.ui.layout.ProportionalSplitPane

All Implemented Interfaces:

java.awt.event.ComponentListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class ProportionalSplitPane
extends javax.swing.JSplitPane
implements java.awt.event.ComponentListener, java.awt.event.MouseListener

ProportionalSplitPane is a JSplitPane that is able to maintain the divider's location constant proportionally when the window it is attached to is resized, or when its orientation is changed.

Another added feature is the ability to restore a split ratio of 0.5f (same size for both panels) when the divider component is double-clicked.

Author:

Maxence Bernard

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JSplitPane.AccessibleJSplitPane

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JSplitPane

BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, continuousLayout, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, dividerSize, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, LEFT, leftComponent, ONE_TOUCH_EXPANDABLE_PROPERTY, oneTouchExpandable, orientation, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, rightComponent, TOP, VERTICAL_SPLIT

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ProportionalSplitPane(java.awt.Window window)

ProportionalSplitPane(java.awt.Window window, int orientation)

ProportionalSplitPane(java.awt.Window window, int orientation, boolean continuousLayout)

ProportionalSplitPane(java.awt.Window window, int orientation, boolean continuousLayout, javax.swing.JComponent leftComponent, javax.swing.JComponent rightComponent)

ProportionalSplitPane(java.awt.Window window, int orientation, javax.swing.JComponent leftComponent, javax.swing.JComponent rightComponent)

Method Summary

void	componentHidden(java.awt.event.ComponentEvent e)
void	componentMoved(java.awt.event.ComponentEvent e)
void	componentResized(java.awt.event.ComponentEvent e) Sets the divider location when the ContentPane has been resized so that it stays at the same proportional (not absolute) location.
void	componentShown(java.awt.event.ComponentEvent e)
void	disableAccessibilityShortcuts() Disables all the JSPlitPane accessibility shortcuts that are registered by default: Navigate in - Tab Navigate out - Ctrl+Tab, Ctrl+Shift+Tab Navigate between - Tab, F6 Give focus spliter bar - F8 Change size - Arrow keys, home, and end (moves the pane splitter appropriately)
javax.swing.plaf.basic.BasicSplitPaneDivider	getDividerComponent() Returns the split pane divider component.
void	mouseClicked(java.awt.event.MouseEvent mouseEvent)
void	mouseEntered(java.awt.event.MouseEvent mouseEvent)
void	mouseExited(java.awt.event.MouseEvent mouseEvent)
void	mousePressed(java.awt.event.MouseEvent mouseEvent)
void	mouseReleased(java.awt.event.MouseEvent mouseEvent)
void	setOrientation(int orientation)
void	setSplitRatio(float splitRatio) Sets the constant, proportional divider's location.
void	updateDividerLocation() Updates the divider component's location to keep the current proportional divider location.

Methods inherited from class javax.swing.JSplitPane

addImpl, getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, paintChildren, paramString, remove, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerLocation, setDividerLocation, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setResizeWeight, setRightComponent, setTopComponent, setUI, updateUI

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintComponent, paintImmediately, paintImmediately, 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, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ProportionalSplitPane

public ProportionalSplitPane(java.awt.Window window)

ProportionalSplitPane

public ProportionalSplitPane(java.awt.Window window,
                             int orientation)

ProportionalSplitPane

public ProportionalSplitPane(java.awt.Window window,
                             int orientation,
                             boolean continuousLayout)

ProportionalSplitPane

public ProportionalSplitPane(java.awt.Window window,
                             int orientation,
                             javax.swing.JComponent leftComponent,
                             javax.swing.JComponent rightComponent)

ProportionalSplitPane

public ProportionalSplitPane(java.awt.Window window,
                             int orientation,
                             boolean continuousLayout,
                             javax.swing.JComponent leftComponent,
                             javax.swing.JComponent rightComponent)

Method Detail

updateDividerLocation

public void updateDividerLocation()

Updates the divider component's location to keep the current proportional divider location.

setSplitRatio

public void setSplitRatio(float splitRatio)

Sets the constant, proportional divider's location. The given float but be comprised between 0 and 1, 0 meaning completely left (or top), 1 right completely (or bottom).

Parameters:

splitRatio - the proportional divider's location, comprised between 0 and 1.

getDividerComponent

public javax.swing.plaf.basic.BasicSplitPaneDivider getDividerComponent()

Returns the split pane divider component.

disableAccessibilityShortcuts

public void disableAccessibilityShortcuts()

Disables all the JSPlitPane accessibility shortcuts that are registered by default:

• Navigate in - Tab
• Navigate out - Ctrl+Tab, Ctrl+Shift+Tab
• Navigate between - Tab, F6
• Give focus spliter bar - F8
• Change size - Arrow keys, home, and end (moves the pane splitter appropriately)

setOrientation

public void setOrientation(int orientation)

Overrides:

setOrientation in class javax.swing.JSplitPane

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

Sets the divider location when the ContentPane has been resized so that it stays at the same proportional (not absolute) location.

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

Specified by:

componentShown in interface java.awt.event.ComponentListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

Specified by:

componentHidden in interface java.awt.event.ComponentListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent mouseEvent)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent mouseEvent)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent mouseEvent)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent mouseEvent)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent mouseEvent)

Specified by:

mouseExited in interface java.awt.event.MouseListener