com.lf.commons.gui

Class StatusBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.gui.StatusBar

All Implemented Interfaces:

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

public class StatusBar
extends javax.swing.JPanel
implements ConfigurableUnit

GUI component for main application windows providing support for progress, message etc.

To the left of the memory controller there is space for a number of multipurpose buttons like an update icon, a message icon, an online icon or stuff like that. This is also application specific. At the very left side of the bar the message and an optional icon is displayed, which can be used to mark a message to be important.

In addition to that the status bar provides a machanism to run application specific update tasks like updating the task docking window. Applications can add such runnable tasks which are then automatically executed by the status bar update thread. While the update thread has a smaller timeout the external tasks are executed at about once per second.

Since:

1.6

Version:

$Revision: 1.30 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

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

Fields

Modifier and Type	Field and Description
static int	BUTTON_ALWAYS The clipboard button is always on the screen.
static int	BUTTON_AUTO The clipboard button is shown when the clipboard is loaded.
static int	BUTTON_NEVER The clipboard button is disabled.
static java.net.URL	ICON_CLIPBOARD_EMPTY Icon representing an empty clipboard.
static java.net.URL	ICON_CLIPBOARD_LOADED Icon representing a loaded clipboard.

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
StatusBar() Constructor for the GUI component.

Method Summary

Methods

Modifier and Type	Method and Description
void	addButton(javax.swing.JButton button) Adds a new custom button between message area and memory controller.
void	addMouseListener(java.awt.event.MouseListener listener) Adds a mouse listener for the status bar (no buttons.
void	addTask(java.lang.Runnable task) Adds a new task executed periodically by the updater thread.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
protected void	finalize() Help the garbage collector.
int	getMCThreshold() Gets the current visiblity threshold for the memory controller.
MemoryController	getMemoryController() Getter for memory controller.
MessageLabel	getMessageLabel() Provides the message label.
java.lang.String	getMessageText() Provides the message text currently displayed.
int	getPriority() Gets the priority for the update task.
boolean	getShowBevelBorders() Are the bevel borders visible or not.
java.util.Vector<java.lang.Runnable>	getTasks() Provides the tasks currently being executed by this status bar.
java.text.DateFormat	getTimeFormat() Gets the time format.
javax.swing.JLabel	getTimeLabel() Provides the time label for adding listeners etc.
java.text.DateFormat	getTimeToolTipFormat() Gets the time tooltip format.
boolean	isTimeVisible() Is the time component visible or not.
void	removeButton(javax.swing.JButton button) Removes the custom button.
void	removeTask(java.lang.Runnable task) Removes the custom button.
void	setMCThreshold(int threshold) Sets visiblity threshold for the memory controller.
void	setMessage(StatusBarMessage message) Sets a new message with optional icon and duration.
void	setMessageText(java.lang.String text) Simplest method to display a certain text message without icon.
void	setMessageText(java.lang.String text, javax.swing.ImageIcon icon) Displays a text message together with a special icon.
void	setMessageText(java.lang.String text, javax.swing.ImageIcon icon, int millis) Displays an icon-supported text message for a certain period of time in milliseconds.
void	setMessageText(java.lang.String text, int millis) Displays an icon-less text message for a certain period of time in milliseconds.
void	setMessageText(java.lang.String text, java.net.URL icon) Displays a text message together with a special icon.
void	setMessageText(java.lang.String text, java.net.URL icon, int millis) Displays an icon-supported text message for a certain period of time in milliseconds.
void	setPriority(int priority) Sets the priority for the update task.
void	setShowBevelBorders(boolean show) Sets the bevel borders visible or not.
void	setTimeFormat(java.lang.String format) Sets the time format.
void	setTimeToolTipFormat(java.lang.String format) Sets the time tooltip format.
void	setTimeVisible(boolean visible) Sets the time component visible or not.
void	setupClipboardButton(int mode) Enable/disable the default clipboard button.
void	startThread() Starts the update thread based on the current configuration.
void	stopThread() Call this method if you like the update thread be terminated properly.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

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, isPaintingOrigin, 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, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ICON_CLIPBOARD_EMPTY

public static final java.net.URL ICON_CLIPBOARD_EMPTY

Icon representing an empty clipboard.

ICON_CLIPBOARD_LOADED

public static final java.net.URL ICON_CLIPBOARD_LOADED

Icon representing a loaded clipboard.

BUTTON_NEVER

public static final int BUTTON_NEVER

The clipboard button is disabled.

See Also:

Constant Field Values

BUTTON_ALWAYS

public static final int BUTTON_ALWAYS

The clipboard button is always on the screen.

See Also:

Constant Field Values

BUTTON_AUTO

public static final int BUTTON_AUTO

The clipboard button is shown when the clipboard is loaded.

See Also:

Constant Field Values

Constructor Detail

StatusBar

public StatusBar()

Constructor for the GUI component.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Help the garbage collector.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

setMessageText

public void setMessageText(java.lang.String text)

Simplest method to display a certain text message without icon.

Parameters:

text - Single line of text, cleared if null or empty

setMessageText

public void setMessageText(java.lang.String text,
                  int millis)

Displays an icon-less text message for a certain period of time in milliseconds.

Parameters:

text - Single line of text, cleared if null or empty

millis - Period of time to display the message

setMessageText

public void setMessageText(java.lang.String text,
                  javax.swing.ImageIcon icon,
                  int millis)

Displays an icon-supported text message for a certain period of time in milliseconds.

Parameters:

text - Single line of text, cleared if null or empty

icon - Symbol to be displayed

millis - Time in milliseconds

setMessageText

public void setMessageText(java.lang.String text,
                  java.net.URL icon,
                  int millis)

Displays an icon-supported text message for a certain period of time in milliseconds.

Parameters:

text - Single line of text, cleared if null or empty

icon - Symbol to be displayed

millis - Time in milliseconds

setMessageText

public void setMessageText(java.lang.String text,
                  javax.swing.ImageIcon icon)

Displays a text message together with a special icon.

The text may be HTML code and is also displayed as tooltip for the case that the message doesn't fit on the message label.

Parameters:

text - Single line of text, cleared if null or empty

icon - Image to be displayed (e.g. ICON_INFO), may be null

setMessageText

public void setMessageText(java.lang.String text,
                  java.net.URL icon)

Displays a text message together with a special icon.

The text may be HTML code and is also displayed as tooltip for the case that the message doesn't fit on the message label. This is a convenience method which you can pass the public class members ICON_INFO, ...

Parameters:

text - Single line of text, cleared if null or empty

icon - URL address of image to be displayed, may be null

setMessage

public void setMessage(StatusBarMessage message)

Sets a new message with optional icon and duration.

Parameters:

message - Message encapsulation instance

getMessageText

public java.lang.String getMessageText()

Provides the message text currently displayed.

Returns:

Current message text

addButton

public void addButton(javax.swing.JButton button)

Adds a new custom button between message area and memory controller.

New buttons will be resized fitting with the recycle button of the memory controller in order to have a nice look of the panel.

Parameters:

button - New custom button, appears at the most left position

Throws:

java.lang.NullPointerException - If the button is null

removeButton

public void removeButton(javax.swing.JButton button)

Removes the custom button.

Parameters:

button - Custom button to be removed

Throws:

java.lang.NullPointerException - If the button is null

setPriority

public void setPriority(int priority)

Sets the priority for the update task.

Parameters:

priority - Thread priority

Since:

1.5

getPriority

public int getPriority()

Gets the priority for the update task.

Returns:

Thread priority

Since:

1.5

getMemoryController

public MemoryController getMemoryController()

Getter for memory controller.

Returns:

Memory controller

Since:

1.6

startThread

public void startThread()

Starts the update thread based on the current configuration.

Since:

1.5

stopThread

public void stopThread()

Call this method if you like the update thread be terminated properly.

Since:

1.5

setTimeVisible

public void setTimeVisible(boolean visible)

Sets the time component visible or not.

Parameters:

visible - Shall the time be displayed?

Since:

1.5

isTimeVisible

public boolean isTimeVisible()

Is the time component visible or not.

Returns:

Is the time currently displayed?

Since:

1.5

setTimeFormat

public void setTimeFormat(java.lang.String format)

Sets the time format.

Parameters:

format - The new time format to use, default is "HH:mm:ss"

Throws:

java.lang.NullPointerException - If the format is null

java.lang.IllegalArgumentException - If the format is invalid

Since:

1.5

getTimeFormat

public java.text.DateFormat getTimeFormat()

Gets the time format.

Returns:

Current time format

Since:

1.5

setTimeToolTipFormat

public void setTimeToolTipFormat(java.lang.String format)

Sets the time tooltip format.

Parameters:

format - The new time format to use, default is "EEEEE, d. MMMMM yyyy"

Throws:

java.lang.NullPointerException - If the format is null

java.lang.IllegalArgumentException - If the format is invalid

Since:

1.5

getTimeToolTipFormat

public java.text.DateFormat getTimeToolTipFormat()

Gets the time tooltip format.

Returns:

Current time tooltip format

Since:

1.5

setMCThreshold

public void setMCThreshold(int threshold)

Sets visiblity threshold for the memory controller.

Parameters:

threshold - The new visibility threshold in the range from 0 to 100 percent

Throws:

java.lang.IllegalArgumentException - If the threshold is invalid

Since:

1.5

getMCThreshold

public int getMCThreshold()

Gets the current visiblity threshold for the memory controller.

Returns:

The current visibility threshold in the range from 0 to 100 percent

Since:

1.5

setupClipboardButton

public void setupClipboardButton(int mode)

Enable/disable the default clipboard button.

Parameters:

mode - BUTTON_NEVER | ...

Since:

1.5

addTask

public void addTask(java.lang.Runnable task)

Adds a new task executed periodically by the updater thread.

By default the task is run four times a second (timeout 250 milliseconds).

Parameters:

task - New task to be executed periodically

Throws:

java.lang.NullPointerException - If the task is null

removeTask

public void removeTask(java.lang.Runnable task)

Removes the custom button.

Parameters:

task - Task to be removed

Throws:

java.lang.NullPointerException - If the task is null

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)

Adds a mouse listener for the status bar (no buttons.

Overrides:

addMouseListener in class java.awt.Component

Parameters:

listener - Listener for the component

getTimeLabel

public javax.swing.JLabel getTimeLabel()

Provides the time label for adding listeners etc.

Returns:

Time label

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setShowBevelBorders

public void setShowBevelBorders(boolean show)

Sets the bevel borders visible or not.

Bevel border look nice for application main windows but may be too fat for dialogs.

Parameters:

show - Shall bevel borders be displayed?

Since:

1.6

getShowBevelBorders

public boolean getShowBevelBorders()

Are the bevel borders visible or not.

Returns:

Bevel borders currently displayed?

Since:

1.6

getTasks

public java.util.Vector<java.lang.Runnable> getTasks()

Provides the tasks currently being executed by this status bar.

Returns:

Cotainer with tasks, may be empty

Since:

1.6

getMessageLabel

public MessageLabel getMessageLabel()

Provides the message label.

Returns:

The label