phenote.gui
Class StackedBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  phenote.gui.StackedBox

All Implemented Interfaces:

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

public class StackedBox
extends javax.swing.JPanel
implements javax.swing.Scrollable

Stacks components vertically in boxes. Each box is created with a title and a component.

The StackedBox can be added to a JScrollPane.

Note: this class is not part of the SwingX core classes. It is just an example of what can be achieved with the components. A helper class i retrieved from the web on 10.15.2007 https://swinglabs.dev.java.net/source/browse/*checkout* /swinglabs/website/web/docs/components/JXCollapsiblePane/StackedBox.java.txt

This is to facilitate generating collapsible panels for use in the TermInfo2 box

Author:

Frederic Lavigne, Nicole Washington

See Also:

Serialized Form

Nested Class Summary

(package private) class

StackedBox.SeparatorBorder The border between the stack components.

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

StackedBox()

Method Summary

void	addBox(java.lang.String title, java.awt.Component component) Each component that is added to a stacked box includes a link, which expands/collapses a given JComponent in a collapsible pane.
java.awt.Dimension	getPreferredScrollableViewportSize()
int	getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
boolean	getScrollableTracksViewportHeight()
boolean	getScrollableTracksViewportWidth()
int	getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
java.awt.Color	getSeparatorColor()
java.awt.Color	getTitleBackgroundColor()
java.awt.Color	getTitleForegroundColor()
void	hideBox()
void	setBoxTitle(java.lang.String title, int i) This method is designed to change the title text of a given collapsible pane.
void	setBoxTitleBackgroundColor(int i, java.awt.Color color) This method is designed to change the title backgroun color of a given collapsible pane.
void	setSeparatorColor(java.awt.Color separatorColor)
void	setTitleBackgroundColor(java.awt.Color titleBackgroundColor)
void	setTitleForegroundColor(java.awt.Color titleForegroundColor)
void	showBox()

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StackedBox

public StackedBox()

Method Detail

getSeparatorColor

public java.awt.Color getSeparatorColor()

setSeparatorColor

public void setSeparatorColor(java.awt.Color separatorColor)

getTitleForegroundColor

public java.awt.Color getTitleForegroundColor()

setTitleForegroundColor

public void setTitleForegroundColor(java.awt.Color titleForegroundColor)

getTitleBackgroundColor

public java.awt.Color getTitleBackgroundColor()

setTitleBackgroundColor

public void setTitleBackgroundColor(java.awt.Color titleBackgroundColor)

addBox

public void addBox(java.lang.String title,
                   java.awt.Component component)

Each component that is added to a stacked box includes a link, which expands/collapses a given JComponent in a collapsible pane.

Adds a new component and link to this StackedBox

Parameters:

title - the text placed in the hyperlink in the division between content panes

component - the JComponent that can be hidden/visible, as controlled by the hyperlink given in the title

getPreferredScrollableViewportSize

public java.awt.Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface javax.swing.Scrollable

See Also:

Scrollable.getPreferredScrollableViewportSize()

getScrollableBlockIncrement

public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Specified by:

getScrollableBlockIncrement in interface javax.swing.Scrollable

See Also:

Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight in interface javax.swing.Scrollable

See Also:

Scrollable.getScrollableTracksViewportHeight()

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface javax.swing.Scrollable

See Also:

Scrollable.getScrollableTracksViewportWidth()

getScrollableUnitIncrement

public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Specified by:

getScrollableUnitIncrement in interface javax.swing.Scrollable

See Also:

Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)

setBoxTitle

public void setBoxTitle(java.lang.String title,
                        int i)

This method is designed to change the title text of a given collapsible pane.

Parameters:

title - title of the box

i - the pane for which the title will be changed

setBoxTitleBackgroundColor

public void setBoxTitleBackgroundColor(int i,
                                       java.awt.Color color)

This method is designed to change the title backgroun color of a given collapsible pane.

Parameters:

i - the pane for which the title will be changed

color - new color to set the background color of the box

hideBox

public void hideBox()

showBox

public void showBox()