util.ui
Class DisclosureTriangle

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  util.ui.DisclosureTriangle

All Implemented Interfaces:

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

public final class DisclosureTriangle
extends javax.swing.JPanel

Disclosure triangle container. http://www.dishevelled.org/disclosure-triangle/

Version:

$Revision$ $Date$

Author:

Michael Heuer

See Also:

Serialized Form

Nested Class Summary

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

static java.lang.String

DEFAULT_LABEL_TEXT Default label text, "Details".

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

DisclosureTriangle(java.awt.Container container)
Create a new disclosure triangle container wrapping the specified container.

Method Summary

void	collapse() Collapse this disclosure triangle container.
void	expand() Expand this disclosure triangle container.
javax.swing.Icon	getCollapseIcon() Return the collapse icon for this disclosure triangle container.
javax.swing.Icon	getExpandIcon() Return the expand icon for this disclosure triangle container.
java.lang.String	getLabelText() Return the label text for this disclosure triangle container.
boolean	isCollapsed() Return true if this disclosure triangle container is collapsed.
void	setCollapsed(boolean collapsed) Set to true to collapse this disclosure triangle container.
void	setCollapseIcon(javax.swing.Icon collapseIcon) Set the collapse icon for this disclosure triangle container to collapseIcon.
void	setExpandIcon(javax.swing.Icon expandIcon) Set the expand icon for this disclosure triangle container to expandIcon.
void	setLabelText(java.lang.String labelText) Set the label text for this disclosure triangle container to labelText.

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

Field Detail

DEFAULT_LABEL_TEXT

public static final java.lang.String DEFAULT_LABEL_TEXT

Default label text, "Details".

See Also:

Constant Field Values

Constructor Detail

DisclosureTriangle

public DisclosureTriangle(java.awt.Container container)

Create a new disclosure triangle container wrapping the specified container.

By default this disclosure triangle container will be collapsed, its label text will be "Details", its collapse icon will be the icon resource returned by UIManager.getIcon("Tree.expandedIcon"), and its expand icon will be the icon resource returned by UIManager.getIcon("Tree.collapsedIcon").

Parameters:

container - container to wrap, must not be null

See Also:

DEFAULT_LABEL_TEXT, UIManager.getIcon(java.lang.Object)

Method Detail

expand

public void expand()

Expand this disclosure triangle container.

collapse

public void collapse()

Collapse this disclosure triangle container.

isCollapsed

public boolean isCollapsed()

Return true if this disclosure triangle container is collapsed.

Returns:

true if this disclosure triangle container is collapsed

setCollapsed

public void setCollapsed(boolean collapsed)

Set to true to collapse this disclosure triangle container. Alternatively, call collapse() or expand() as appropriate.

This is a bound property.

Parameters:

collapsed - true to collapse this disclosure triangle container

getLabelText

public java.lang.String getLabelText()

Return the label text for this disclosure triangle container.

Returns:

the label text for this disclosure triangle container

setLabelText

public void setLabelText(java.lang.String labelText)

Set the label text for this disclosure triangle container to labelText.

This is a bound property.

Parameters:

labelText - label text for this disclosure triangle container

getCollapseIcon

public javax.swing.Icon getCollapseIcon()

Return the collapse icon for this disclosure triangle container.

Returns:

the collapse icon for this disclosure triangle container

setCollapseIcon

public void setCollapseIcon(javax.swing.Icon collapseIcon)

Set the collapse icon for this disclosure triangle container to collapseIcon.

This is a bound property.

Parameters:

collapseIcon - collapse icon for this disclosure triangle container

getExpandIcon

public javax.swing.Icon getExpandIcon()

Return the expand icon for this disclosure triangle container.

Returns:

the expand icon for this disclosure triangle container

setExpandIcon

public void setExpandIcon(javax.swing.Icon expandIcon)

Set the expand icon for this disclosure triangle container to expandIcon.

This is a bound property.

Parameters:

expandIcon - expand icon for this disclosure triangle container