weka.gui

Class LogPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

weka.gui.LogPanel

All Implemented Interfaces:

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

public class LogPanel
extends javax.swing.JPanel
implements Logger, TaskLogger

This panel allows log and status messages to be posted. Log messages appear in a scrollable text area, and status messages appear as one-line transient messages.

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
protected boolean	m_First An indicator for whether text has been output yet
protected javax.swing.JButton	m_logButton The button for viewing the log
protected javax.swing.JTextArea	m_LogText Displays the log messages
protected javax.swing.JLabel	m_StatusLab Displays the current status
protected WekaTaskMonitor	m_TaskMonitor The panel for monitoring the number of running tasks (if supplied)

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
LogPanel() Creates the log panel with no task monitor and the log always visible.
LogPanel(WekaTaskMonitor tm) Creates the log panel with a task monitor, where the log is hidden.
LogPanel(WekaTaskMonitor tm, boolean logHidden) Creates the log panel, possibly with task monitor, where the log is optionally hidden.
LogPanel(WekaTaskMonitor tm, boolean logHidden, boolean statusHidden, boolean titledBorder) Creates the log panel, possibly with task monitor, where the either the log is optionally hidden or the status (having both hidden is not allowed).

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getTimestamp() Gets a string containing current date and time.
void	logMessage(java.lang.String message) Sends the supplied message to the log area.
static void	main(java.lang.String[] args) Tests out the log panel from the command line.
void	setLoggingFontSize(int size) Set the size of the font used in the log message area. <= 0 will use the default for JTextArea.
void	statusMessage(java.lang.String message) Sends the supplied message to the status line.
void	taskFinished() Record a task ending
void	taskStarted() Record the starting of a new task

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, 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

m_StatusLab

protected javax.swing.JLabel m_StatusLab

Displays the current status

m_LogText

protected javax.swing.JTextArea m_LogText

Displays the log messages

m_logButton

protected javax.swing.JButton m_logButton

The button for viewing the log

m_First

protected boolean m_First

An indicator for whether text has been output yet

m_TaskMonitor

protected WekaTaskMonitor m_TaskMonitor

The panel for monitoring the number of running tasks (if supplied)

Constructor Detail

LogPanel

public LogPanel()

Creates the log panel with no task monitor and the log always visible.

LogPanel

public LogPanel(WekaTaskMonitor tm)

Creates the log panel with a task monitor, where the log is hidden.

Parameters:

tm - the task monitor, or null for none

LogPanel

public LogPanel(WekaTaskMonitor tm,
                boolean logHidden)

Creates the log panel, possibly with task monitor, where the log is optionally hidden.

Parameters:

tm - the task monitor, or null for none

logHidden - true if the log should be hidden and acessible via a button, or false if the log should always be visible.

LogPanel

public LogPanel(WekaTaskMonitor tm,
                boolean logHidden,
                boolean statusHidden,
                boolean titledBorder)

Creates the log panel, possibly with task monitor, where the either the log is optionally hidden or the status (having both hidden is not allowed).

Parameters:

tm - the task monitor, or null for none

logHidden - true if the log should be hidden and acessible via a button, or false if the log should always be visible.

statusHidden - true if the status bar should be hidden (i.e.

titledBorder - true if the log should have a title you only want the log part).

Method Detail

setLoggingFontSize

public void setLoggingFontSize(int size)

Set the size of the font used in the log message area. <= 0 will use the default for JTextArea.

Parameters:

size - the size of the font to use in the log message area

taskStarted

public void taskStarted()

Record the starting of a new task

Specified by:

taskStarted in interface TaskLogger

taskFinished

public void taskFinished()

Record a task ending

Specified by:

taskFinished in interface TaskLogger

getTimestamp

protected static java.lang.String getTimestamp()

Gets a string containing current date and time.

Returns:

a string containing the date and time.

logMessage

public void logMessage(java.lang.String message)

Sends the supplied message to the log area. The current timestamp will be prepended.

Specified by:

logMessage in interface Logger

Parameters:

message - a value of type 'String'

statusMessage

public void statusMessage(java.lang.String message)

Sends the supplied message to the status line.

Specified by:

statusMessage in interface Logger

Parameters:

message - the status message

main

public static void main(java.lang.String[] args)

Tests out the log panel from the command line.

Parameters:

args - ignored