org.vizzini.ui
Class StatusBar

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.vizzini.ui.StatusBar
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, IListener, IStatusListener

public class StatusBar
extends JPanel
implements IStatusListener

Provides a UI for a status message area. This message area may contain one to many separate message areas.

Since:
v0.1
Version:
v0.2
Author:
Jeffrey M. Thompson
See Also:
Serialized Form

Nested Class Summary
 
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.BltBufferStrategy, 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
StatusBar(int[] relativeSizes)
          Construct a message area which contains the same number of message labels as the size of the input array of their relative sizes.
StatusBar(int[] relativeSizes, Color fontColor, Font font)
          Construct a message area which contains the same number of message labels as the size of the input array of their relative sizes.
 
Method Summary
 void clear(int position)
          Clear the specified message label.
 void clearAll()
          Clear all the message labels.
 String getText(int position)
          Return the display string on the specified message label.
 void setBackground(int position, Color color)
          Set the background color of the specified message label.
 void setEnabled(int position, boolean enabled)
          Set the enabled state of the specified message label.
 void setForeground(int position, Color color)
          Set the foreground color of the specified message label.
 void setHorizontalAlignment(int position, int alignment)
          Sets the alignment of the label's contents along the X axis.
 void setIcon(int position, Icon icon)
          Set the icon on the specified message label.
 void setText(int position, String message)
          Set the display string on the specified message label.
 void setText(int position, String message, int displayTime)
          Set the display string on the specified message label.
 void setToolTipText(int position, String toolTip)
          Set the tool tip on the specified message label.
 void statusChange(StatusEvent event)
          Respond to status events.
 
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

StatusBar

public StatusBar(int[] relativeSizes)
Construct a message area which contains the same number of message labels as the size of the input array of their relative sizes.

Parameters:
relativeSizes - Array of relative widths.
Since:
v0.1

StatusBar

public StatusBar(int[] relativeSizes,
                 Color fontColor,
                 Font font)
Construct a message area which contains the same number of message labels as the size of the input array of their relative sizes.

Parameters:
relativeSizes - Array of relative widths.
fontColor - Font color.
font - Font.
Since:
v0.1
Method Detail

clear

public void clear(int position)
Clear the specified message label.

Parameters:
position - Position index where zero is the left most message area.
Since:
v0.1

clearAll

public void clearAll()
Clear all the message labels.

Since:
v0.1

getText

public String getText(int position)
Return the display string on the specified message label.

Parameters:
position - Position index where zero is the left most message area.
Since:
v0.1

setBackground

public void setBackground(int position,
                          Color color)
Set the background color of the specified message label.

Parameters:
position - Position index where zero is the left most message area.
color - Color.
Since:
v0.1

setEnabled

public void setEnabled(int position,
                       boolean enabled)
Set the enabled state of the specified message label.

Parameters:
position - Position index where zero is the left most message area.
enabled - Flag indicating if the given position should be enabled.
Since:
v0.1

setForeground

public void setForeground(int position,
                          Color color)
Set the foreground color of the specified message label.

Parameters:
position - Position index where zero is the left most message area.
color - Color.
Since:
v0.1

setHorizontalAlignment

public void setHorizontalAlignment(int position,
                                   int alignment)
Sets the alignment of the label's contents along the X axis.

Parameters:
position - Position index where zero is the left most message area.
alignment - Horizontal alignment.
Since:
v0.1

setIcon

public void setIcon(int position,
                    Icon icon)
Set the icon on the specified message label.

Parameters:
position - Position index where zero is the left most message area.
icon - Icon.
Since:
v0.1

setText

public void setText(int position,
                    String message)
Set the display string on the specified message label.

Parameters:
position - Position index where zero is the left most message area.
message - Message to display.
Since:
v0.1

setText

public void setText(int position,
                    String message,
                    int displayTime)
Set the display string on the specified message label.

Parameters:
position - Position index where zero is the left most message area.
message - The message to display.
displayTime - The time to display the message. If <= 0, the message remains until replaced.
Since:
v0.1

setToolTipText

public void setToolTipText(int position,
                           String toolTip)
Set the tool tip on the specified message label.

Parameters:
position - Position index where zero is the left most message area.
toolTip - Tool tip text.
Since:
v0.1

statusChange

public void statusChange(StatusEvent event)
Respond to status events.

Specified by:
statusChange in interface IStatusListener
Parameters:
event - Status event.
Since:
v0.1


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02