com.levigo.util.swing.infobar
Class RollingMessagePanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.levigo.util.swing.infobar.RollingMessagePanel

All Implemented Interfaces:

MessageConsumer, MessageWidget, ImageObserver, MenuContainer, Serializable, Accessible

public class RollingMessagePanel
extends JPanel
implements MessageWidget

The fancy message panel is used to present the user with messages which can be received from various sources:

• (Qualified) Logging
• Messaging
• ...

See Also:

Serialized Form

Nested Class Summary

static class

RollingMessagePanel.OrderBy

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

Nested classes/interfaces inherited from interface com.levigo.util.swing.infobar.MessageConsumer

MessageConsumer.Message

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

RollingMessagePanel()
Creates a simple panel for showing received messages.

RollingMessagePanel(int numberOfMessagesToDisplay)
Creates a simple panel for showing received messages.

Method Summary

void	clearHistory() Clear the history of messages presented by this message widget.
static RollingMessagePanel	createForFlyout() Create a RollingMessagePanel pre-configured for use as a flyout panel.
static RollingMessagePanel	createForStatusBar() Create a RollingMessagePanel pre-configured for use in a status bar.
protected void	doShowMessage(MessageConsumer.Message message)
int	getHistoryDepth() Returns the maximum number of messages the message widget presents.
int	getHistorySize() Return the number of messages currently being presented by this message widget.
void	handleMessage(MessageConsumer.Message message) Adds a message to the message panel and shows it.
void	setHistoryDepth(int count) Sets the maximum number of messages the message widget presents.
protected void	showMessageDetails(MessageConsumer.Message m, int x, int y)

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

Constructor Detail

RollingMessagePanel

public RollingMessagePanel()

Creates a simple panel for showing received messages.

The latest message will be shown, by clicking on this panel a drop-down list appears, containing a history of by default five latest received messages.

RollingMessagePanel

public RollingMessagePanel(int numberOfMessagesToDisplay)

Creates a simple panel for showing received messages.

The latest message will be shown, by clicking on this panel a drop-down list appears, containing a history of numberOfMessagesToDisplay latest received messages:

Parameters:

numberOfMessagesToDisplay - number of stored messages

Method Detail

createForFlyout

public static RollingMessagePanel createForFlyout()

Create a RollingMessagePanel pre-configured for use as a flyout panel.

Returns:

createForStatusBar

public static RollingMessagePanel createForStatusBar()

Create a RollingMessagePanel pre-configured for use in a status bar.

Returns:

setHistoryDepth

public void setHistoryDepth(int count)

Description copied from interface: MessageWidget

Sets the maximum number of messages the message widget presents. If the number of messages is greater than the given number, the oldest message will be discarded.

Specified by:

setHistoryDepth in interface MessageWidget

Parameters:

count - an integer specifying the maximum number of messages to display

getHistoryDepth

public int getHistoryDepth()

Description copied from interface: MessageWidget

Returns the maximum number of messages the message widget presents.

Specified by:

getHistoryDepth in interface MessageWidget

Returns:

an integer specifying the maximum number of messages displayed in this widget

clearHistory

public void clearHistory()

Description copied from interface: MessageWidget

Clear the history of messages presented by this message widget.

Specified by:

clearHistory in interface MessageWidget

handleMessage

public void handleMessage(MessageConsumer.Message message)

Adds a message to the message panel and shows it. If more messages than the maximum number of messages

Specified by:

handleMessage in interface MessageConsumer

Parameters:

message -

See Also:

and, contained in the message panel, the oldest will be removed.

doShowMessage

protected void doShowMessage(MessageConsumer.Message message)

getHistorySize

public int getHistorySize()

Description copied from interface: MessageWidget

Return the number of messages currently being presented by this message widget.

Specified by:

getHistorySize in interface MessageWidget

showMessageDetails

protected void showMessageDetails(MessageConsumer.Message m,
                                  int x,
                                  int y)

Parameters:

m -