org.biojava.spice.gui.logging
Class LoggingPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.biojava.spice.gui.logging.LoggingPanel

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

public class LoggingPanel

extends JPanel

THis class is taken from the LGPL package Geotools. A panel displaying logging messages. The windows displaying Geotools's logging messages can be constructed with the following code:

 new LoggingPanel("org.biojava.spice").show(null);
 

This panel is initially set to listen to messages of level Level.CONFIG or higher. This level can be changed with getHandler().setLevel(aLevel).

Version:

$Id: LoggingPanel.java,v 1.10 2003/06/03 18:09:26 desruisseaux Exp $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Nested Class Summary

static class

LoggingPanel.Column Enumeration class for columns to be shown in a LoggingPanel.

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static LoggingPanel.Column	CLASS Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).
static LoggingPanel.Column	LEVEL Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).
static LoggingPanel.Column	LOGGER Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).
static LoggingPanel.Column	MESSAGE Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).
static LoggingPanel.Column	METHOD Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).
static LoggingPanel.Column	TIME_OF_DAY Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

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

LoggingPanel()
Constructs a new logging panel.

LoggingPanel(Logger logger)
Constructs a new logging panel and register it to the specified logger.

LoggingPanel(String logger)
Construct a logging panel and register it to the specified logger.

Method Summary

void	dispose() Free any resources used by this LoggingPanel.
void	doLayout() Layout this component.
Color	getBackground(LogRecord record) Returns the background color for the specified log record.
int	getCapacity() Returns the capacity.
Color	getForeground(LogRecord record) Returns the foreground color for the specified log record.
Handler	getHandler() Returns the logging handler.
boolean	isColumnVisible(LoggingPanel.Column column) Returns true if the given column is visible.
void	setCapacity(int capacity) Set the capacity.
void	setColumnVisible(LoggingPanel.Column column, boolean visible) Show or hide the given column.
void	setLevelColor(Level level, Color foreground, Color background) Set the foreground and background colors for messages of the specified level.
Component	show(Component owner) Convenience method showing this logging panel into a frame.

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, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, remove, removeAll, 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

Field Detail

LOGGER

public static final LoggingPanel.Column LOGGER

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

CLASS

public static final LoggingPanel.Column CLASS

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

METHOD

public static final LoggingPanel.Column METHOD

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

TIME_OF_DAY

public static final LoggingPanel.Column TIME_OF_DAY

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

LEVEL

public static final LoggingPanel.Column LEVEL

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

MESSAGE

public static final LoggingPanel.Column MESSAGE

Constant for setColumnVisible(org.biojava.spice.gui.logging.LoggingPanel.Column, boolean).

Constructor Detail

LoggingPanel

public LoggingPanel()

Constructs a new logging panel. This panel is not registered to any logger. Registration can be done with the following code:

 logger.addHandler(getHandler());
 

LoggingPanel

public LoggingPanel(Logger logger)

Constructs a new logging panel and register it to the specified logger.

Parameters:

logger - The logger to listen to, or null for the root logger.

LoggingPanel

public LoggingPanel(String logger)

Construct a logging panel and register it to the specified logger.

Parameters:

logger - The logger name to listen to, or null for the root logger.

Method Detail

getHandler

public Handler getHandler()

Returns the logging handler.

Returns:

the handler

isColumnVisible

public boolean isColumnVisible(LoggingPanel.Column column)

Returns true if the given column is visible.

Parameters:

column - The column to show or hide. May be one of LOGGER, CLASS, METHOD, TIME_OF_DAY, LEVEL or MESSAGE.

Returns:

a flag is visible

setColumnVisible

public void setColumnVisible(LoggingPanel.Column column,
                             boolean visible)

Show or hide the given column.

Parameters:

column - The column to show or hide. May be one of LOGGER, CLASS, METHOD, TIME_OF_DAY, LEVEL or MESSAGE.

visible - The visible state for the specified column.

getCapacity

public int getCapacity()

Returns the capacity. This is the maximum number of LogRecords the handler can memorize. If more messages are logged, then the earliest messages will be discarted.

Returns:

int the capacity

setCapacity

public void setCapacity(int capacity)

Set the capacity. This is the maximum number of LogRecords the handler can memorize. If more messages are logged, then the earliest messages will be discarted.

Parameters:

capacity - the max number of LogRecords that can be used

getForeground

public Color getForeground(LogRecord record)

Returns the foreground color for the specified log record. This method is invoked at rendering time for every cell in the table's "message" column. The default implementation returns a color based on the record's level, using colors set with setLevelColor(java.util.logging.Level, java.awt.Color, java.awt.Color).

Parameters:

record - The record to get the foreground color.

Returns:

The foreground color for the specified record, or null for the default color.

getBackground

public Color getBackground(LogRecord record)

Returns the background color for the specified log record. This method is invoked at rendering time for every cell in the table's "message" column. The default implementation returns a color based on the record's level, using colors set with setLevelColor(java.util.logging.Level, java.awt.Color, java.awt.Color).

Parameters:

record - The record to get the background color.

Returns:

The background color for the specified record, or null for the default color.

setLevelColor

public void setLevelColor(Level level,
                          Color foreground,
                          Color background)

Set the foreground and background colors for messages of the specified level. The specified colors will apply on any messages of level level or greater, up to the next level set with an other call to setLevelColor(...).

Parameters:

level - The minimal level to set color for.

foreground - The foreground color, or null for the default color.

background - The background color, or null for the default color.

doLayout

public void doLayout()

Layout this component. This method give all the remaining space, if any, to the last table's column. This column is usually the one with logging messages.

show

public Component show(Component owner)

Convenience method showing this logging panel into a frame. Different kinds of frame can be constructed according owner class:

• If owner or one of its parent is a JDesktopPane, then panel is added into a JInternalFrame.
• If owner or one of its parent is a Frame or a Dialog, then panel is added into a JDialog.
• Otherwise, panel is added into a JFrame.

Parameters:

owner - The owner, or null to show this logging panel in a top-level window.

Returns:

The frame. May be a JInternalFrame, a JDialog or a JFrame.

dispose

public void dispose()

Free any resources used by this LoggingPanel. If a Logger was specified at construction time, then this method unregister the LoggingPanel's handler from the specified logger. Next, Handler.close() is invoked.

This method is invoked automatically when the user close the windows created with show(Component). If this LoggingPanel is displayed by some other ways (for example if it has been added into a JPanel), then this dispose() should be invoked explicitely when the container is being discarted.