Package weka.gui

Class ResultHistoryPanel

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    public class ResultHistoryPanel
extends 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.
    Version:
    $Revision$
    Author:
    Len Trigg (trigg@cs.waikato.ac.nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • ResultHistoryPanel

        public ResultHistoryPanel​(JTextComponent text)
        Create the result history object
        Parameters:
        text - the optional text component for single-click display

    • Method Detail

      • setDeleteListener

        public void setDeleteListener​(ResultHistoryPanel.RDeleteListener listener)
        Set a listener for deletions from the list
        Parameters:
        listener - the listener to set

      • addResult

        public void addResult​(String name,
                      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

      • removeResults

        public void removeResults​(int[] selectedI)
        Remove the entries at the specified indices in the list
        Parameters:
        selectedI - the entries to remove

      • removeResults

        public void removeResults​(List<String> entries)
        Remove the specified entries from the list
        Parameters:
        entries - the entries to remove

      • removeResult

        public void removeResult​(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.

      • clearResults

        public void clearResults()
        Removes all of the result buffers from the history. Any windows currently displaying the contents of the buffer are not affected.

      • addObject

        public void addObject​(String name,
                      Object o)
        Adds an object to the results list. If an object with the same name already exists, then a number is appended to the end of the name to make it unique.
        Parameters:
        name - the name to associate with the object
        o - the object

      • addOrOverwriteObject

        public void addOrOverwriteObject​(String name,
                                 Object o)
        Adds an object to the result list. Overwrites any exsiting object with the same name
        Parameters:
        name - the name to associate with the object
        o - the object

      • getNamedObject

        public Object getNamedObject​(String name)
        Get the named object from the list
        Parameters:
        name - the name of the item to retrieve the stored object for
        Returns:
        the object or null if there is no object at this index

      • getSelectedObject

        public 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 StringBuffer getNamedBuffer​(String name)
        Gets the named buffer
        Returns:
        the buffer or null if there are no items in the list

      • getSelectedBuffer

        public 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 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 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​(String name)
        Sets the single-click display to view the named result.
        Parameters:
        name - the name of the result to display.

      • setSelectedListValue

        public void setSelectedListValue​(String name)
        Set the selected list entry. Note, does not update the single click display to the corresponding named result - use setSingle() to set the selected list entry and view the corresponding result
        Parameters:
        name - the name of the list entry to be selected

      • openFrame

        public void openFrame​(String name)
        Opens the named result in a separate frame.
        Parameters:
        name - the name of the result to open.

      • updateResult

        public void updateResult​(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 ListSelectionModel getSelectionModel()
        Gets the selection model used by the results list.
        Returns:
        a value of type 'ListSelectionModel'

      • getList

        public 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

      • setBackground

        public void setBackground​(Color c)
        Set the background color for this component and the list
        Overrides:
        setBackground in class JComponent
        Parameters:
        c - the background color to use

      • setFont

        public void setFont​(Font f)
        Set the font to use in the list
        Overrides:
        setFont in class JComponent
        Parameters:
        f - the font to use

      • main

        public static void main​(String[] args)
        Tests out the result history from the command line.
        Parameters:
        args - ignored