Package adams.gui.core

Class SplitPanelWithOptionalComponents

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.SplitPanelWithOptionalComponents

All Implemented Interfaces:

CleanUpHandler, ImageObserver, MenuContainer, Serializable, Accessible

public class SplitPanelWithOptionalComponents
extends BasePanel
implements CleanUpHandler

A panel that has optional left/top or right/bottom components. If both are visible, then a split pane is used.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 JComponent	m_LeftComponent	the left component.
protected boolean	m_LeftDetachable	whether the left component is detachable.
protected boolean	m_LeftDetachableButtonVisible	whether a button to detach left component is visible.
protected DetachablePanel	m_LeftDetachablePanel	the detachable panel for the left component.
protected int	m_Orientation	the orientation.
protected JComponent	m_RightComponent	the right component.
protected boolean	m_RightDetachable	whether the right component is detachable.
protected boolean	m_RightDetachableButtonVisible	whether a button to detach right component is visible.
protected DetachablePanel	m_RightDetachablePanel	the detachable panel for the right component.
protected BaseSplitPane	m_SplitPane	the split pane.

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
SplitPanelWithOptionalComponents()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
protected void	finishInit()	Finishes the initialization.
JComponent	getBottomComponent()	Returns the bottom component.
int	getDividerLocation()	Return the divider location.
JComponent	getLeftComponent()	Returns the left component.
String	getLeftDetachedFrameTitle()	Returns the frame title for the detached left component.
int	getOrientation()	Returns the current orientation: JSplitPane.HORIZONTAL_SPLIT, JSplitPane.VERTICAL_SPLIT.
double	getResizeWeight()	Returns the number that determines how extra space is distributed.
JComponent	getRightComponent()	Returns the right component.
String	getRightDetachedFrameTitle()	Returns the frame title for the detached right component.
JComponent	getTopComponent()	Returns the top component.
protected void	initGUI()	Initializes the members.
protected void	initialize()	Initializes the members.
boolean	isBottomDetachable()	Returns whether the bottom component is detachable.
boolean	isBottomDetachableButtonVisible()	Returns the frame title for the detached bottom component.
boolean	isLeftDetachable()	Returns whether the left component is detachable.
boolean	isLeftDetachableButtonVisible()	Returns the frame title for the detached left component.
boolean	isRightDetachable()	Returns whether the right component is detachable.
boolean	isRightDetachableButtonVisible()	Returns the frame title for the detached right component.
boolean	isTopDetachable()	Returns whether the top component is detachable.
boolean	isTopDetachableButtonVisible()	Returns the frame title for the detached top component.
protected JComponent	makeDetachableIfNecessary(JComponent component, boolean left)	Wraps the component in a detachable panel, if necessary.
void	removeBottomComponent()	Removes the bottom component.
void	removeLeftComponent()	Removes the left component.
void	removeRightComponent()	Removes the right component.
void	removeTopComponent()	Removes the top component.
void	setBottomComponent(JComponent value)	Sets the bottom component.
void	setBottomDetachable(boolean value)	Sets whether the bottom component is detachable.
void	setBottomDetachableButtonVisible(boolean value)	Sets whether the button to detach the bottom component is visible.
void	setDividerLocation(int location)	Return the divider location.
void	setLeftComponent(JPanel value)	Sets the left component.
void	setLeftDetachable(boolean value)	Sets whether the left component is detachable.
void	setLeftDetachableButtonVisible(boolean value)	Sets whether the button to detach the left component is visible.
void	setLeftDetachedFrameTitle(String value)	Sets the frame title for the detached left component.
void	setOrientation(int value)	Sets the orientation: JSplitPane.HORIZONTAL_SPLIT, JSplitPane.VERTICAL_SPLIT.
void	setResizeWeight(double value)	Specifies how to distribute extra space when the size of the split pane changes.
void	setRightComponent(JComponent value)	Sets the right component.
void	setRightDetachable(boolean value)	Sets whether the right component is detachable.
void	setRightDetachableButtonVisible(boolean value)	Sets whether the button to detach the right component is visible.
void	setRightDetachedFrameTitle(String value)	Sets the frame title for the detached right component.
void	setTopComponent(JPanel value)	Sets the top component.
void	setTopDetachable(boolean value)	Sets whether the top component is detachable.
void	setTopDetachableButtonVisible(boolean value)	Sets whether the button to detach the top component is visible.
void	setUISettingsParameters(Class cls)	Sets the class to use for the UI settings.
protected void	update()	Updates the layout.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, 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_SplitPane

protected BaseSplitPane m_SplitPane

the split pane.

m_LeftDetachablePanel

protected DetachablePanel m_LeftDetachablePanel

the detachable panel for the left component.

m_LeftComponent

protected JComponent m_LeftComponent

the left component.

m_RightDetachablePanel

protected DetachablePanel m_RightDetachablePanel

the detachable panel for the right component.

m_RightComponent

protected JComponent m_RightComponent

the right component.

m_Orientation

protected int m_Orientation

the orientation.

m_LeftDetachable

protected boolean m_LeftDetachable

whether the left component is detachable.

m_RightDetachable

protected boolean m_RightDetachable

whether the right component is detachable.

m_LeftDetachableButtonVisible

protected boolean m_LeftDetachableButtonVisible

whether a button to detach left component is visible.

m_RightDetachableButtonVisible

protected boolean m_RightDetachableButtonVisible

whether a button to detach right component is visible.

Constructor Detail

SplitPanelWithOptionalComponents

public SplitPanelWithOptionalComponents()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the members.

Overrides:

initGUI in class BasePanel

finishInit

protected void finishInit()

Finishes the initialization.

Overrides:

finishInit in class BasePanel

setUISettingsParameters

public void setUISettingsParameters(Class cls)

Sets the class to use for the UI settings.

Parameters:

cls - the class to use

setOrientation

public void setOrientation(int value)

Sets the orientation: JSplitPane.HORIZONTAL_SPLIT, JSplitPane.VERTICAL_SPLIT.

Parameters:

value - the new orientation

getOrientation

public int getOrientation()

Returns the current orientation: JSplitPane.HORIZONTAL_SPLIT, JSplitPane.VERTICAL_SPLIT.

Returns:

the new orientation

setLeftComponent

public void setLeftComponent(JPanel value)

Sets the left component.

Parameters:

value - the left component, null to remove

getLeftComponent

public JComponent getLeftComponent()

Returns the left component.

Returns:

the left component, can be null

removeLeftComponent

public void removeLeftComponent()

Removes the left component.

setRightComponent

public void setRightComponent(JComponent value)

Sets the right component.

Parameters:

value - the right component, null to remove

getRightComponent

public JComponent getRightComponent()

Returns the right component.

Returns:

the right component, can be null

removeRightComponent

public void removeRightComponent()

Removes the right component.

setTopComponent

public void setTopComponent(JPanel value)

Sets the top component.

Parameters:

value - the top component, can be null

getTopComponent

public JComponent getTopComponent()

Returns the top component.

Returns:

the top component, can be null

removeTopComponent

public void removeTopComponent()

Removes the top component.

setBottomComponent

public void setBottomComponent(JComponent value)

Sets the bottom component.

Parameters:

value - the bottom component, null to use empty panel

getBottomComponent

public JComponent getBottomComponent()

Returns the bottom component.

Returns:

the bottom component

removeBottomComponent

public void removeBottomComponent()

Removes the bottom component.

setLeftDetachable

public void setLeftDetachable(boolean value)

Sets whether the left component is detachable.

Parameters:

value - true if to be detachable

isLeftDetachable

public boolean isLeftDetachable()

Returns whether the left component is detachable.

Returns:

true if detachable

setRightDetachable

public void setRightDetachable(boolean value)

Sets whether the right component is detachable.

Parameters:

value - true if to be detachable

isRightDetachable

public boolean isRightDetachable()

Returns whether the right component is detachable.

Returns:

true if detachable

setTopDetachable

public void setTopDetachable(boolean value)

Sets whether the top component is detachable.

Parameters:

value - true if to be detachable

isTopDetachable

public boolean isTopDetachable()

Returns whether the top component is detachable.

Returns:

true if detachable

setBottomDetachable

public void setBottomDetachable(boolean value)

Sets whether the bottom component is detachable.

Parameters:

value - true if to be detachable

isBottomDetachable

public boolean isBottomDetachable()

Returns whether the bottom component is detachable.

Returns:

true if detachable

setLeftDetachedFrameTitle

public void setLeftDetachedFrameTitle(String value)

Sets the frame title for the detached left component.

Parameters:

value - the title

getLeftDetachedFrameTitle

public String getLeftDetachedFrameTitle()

Returns the frame title for the detached left component.

Returns:

the title

setRightDetachedFrameTitle

public void setRightDetachedFrameTitle(String value)

Sets the frame title for the detached right component.

Parameters:

value - the title

getRightDetachedFrameTitle

public String getRightDetachedFrameTitle()

Returns the frame title for the detached right component.

Returns:

the title

setLeftDetachableButtonVisible

public void setLeftDetachableButtonVisible(boolean value)

Sets whether the button to detach the left component is visible.

Parameters:

value - true if visible

isLeftDetachableButtonVisible

public boolean isLeftDetachableButtonVisible()

Returns the frame title for the detached left component.

Returns:

true if visible

setRightDetachableButtonVisible

public void setRightDetachableButtonVisible(boolean value)

Sets whether the button to detach the right component is visible.

Parameters:

value - true if visible

isRightDetachableButtonVisible

public boolean isRightDetachableButtonVisible()

Returns the frame title for the detached right component.

Returns:

true if visible

setTopDetachableButtonVisible

public void setTopDetachableButtonVisible(boolean value)

Sets whether the button to detach the top component is visible.

Parameters:

value - true if visible

isTopDetachableButtonVisible

public boolean isTopDetachableButtonVisible()

Returns the frame title for the detached top component.

Returns:

true if visible

setBottomDetachableButtonVisible

public void setBottomDetachableButtonVisible(boolean value)

Sets whether the button to detach the bottom component is visible.

Parameters:

value - true if visible

isBottomDetachableButtonVisible

public boolean isBottomDetachableButtonVisible()

Returns the frame title for the detached bottom component.

Returns:

true if visible

setDividerLocation

public void setDividerLocation(int location)

Return the divider location.

Parameters:

location - the divider location

getDividerLocation

public int getDividerLocation()

Return the divider location.

Returns:

the divider location

setResizeWeight

public void setResizeWeight(double value)

Specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space.

Parameters:

value - as described above

Throws:

IllegalArgumentException - if value is < 0 or > 1

getResizeWeight

public double getResizeWeight()

Returns the number that determines how extra space is distributed.

Returns:

how extra space is to be distributed on a resize of the split pane

makeDetachableIfNecessary

protected JComponent makeDetachableIfNecessary(JComponent component,
                                               boolean left)

Wraps the component in a detachable panel, if necessary.

Parameters:

component - the component to wrap

left - whether left or right component

Returns:

the (potentially) wrapped component

update

protected void update()

Updates the layout.

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler