de.esprit.common.log

Class LogConsole

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

de.esprit.common.gui.ZTextArea

de.esprit.common.gui.comp.MessageConsole

de.esprit.common.log.LogConsole

All Implemented Interfaces:

TextConsole, LogLevelEvent.Source, LogPrinter, Clearable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, javax.accessibility.Accessible, javax.swing.Scrollable

public class LogConsole
extends MessageConsole
implements LogPrinter

This is a TextArea used as a console for messages. It has a limited message stack in order to limit the consumption of memory. Note that this console contains an inner LogMessageEvent.Listener in order to receive messages from a LogChannel.

Author:

Rainer Buesch

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JTextArea

javax.swing.JTextArea.AccessibleJTextArea

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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 inherited from class de.esprit.common.gui.comp.MessageConsole

DEFAULT_STACK_SIZE

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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
LogConsole(LogChannel logCh, int rows, int cols)
LogConsole(LogChannel logCh, int rows, int cols, int stackSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogLevelListener(LogLevelEvent.Listener l)
void	close() Deregisters the LogPrinter from the underlying LogChannel and releases all associated resources.
LogChannel	getLogChannel() Returns the underlying LogChannel from where the messages are received.
LogFormatter	getLogFormatter() Returns the formatter for formatting the logMessage
LogLevel	getLogLevel() Returns the current log level in use.
LogMessageEvent.Listener	getLogMessageListener()
TextConsole	getOutput(LogLevel currLevel) Returns a TextConsole where the message is printed to.
java.lang.String	getTypeString() Returns a string identifying the type of this LogPrinter.
void	removeLogLevelListener(LogLevelEvent.Listener l)
void	setLogLevel(LogLevel level) Defines the 'importance level' as defined in LogLevel.
void	setSilent(boolean isSilent) Sets the MessageConsole into silent mode, where it does not receive any messages.

Methods inherited from class de.esprit.common.gui.comp.MessageConsole

addMessage, append, clear, getBgColor, getFgColor, isSilent, println, println, setBackground, setBufferSize, setForeground, setText

Methods inherited from class de.esprit.common.gui.ZTextArea

addDocumentListener, getActionClear, isEmpty, removeDocumentListener, setDropEnabled

Methods inherited from class javax.swing.JTextArea

createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, paramString, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, 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, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

Methods inherited from interface de.esprit.common.log.LogPrinter

isSilent

Constructor Detail

LogConsole

public LogConsole(LogChannel logCh,
          int rows,
          int cols)

LogConsole

public LogConsole(LogChannel logCh,
          int rows,
          int cols,
          int stackSize)

Method Detail

getLogFormatter

public LogFormatter getLogFormatter()

Description copied from interface: LogPrinter

Returns the formatter for formatting the logMessage

Specified by:

getLogFormatter in interface LogPrinter

setSilent

public void setSilent(boolean isSilent)

Sets the MessageConsole into silent mode, where it does not receive any messages. This mode is visualized by a 'locked' background and foreground color.

Specified by:

setSilent in interface LogPrinter

Overrides:

setSilent in class MessageConsole

close

public void close()

Description copied from interface: LogPrinter

Deregisters the LogPrinter from the underlying LogChannel and releases all associated resources.

Specified by:

close in interface LogPrinter

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getLogChannel

public LogChannel getLogChannel()

Description copied from interface: LogPrinter

Returns the underlying LogChannel from where the messages are received.

Specified by:

getLogChannel in interface LogPrinter

getLogLevel

public LogLevel getLogLevel()

Description copied from interface: LogPrinter

Returns the current log level in use. If null, then the LogLevel of the parent LogChannel is used

Specified by:

getLogLevel in interface LogPrinter

setLogLevel

public void setLogLevel(LogLevel level)

Description copied from interface: LogPrinter

Defines the 'importance level' as defined in LogLevel.

Specified by:

setLogLevel in interface LogPrinter

getOutput

public TextConsole getOutput(LogLevel currLevel)

Description copied from interface: LogPrinter

Returns a TextConsole where the message is printed to. The output may be different for different LogLevels.

Specified by:

getOutput in interface LogPrinter

getTypeString

public java.lang.String getTypeString()

Description copied from interface: LogPrinter

Returns a string identifying the type of this LogPrinter.

Specified by:

getTypeString in interface LogPrinter

addLogLevelListener

public void addLogLevelListener(LogLevelEvent.Listener l)

Specified by:

addLogLevelListener in interface LogLevelEvent.Source

removeLogLevelListener

public void removeLogLevelListener(LogLevelEvent.Listener l)

Specified by:

removeLogLevelListener in interface LogLevelEvent.Source

getLogMessageListener

public LogMessageEvent.Listener getLogMessageListener()