com.townleyenterprises.swing
Class TStatusBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.townleyenterprises.swing.TStatusBar

All Implemented Interfaces:

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

public class TStatusBar

extends javax.swing.JPanel

This is a GUI class representing a status bar common to most applications. A simple status bar is pretty easy to manage with the basic controls, but when you want to replace controls or add certain things dynamically, it gets somewhat cumbersome. This is an attempt to solve those issues.

Since:

2.1

Version:

$Id: TStatusBar.java,v 1.7 2004/07/29 18:35:01 atownley Exp $

Author:

Andrew S. Townley

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes 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

TStatusBar()
This constructor creates a status bar which will not display localized text.

TStatusBar(ResourceProvider provider)
This constructor builds your basic, vanilla status bar using the indicated ResourceProvider to load resource strings.

Method Summary

java.awt.Component	add(java.awt.Component component) This method is used to add components to the right side of the status bar.
javax.swing.event.ChangeListener	getMenuStatusListener(java.lang.String property, boolean localized) This method returns a ChangeListener which is configured to automatically update the status text based on the currently selected menu item.
void	monitorTask(MonitoredTask task, double interval) This method is used to automatically monitor a MonitoredTask using a progress bar.
void	monitorTask(MonitoredTask task, int interval)
void	remove(java.awt.Component component) This method is used to remove the given component from the status bar.
void	removeAll() This method removes all of the components from the status bar except the default control.
void	restore() This method is used to restore the normal status component.
void	setComponent(java.awt.Component component) This method is used to set the main component of the status bar to something other than the default.
void	setLocalizedText(java.lang.String key) This method sets the status text on the status bar base on the resource key.
void	setText(java.lang.String text) This method sets the status text on the status bar.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

TStatusBar

public TStatusBar()

This constructor creates a status bar which will not display localized text.

TStatusBar

public TStatusBar(ResourceProvider provider)

This constructor builds your basic, vanilla status bar using the indicated ResourceProvider to load resource strings.

Parameters:

provider - the resource provider

Method Detail

add

public java.awt.Component add(java.awt.Component component)

This method is used to add components to the right side of the status bar.

Parameters:

component -

Returns:

the component argument

getMenuStatusListener

public javax.swing.event.ChangeListener getMenuStatusListener(java.lang.String property,
                                                              boolean localized)

This method returns a ChangeListener which is configured to automatically update the status text based on the currently selected menu item.

Parameters:

property - the client property name holding the status text of the menu item

localized - true to present localized strings; false to assume strings already localized

Returns:

a ChangeListener for menu events

monitorTask

public void monitorTask(MonitoredTask task,
                        double interval)

This method is used to automatically monitor a MonitoredTask using a progress bar.

Parameters:

task - the task to monitor

interval - the number of seconds to wait between updates

monitorTask

public void monitorTask(MonitoredTask task,
                        int interval)

remove

public void remove(java.awt.Component component)

This method is used to remove the given component from the status bar.

Parameters:

component -

removeAll

public void removeAll()

This method removes all of the components from the status bar except the default control.

restore

public void restore()

This method is used to restore the normal status component.

setComponent

public void setComponent(java.awt.Component component)

This method is used to set the main component of the status bar to something other than the default. Normally, this only occurs for a short period (like loading or saving a file), and then the default status bar is restored.

Parameters:

component - the new component for the status bar

setText

public void setText(java.lang.String text)

This method sets the status text on the status bar. This method does not try and resolve the resource name.

Parameters:

text - the new status text

setLocalizedText

public void setLocalizedText(java.lang.String key)

This method sets the status text on the status bar base on the resource key.

Parameters:

key - the resource key