com.portal.ctrl

Class PSectionHeader

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.ctrl.PSectionHeader

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class PSectionHeader
extends JPanel

A panel representing a UI section header, used to separate data on a panel. This component can manifest itself in three different ways:

• A solid colored bar (normal header)
• A solid colored bar that can be expanded/collapsed (collapsable header)
• An opaque bar surrounded by a light border that can be expanded/collapsed (a subheader)

It is up to the caller to determine the layout of this panel, but typical usage would involve a BorderLayout, a "description" panel added to the top (North) and a central panel (Center) that may or may not be collapsed.
For collapsable panels, a box is displayed on the left side containing a +/- symbol. Clicking this box controls the visibility of the component designated as the 'componentToCollapse'.

Version:

%version: 13 % %date_modified: Thu Oct 25 11:49:48 2001 % Continuus information --- %full_filespec: PSectionHeader.java~13:java:2 %

Author:

kapono

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSectionHeader.CollapsedIcon The plus sign button icon
static class	PSectionHeader.ExpandedIcon The minus sign button icon

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 and Description
protected com.portal.ctrl.ButtonAdapter	adapter
protected static int	FULL_SIZE
protected static int	HALF_SIZE
protected JComponent	mComp
protected boolean	mExpandable
protected boolean	mExpandState
protected JComponent[]	mHeaderComps
protected JComponent	mHeaderLabel
protected Border	mOldBorder
protected boolean	mSubHeader
protected static Dimension	PREFERRED_SIZE
protected static FontMetrics	sFm
protected static int	SIZE
protected static JButton	SIZER
protected static ButtonUI	UI

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 and Description
PSectionHeader() Creates a standard header component.
PSectionHeader(JComponent c) Creates a collapsable header component, with the passed in component being designated as the 'collapsable' component

Method Summary

Modifier and Type	Method and Description
void	addNotify() Overridden to apply the font style to the header label, and the correct look and feel color to the components in the header
JComponent	getComponentToCollapse() Retrieves the collapsable component
Dimension	getPreferredSize() Returns the preferred size for a PSectionHeader.
boolean	isExpanded() Returns the visible state of the component to collapse
boolean	isHeaderExpandable() Determines if this header component contains an expand control
boolean	isSubHeader() Retrieves the subheader status of this component
void	setComponentToCollapse(JComponent c) Specifies the component to collapse
void	setExpanded(boolean b) This gets invoked by the look&feel when the user selects the +/- button.
void	setHeaderComponents(JComponent[] comps)
void	setHeaderExpandable(boolean b) Identifies this header instance as being expandable or not.
void	setHeaderLabel(JComponent l) Identifies the component that displays the title for this header.
void	setSubHeader(boolean b) Used to turn this section header into a subheader.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

mHeaderLabel

protected JComponent mHeaderLabel

mExpandState

protected boolean mExpandState

mSubHeader

protected boolean mSubHeader

mExpandable

protected boolean mExpandable

mComp

protected JComponent mComp

mOldBorder

protected Border mOldBorder

adapter

protected com.portal.ctrl.ButtonAdapter adapter

mHeaderComps

protected JComponent[] mHeaderComps

SIZER

protected static final JButton SIZER

UI

protected static final ButtonUI UI

PREFERRED_SIZE

protected static final Dimension PREFERRED_SIZE

sFm

protected static FontMetrics sFm

HALF_SIZE

protected static final int HALF_SIZE

See Also:

Constant Field Values

FULL_SIZE

protected static final int FULL_SIZE

See Also:

Constant Field Values

SIZE

protected static final int SIZE

See Also:

Constant Field Values

Constructor Detail

PSectionHeader

public PSectionHeader()

Creates a standard header component. By default, this is a regular header component. You can choose to make it expandable, or turn it into a subheader component via method calls after creating it.

PSectionHeader

public PSectionHeader(JComponent c)

Creates a collapsable header component, with the passed in component being designated as the 'collapsable' component

Parameters:

c - The component that should be collapsed when requested by the user.

Method Detail

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size for a PSectionHeader. Uses JButton height and Font height to calculate a preferred size so that all PSectionHeader's will have a consistent size.

Overrides:

getPreferredSize in class JComponent

Returns:

preferred size.

setComponentToCollapse

public void setComponentToCollapse(JComponent c)

Specifies the component to collapse

Parameters:

c - The component that should be collapsed when requested by the user.

getComponentToCollapse

public JComponent getComponentToCollapse()

Retrieves the collapsable component

Returns:

The component that is collapsed/expanded

setHeaderExpandable

public void setHeaderExpandable(boolean b)

Identifies this header instance as being expandable or not. By default, a header is not expandable. Note that this is mutually exclusive as it relates to subheaders - they are always expandable.

Parameters:

b -

isHeaderExpandable

public boolean isHeaderExpandable()

Determines if this header component contains an expand control

Returns:

Returns the expandle state of this header component

setSubHeader

public void setSubHeader(boolean b)

Used to turn this section header into a subheader. The visual representation will include an expand/collapse control, and a border instead of a solid colored background.
By default, this is false.

Parameters:

b - If true, make a subheader; if false, make this a regular header

isSubHeader

public boolean isSubHeader()

Retrieves the subheader status of this component

Returns:

true if this is a subheader, false otherwise

setExpanded

public void setExpanded(boolean b)

This gets invoked by the look&feel when the user selects the +/- button.

Parameters:

b - When true, expand the component; when false, collapse it

isExpanded

public boolean isExpanded()

Returns the visible state of the component to collapse

Returns:

true if the component to collapse is visible; false otherwise

setHeaderLabel

public void setHeaderLabel(JComponent l)

Identifies the component that displays the title for this header. This is a convenience API that will apply the correct system Font style for the title label.

Parameters:

The - label component

setHeaderComponents

public void setHeaderComponents(JComponent[] comps)

addNotify

public void addNotify()

Overridden to apply the font style to the header label, and the correct look and feel color to the components in the header

Overrides:

addNotify in class JComponent