Package adams.gui.core

Class BaseSplitPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSplitPane

adams.gui.core.BaseSplitPane

All Implemented Interfaces:

UISettingsSupporter, ImageObserver, MenuContainer, Serializable, Accessible

public class BaseSplitPane
extends JSplitPane
implements UISettingsSupporter

An extended JSplitPane class. It offers methods for hiding the components (only works if both of the components are present).

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JSplitPane.AccessibleJSplitPane

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	Description
protected Integer	m_DividerLocationBeforeHiding	the divider location before hiding a component.
protected Component	m_HiddenBottomComponent	the hidden bottom/right component.
protected Component	m_HiddenTopComponent	the hidden top/left component.
protected Class	m_SettingsClass	the settings class for storing the divider location.
protected String	m_SettingsProperty	the settings property for storing the divider location.

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

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
BaseSplitPane()	Creates a new BaseSplitPane configured to arrange the child components side-by-side horizontally with no continuous layout, using two buttons for the components.
BaseSplitPane(int newOrientation)	Creates a new BaseSplitPane configured with the specified orientation and no continuous layout.
BaseSplitPane(int newOrientation, boolean newContinuousLayout)	Creates a new BaseSplitPane with the specified orientation and redrawing style.
BaseSplitPane(int newOrientation, boolean newContinuousLayout, Component newLeftComponent, Component newRightComponent)	Creates a new BaseSplitPane with the specified orientation and redrawing style, and with the specified components.
BaseSplitPane(int newOrientation, Component newLeftComponent, Component newRightComponent)	Creates a new BaseSplitPane with the specified orientation and with the specified components that do not do continuous redrawing.

Method Summary

Modifier and Type	Method	Description
void	clearUISettingsParameters()	Clears the para meters for storing the divider location.
protected void	initialize()	Initializes members.
boolean	isBottomComponentHidden()	Returns whether the bottom component is hidden.
boolean	isLeftComponentHidden()	Returns whether the left component is hidden.
boolean	isRightComponentHidden()	Returns whether the right component is hidden.
boolean	isTopComponentHidden()	Returns whether the top component is hidden.
void	setBottomComponentHidden(boolean value)	Sets the hidden status of the bottom component.
void	setLeftComponentHidden(boolean value)	Sets the hidden status of the left component.
void	setRightComponentHidden(boolean value)	Sets the hidden status of the right component.
void	setTopComponentHidden(boolean value)	Sets the hidden status of the top component.
void	setUISettingsParameters(Class cls, String property)	Sets the parameters for storing the 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, setOrientation, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

m_HiddenTopComponent

protected Component m_HiddenTopComponent

the hidden top/left component.

m_HiddenBottomComponent

protected Component m_HiddenBottomComponent

the hidden bottom/right component.

m_DividerLocationBeforeHiding

protected Integer m_DividerLocationBeforeHiding

the divider location before hiding a component.

m_SettingsClass

protected Class m_SettingsClass

the settings class for storing the divider location.

m_SettingsProperty

protected String m_SettingsProperty

the settings property for storing the divider location.

Constructor Detail

BaseSplitPane

public BaseSplitPane()

Creates a new BaseSplitPane configured to arrange the child components side-by-side horizontally with no continuous layout, using two buttons for the components.

BaseSplitPane

public BaseSplitPane(int newOrientation)

Creates a new BaseSplitPane configured with the specified orientation and no continuous layout.

Parameters:

newOrientation - BaseSplitPane.HORIZONTAL_SPLIT or BaseSplitPane.VERTICAL_SPLIT

Throws:

IllegalArgumentException - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT.

BaseSplitPane

public BaseSplitPane(int newOrientation,
                     boolean newContinuousLayout)

Creates a new BaseSplitPane with the specified orientation and redrawing style.

Parameters:

newOrientation - BaseSplitPane.HORIZONTAL_SPLIT or BaseSplitPane.VERTICAL_SPLIT

newContinuousLayout - a boolean, true for the components to redraw continuously as the divider changes position, false to wait until the divider position stops changing to redraw

Throws:

IllegalArgumentException - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT

BaseSplitPane

public BaseSplitPane(int newOrientation,
                     Component newLeftComponent,
                     Component newRightComponent)

Creates a new BaseSplitPane with the specified orientation and with the specified components that do not do continuous redrawing.

Parameters:

newOrientation - BaseSplitPane.HORIZONTAL_SPLIT or BaseSplitPane.VERTICAL_SPLIT

newLeftComponent - the Component that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane

newRightComponent - the Component that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane

Throws:

IllegalArgumentException - if orientation is not one of: HORIZONTAL_SPLIT or VERTICAL_SPLIT

BaseSplitPane

public BaseSplitPane(int newOrientation,
                     boolean newContinuousLayout,
                     Component newLeftComponent,
                     Component newRightComponent)

Creates a new BaseSplitPane with the specified orientation and redrawing style, and with the specified components.

Parameters:

newOrientation - BaseSplitPane.HORIZONTAL_SPLIT or BaseSplitPane.VERTICAL_SPLIT

newContinuousLayout - a boolean, true for the components to redraw continuously as the divider changes position, false to wait until the divider position stops changing to redraw

newLeftComponent - the Component that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane

newRightComponent - the Component that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane

Throws:

IllegalArgumentException - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT

Method Detail

initialize

protected void initialize()

Initializes members.

setUISettingsParameters

public void setUISettingsParameters(Class cls,
                                    String property)

Sets the parameters for storing the divider location.

Specified by:

setUISettingsParameters in interface UISettingsSupporter

Parameters:

cls - the class

property - the property

clearUISettingsParameters

public void clearUISettingsParameters()

Clears the para meters for storing the divider location.

Specified by:

clearUISettingsParameters in interface UISettingsSupporter

isTopComponentHidden

public boolean isTopComponentHidden()

Returns whether the top component is hidden.

Returns:

true if the top component is hidden

setTopComponentHidden

public void setTopComponentHidden(boolean value)

Sets the hidden status of the top component. Has no effect if the top or bottom component are already hidden.

Parameters:

value - if true then the top component is to be hidden

isLeftComponentHidden

public boolean isLeftComponentHidden()

Returns whether the left component is hidden.

Returns:

true if the left component is hidden

setLeftComponentHidden

public void setLeftComponentHidden(boolean value)

Sets the hidden status of the left component. Has no effect if the left or right component are already hidden.

Parameters:

value - if true then the left component is to be hidden

isBottomComponentHidden

public boolean isBottomComponentHidden()

Returns whether the bottom component is hidden.

Returns:

true if the bottom component is hidden

setBottomComponentHidden

public void setBottomComponentHidden(boolean value)

Sets the hidden status of the bottom component. Has no effect if the bottom or bottom component are already hidden.

Parameters:

value - if true then the bottom component is to be hidden

isRightComponentHidden

public boolean isRightComponentHidden()

Returns whether the right component is hidden.

Returns:

true if the right component is hidden

setRightComponentHidden

public void setRightComponentHidden(boolean value)

Sets the hidden status of the right component. Has no effect if the right or right component are already hidden.

Parameters:

value - if true then the right component is to be hidden