PamView.hidingpanel

Class HidingPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

PamView.PamPanel

PamView.hidingpanel.HidingPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ColorManaged

Direct Known Subclasses:

TabbedHidingPane.TabHidingPanel

public class HidingPanel
extends PamPanel

Class for a hiding, possibly sliding panel to hold things like the side bar, top control panel of the clip display, etc.

Author:

Doug Gillespie

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	HORIZONTAL
static int	VERTICAL

Fields inherited from class javax.swing.JComponent

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

Constructors

Constructor and Description
HidingPanel(java.awt.Component componentFrame, java.awt.Component mainComponent, int direction, boolean canScroll) Create a panel which can hide.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMainComponent(java.awt.Component mainComponent) Add the mainComponent to the hiding panel
void	extraPainting(java.awt.Graphics g) Extra painting to highlight panel if mouse is inside.
PamPanel	getEdgePanel() Get the panel which contains the show and hide buttons
javax.swing.JButton	getHideButton() Get the button which controls hide behaviour.
java.awt.Component	getMainComponent()
boolean	isExpanded() Return true if the panel is in it's expanded state.
boolean	isHighlight() Check whether the hiding panel is highlighted when the mouse enters.
void	paintComponent(java.awt.Graphics g)
void	removeMainComponent() Remove the mainComponentPanel.
void	reverseShowButton() Swaps the hide and show buttons around.
void	setEdgePanel(PamPanel edgePanel)
void	setHighlight(boolean highlight) Set whether the hiding panel is highlighted when the mouse enters.
void	setOpaque(boolean isOpaque)
void	setTitle(java.lang.String title)
void	showPanel(boolean state) Show or hide the panel

Methods inherited from class PamView.PamPanel

addComponent, getColorId, getDefaultColor, getFrame, getPreferredBorderColours, layoutGrid, setBackground, setDefaultColor, setPreferredBorderColour

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

Constructor Detail

HidingPanel

public HidingPanel(java.awt.Component componentFrame,
           java.awt.Component mainComponent,
           int direction,
           boolean canScroll)

Create a panel which can hide.

Parameters:

componentFrame - the component where the hiding panel will sit.

mainComponent - - the component which will be shown inside the hiding panel i.e. the component which can be hidden.

direction - - direction: either HORIZONTAL or VERTICAL.

canScroll - - true if mainComponent is shwon within a scroll pane.

Method Detail

paintComponent

public void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

extraPainting

public void extraPainting(java.awt.Graphics g)

Extra painting to highlight panel if mouse is inside.

Parameters:

g- - graphics handle.

reverseShowButton

public void reverseShowButton()

Swaps the hide and show buttons around. Generally use this when a panel is on left hand side or bottom of screen.

setTitle

public void setTitle(java.lang.String title)

showPanel

public void showPanel(boolean state)

Show or hide the panel

Parameters:

state - true = show, false = hide.

isExpanded

public boolean isExpanded()

Return true if the panel is in it's expanded state.

Returns:

whether the panel is showing or not.

setOpaque

public void setOpaque(boolean isOpaque)

Overrides:

setOpaque in class javax.swing.JComponent

removeMainComponent

public void removeMainComponent()

Remove the mainComponentPanel.

addMainComponent

public void addMainComponent(java.awt.Component mainComponent)

Add the mainComponent to the hiding panel

Parameters:

mainComponent -

getHideButton

public javax.swing.JButton getHideButton()

Get the button which controls hide behaviour. Can be used to add additional listeners.

Returns:

HidePanel button.

getMainComponent

public java.awt.Component getMainComponent()

getEdgePanel

public PamPanel getEdgePanel()

Get the panel which contains the show and hide buttons

Returns:

panel which contaisn the show and hide buttons

setEdgePanel

public void setEdgePanel(PamPanel edgePanel)

isHighlight

public boolean isHighlight()

Check whether the hiding panel is highlighted when the mouse enters. Only highlights the panle, not top level components.

Returns:

true of panel is set to highlight.

setHighlight

public void setHighlight(boolean highlight)

Set whether the hiding panel is highlighted when the mouse enters. Only highlights the panle, not top level components.