weka.gui
Class ResultHistoryPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--weka.gui.ResultHistoryPanel

All Implemented Interfaces:

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

public class ResultHistoryPanel

extends javax.swing.JPanel

A component that accepts named stringbuffers and displays the name in a list box. When a name is right-clicked, a frame is popped up that contains the string held by the stringbuffer. Optionally a text component may be provided that will have it's text set to the named result text on a left-click.

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

protected java.util.Hashtable	m_FramedOutput A Hashtable mapping names to output text components
protected boolean	m_HandleRightClicks Let the result history list handle right clicks in the default manner---ie, pop up a window displaying the buffer
protected javax.swing.JList	m_List The list component
protected javax.swing.DefaultListModel	m_Model The list model
protected java.util.Hashtable	m_Objs A hashtable mapping names to arbitrary objects
protected java.util.Hashtable	m_Results A Hashtable mapping names to result buffers
protected java.lang.String	m_SingleName The named result being viewed in the single-click display
protected javax.swing.text.JTextComponent	m_SingleText An optional component for single-click display

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

ResultHistoryPanel(javax.swing.text.JTextComponent text)
Create the result history object

Method Summary

void	addObject(java.lang.String name, java.lang.Object o) Adds an object to the results list
void	addResult(java.lang.String name, java.lang.StringBuffer result) Adds a new result to the result list.
javax.swing.JList	getList() Gets the JList used by the results list
java.lang.String	getNameAtIndex(int index) Gets the name of theitem in the list at the specified index
java.lang.StringBuffer	getNamedBuffer(java.lang.String name) Gets the named buffer
java.lang.Object	getNamedObject(java.lang.String name) Get the named object from the list
java.lang.StringBuffer	getSelectedBuffer() Gets the buffer associated with the currently selected item in the list.
java.lang.String	getSelectedName() Get the name of the currently selected item in the list
java.lang.Object	getSelectedObject() Gets the object associated with the currently selected item in the list.
javax.swing.ListSelectionModel	getSelectionModel() Gets the selection model used by the results list.
static void	main(java.lang.String[] args) Tests out the result history from the command line.
void	openFrame(java.lang.String name) Opens the named result in a separate frame.
void	removeResult(java.lang.String name) Removes one of the result buffers from the history.
void	setHandleRightClicks(boolean tf) Set whether the result history list should handle right clicks or whether the parent object will handle them.
void	setSingle(java.lang.String name) Sets the single-click display to view the named result.
void	updateResult(java.lang.String name) Tells any component currently displaying the named result that the contents of the result text in the StringBuffer have been updated.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, paramString, 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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_SingleText

protected javax.swing.text.JTextComponent m_SingleText

An optional component for single-click display

m_SingleName

protected java.lang.String m_SingleName

The named result being viewed in the single-click display

m_Model

protected javax.swing.DefaultListModel m_Model

The list model

m_List

protected javax.swing.JList m_List

The list component

m_Results

protected java.util.Hashtable m_Results

A Hashtable mapping names to result buffers

m_FramedOutput

protected java.util.Hashtable m_FramedOutput

A Hashtable mapping names to output text components

m_Objs

protected java.util.Hashtable m_Objs

A hashtable mapping names to arbitrary objects

m_HandleRightClicks

protected boolean m_HandleRightClicks

Let the result history list handle right clicks in the default manner---ie, pop up a window displaying the buffer

Constructor Detail

ResultHistoryPanel

public ResultHistoryPanel(javax.swing.text.JTextComponent text)

Create the result history object

Parameters:

text - the optional text component for single-click display

Method Detail

addResult

public void addResult(java.lang.String name,
                      java.lang.StringBuffer result)

Adds a new result to the result list.

Parameters:

name - the name to associate with the result

result - the StringBuffer that contains the result text

removeResult

public void removeResult(java.lang.String name)

Removes one of the result buffers from the history. Any windows currently displaying the contents of the buffer are not affected.

Parameters:

name - the name of the buffer to remove.

addObject

public void addObject(java.lang.String name,
                      java.lang.Object o)

Adds an object to the results list

Parameters:

name - the name to associate with the object

o - the object

getNamedObject

public java.lang.Object getNamedObject(java.lang.String name)

Get the named object from the list

Parameters:

index - the index of the item to retrieve the stored object for

Returns:

the object or null if there is no object at this index

getSelectedObject

public java.lang.Object getSelectedObject()

Gets the object associated with the currently selected item in the list.

Returns:

the object or null if there is no object corresponding to the current selection in the list

getNamedBuffer

public java.lang.StringBuffer getNamedBuffer(java.lang.String name)

Gets the named buffer

Returns:

the buffer or null if there are no items in the list

getSelectedBuffer

public java.lang.StringBuffer getSelectedBuffer()

Gets the buffer associated with the currently selected item in the list.

Returns:

the buffer or null if there are no items in the list

getSelectedName

public java.lang.String getSelectedName()

Get the name of the currently selected item in the list

Returns:

the name of the currently selected item or null if no item selected

getNameAtIndex

public java.lang.String getNameAtIndex(int index)

Gets the name of theitem in the list at the specified index

Returns:

the name of item or null if there is no item at that index

setSingle

public void setSingle(java.lang.String name)

Sets the single-click display to view the named result.

Parameters:

name - the name of the result to display.

openFrame

public void openFrame(java.lang.String name)

Opens the named result in a separate frame.

Parameters:

name - the name of the result to open.

updateResult

public void updateResult(java.lang.String name)

Tells any component currently displaying the named result that the contents of the result text in the StringBuffer have been updated.

Parameters:

name - the name of the result that has been updated.

getSelectionModel

public javax.swing.ListSelectionModel getSelectionModel()

Gets the selection model used by the results list.

Returns:

a value of type 'ListSelectionModel'

getList

public javax.swing.JList getList()

Gets the JList used by the results list

Returns:

the JList

setHandleRightClicks

public void setHandleRightClicks(boolean tf)

Set whether the result history list should handle right clicks or whether the parent object will handle them.

Parameters:

tf - false if parent object will handle right clicks

main

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

Tests out the result history from the command line.

Parameters:

args - ignored