no.g9.client.support

Class StatusBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

no.g9.client.support.StatusBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class StatusBar
extends JPanel

Class used for displaying messages or components. Although this class is primarily intended as a status bar (typically at the bottom of the application window), it is a JPanel, so you might find other use for it.

The status bar consists of a left and right side, which can be specified when adding components (or text) to the status bar. Components added to the left side, is oriented right-to-left, meaning that the last element added will be the left-most side of the status bar. The right side is oriented left-to-right, thus the last element added will be at the right-most side of the status bar.

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEFT Constant denoting the left side of the status bar
static int	RIGHT Constant denoting the right side of the status bar

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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() Default constructor.

Method Summary

Modifier and Type	Method and Description
Component	add(Component component) Adds a component to the left side of the status bar.
Component	add(String msg) Adds the specified text to the left side of the status bar.
Component	addComponent(Component component, int ALIGNMENT) Add a component to the status bar.The alignment must be either StatusBar.LEFT or StatusBar.RIGHT.
Component	addComponent(Component component, int ALIGNMENT, int timer, boolean bell) Adds a component to the status bar.
Component	addTextLeft(String msg) Adds a text to the left of the status bar.
Component	addTextLeft(String msg, int timer, boolean bell) Adds a text to the left side of the status bar.
Component	addTextRight(String msg) Adds a text to the right of the status bar.
Component	addTextRight(String msg, int timer, boolean bell) Adds a text to the right side of the status bar.
void	removeComponent(Component component) Removes the specified component from the status bar.
void	removeMessage(String msg) Removes the specified text message from the status bar.
void	setMessageFont(Font font) Sets the font used by the message bar when displaying text messages.

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, hide, 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, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LEFT

public static final int LEFT

Constant denoting the left side of the status bar

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Constant denoting the right side of the status bar

See Also:

Constant Field Values

Constructor Detail

StatusBar

public StatusBar()

Default constructor. Creates a new status bar.

Method Detail

add

public Component add(Component component)

Adds a component to the left side of the status bar. This has the same effect as invoking addComponent(component, StatusBar.LEFT, 0, false)

Overrides:

add in class Container

Parameters:

component - the component to add

Returns:

the added component

add

public Component add(String msg)

Adds the specified text to the left side of the status bar.

Parameters:

msg - (missing javadoc)

Returns:

the added component

addComponent

public Component addComponent(Component component,
                              int ALIGNMENT)

Add a component to the status bar.The alignment must be either StatusBar.LEFT or StatusBar.RIGHT.

Parameters:

component - the component to add

ALIGNMENT - constant specifying the alignment, either LEFT or RIGHT

Returns:

the added component

See Also:

add(Component)

addComponent

public Component addComponent(Component component,
                              int ALIGNMENT,
                              int timer,
                              boolean bell)

Adds a component to the status bar. All other add-methods are invokes this.

Parameters:

component - the component to add

ALIGNMENT - constant specifying the alignment, either LEFT or RIGHT

timer - if greater than zero, the amount in milliseconds the componet shall be on the status bar.

bell - if true the system beeps when the component is displayed

Returns:

the added component

See Also:

add(Component)

addTextLeft

public Component addTextLeft(String msg)

Adds a text to the left of the status bar.

Parameters:

msg - the text to display on the left side of the status bar.

Returns:

the added component

addTextRight

public Component addTextRight(String msg)

Adds a text to the right of the status bar.

Parameters:

msg - the text to display on the right side of the status bar.

Returns:

the added component

addTextLeft

public Component addTextLeft(String msg,
                             int timer,
                             boolean bell)

Adds a text to the left side of the status bar. If timer > 0 , the text will stay visible for timermilliseconds. If bell true the system beeps when the message is displayed.

The displayed text is displayed on a JLabel. If no font is specified (using the setFont method, the default font is used.

Parameters:

msg - the text to display on the left side of the status bar

timer - if positive, the amount of milliseconds the message will stay visible

bell - if true the system beeps when the message is displayed.

Returns:

the added component

addTextRight

public Component addTextRight(String msg,
                              int timer,
                              boolean bell)

Adds a text to the right side of the status bar. If timer > 0 , the text will stay visible for timermilliseconds. If bell true the system beeps when the message is displayed.

The displayed text is displayed on a JLabel. If no font is specified (using the setFont method, the default font is used.

Parameters:

msg - the text to display on the right side of the status bar

timer - if positive, the amount of milliseconds the message will stay visible

bell - if true the system beeps when the message is displayed.

Returns:

the added component

setMessageFont

public void setMessageFont(Font font)

Sets the font used by the message bar when displaying text messages. If the specified font is null the default look-and-feel font is used.

Parameters:

font - the Font used to display text messages.

removeComponent

public void removeComponent(Component component)

Removes the specified component from the status bar.

Parameters:

component - the component that shall be removed.

removeMessage

public void removeMessage(String msg)

Removes the specified text message from the status bar. The status bar is searched left - to - right, and the first match is removed. If no match, no action is taken.

Parameters:

msg - the text to remove.