oracle.javatools.ui

Class HeaderPanel<T extends javax.swing.JComponent>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.javatools.ui.HeaderPanel<T>

All Implemented Interfaces:

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

public final class HeaderPanel<T extends javax.swing.JComponent>
extends javax.swing.JPanel

HeaderPanel hosts a header control and one other component. It hides the other component when the header is collapsed. There are three collapse modes: COLLAPSE_UP COLLAPSE_LEFT COLLAPSE_RIGHT By default, the size of this component is based on the preferred size of the header and the preferred size of the component.

The collapse effect is animated. For this to work properly, the container in which the HeaderPanel is placed must honor the preferred size of this component.

This component is not designed to be subclasses, nor is it designed to support any components in addition to the header and the hosted component. Additional components will not be displayed.

If the hosted component indicates status, it can be set directly via getHeader().setStatusIndicator(). Alternatively if the hosted component has a StatusIndicator set as a client property with key StatusIndicator.PROPERTY_STATUS_INDICATOR, then it will be picked up automatically.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderPanel.CollapseMode The ways in which a HeaderPanel can collapse.

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

javax.swing.JPanel.AccessibleJPanel

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.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

Constructors

Constructor and Description
HeaderPanel() Constructs a header panel with no initial hosted component.
HeaderPanel(T hostedComponent) Creates a header panel with the specified hosted component.
HeaderPanel(T hostedComponent, boolean allowOpaqueComponents) Creates a header panel with the specified hosted component.

Method Summary

Methods

Modifier and Type	Method and Description
void	doLayout()
HeaderPanel.CollapseMode	getCollapseMode() Gets the current collapse mode.
Header	getHeader() Gets the header.
T	getHostedComponent() Returns the currently hosted component.
java.awt.Dimension	getPreferredSize()
java.lang.String	getStaticHelpText() Returns the static help text displayed under this header.
boolean	isAnimationEnabled() Returns true if animation is enabled for this component instance.
boolean	isComponentBorderPainted() Returns true if a border is painted around the hosted component.
boolean	isComponentIndented() Returns whether the component is indented.
protected void	paintChildren(java.awt.Graphics g)
void	setAnimationEnabled(boolean animationEnabled) Sets whether animation effects are enabled for this component instance.
void	setCollapseMode(HeaderPanel.CollapseMode collapseMode) Sets the way in which this component will collapse.
void	setComponentBorderPainted(boolean paintComponentBorder) Sets whether to draw a border around the hosted component when the header is expanded.
void	setComponentIndented(boolean indented) Set whether the component is indented in this panel.
void	setHostedComponent(T c) Sets the component to host.
void	setName(java.lang.String name) Override default get name functionality to automatically set derrived name on the Header object
void	setStaticHelpText(java.lang.String staticHelpText) Sets static help text to display under this header.

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

Constructor Detail

HeaderPanel

public HeaderPanel(T hostedComponent)

Creates a header panel with the specified hosted component.

By default, the hosted component and its children will be forced non-opaque. Any additional components added to the hosted component will also be forced non-opaque. If you don't want this behavior, use the #HeaderPanel( T, boolean ) constructor.

Parameters:

hostedComponent - the component to host in the header panel.

HeaderPanel

public HeaderPanel(T hostedComponent,
           boolean allowOpaqueComponents)

Creates a header panel with the specified hosted component.

Parameters:

hostedComponent - the component to host in the header panel.

allowOpaqueComponents - if false, children of the hosted component will be forced non-opaque.

HeaderPanel

public HeaderPanel()

Constructs a header panel with no initial hosted component. You can later set the hosted component by calling #setHostedComponent(Component).

Method Detail

setAnimationEnabled

public void setAnimationEnabled(boolean animationEnabled)

Sets whether animation effects are enabled for this component instance.

Parameters:

animationEnabled - if true, this component instance uses animation effects.

isAnimationEnabled

public boolean isAnimationEnabled()

Returns true if animation is enabled for this component instance.

Returns:

true if animation is enabled for this component instance.

setStaticHelpText

public void setStaticHelpText(java.lang.String staticHelpText)

Sets static help text to display under this header.

Parameters:

staticHelpText -

getStaticHelpText

public java.lang.String getStaticHelpText()

Returns the static help text displayed under this header.

Returns:

that static help text for this header.

setComponentIndented

public void setComponentIndented(boolean indented)

Set whether the component is indented in this panel. By default, components are indented using the standard indent for headers (20 pixels).

Parameters:

indented - if true, the component is indented.

isComponentIndented

public boolean isComponentIndented()

Returns whether the component is indented.

Returns:

true if the component is indented.

setComponentBorderPainted

public void setComponentBorderPainted(boolean paintComponentBorder)

Sets whether to draw a border around the hosted component when the header is expanded. The default is false.

Parameters:

paintComponentBorder - true if a border is painted around the hosted component.

isComponentBorderPainted

public boolean isComponentBorderPainted()

Returns true if a border is painted around the hosted component.

Returns:

true if a border is painted around the hosted component.

setCollapseMode

public void setCollapseMode(HeaderPanel.CollapseMode collapseMode)

Sets the way in which this component will collapse.

Parameters:

collapseMode - the collapse mode. Must not be null.

getCollapseMode

public HeaderPanel.CollapseMode getCollapseMode()

Gets the current collapse mode.

Returns:

the collapse mode, not null.

setHostedComponent

public void setHostedComponent(T c)

Sets the component to host. This will add the component to the panel. Any existing hosted component will be removed.

Parameters:

c - the component to host.

getHostedComponent

public T getHostedComponent()

Returns the currently hosted component.

Returns:

a component. Will not be null.

getHeader

public Header getHeader()

Gets the header.

Returns:

the header.

setName

public void setName(java.lang.String name)

Override default get name functionality to automatically set derrived name on the Header object

Overrides:

setName in class java.awt.Component

Parameters:

name -

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

doLayout

public void doLayout()

Overrides:

doLayout in class java.awt.Container

paintChildren

protected void paintChildren(java.awt.Graphics g)

Overrides:

paintChildren in class javax.swing.JComponent