Package adams.gui.tools

Class ClassHelpPanel

    • Constructor Detail

      • ClassHelpPanel

        public ClassHelpPanel()

    • Method Detail

      • initialize

        protected void initialize()
        Initializes the listeners.
        Overrides:
        initialize in class BasePanel

      • initGUI

        protected void initGUI()
        For initializing the GUI.
        Overrides:
        initGUI in class BasePanel

      • clearHelp

        protected void clearHelp()
        Removes all text.

      • displayHelp

        protected void displayHelp​(String clsName)
        Displays the help for the specified class.
        Parameters:
        clsName - the class to display the help for

      • listAllClassNames

        public void listAllClassNames​(boolean managed)
        Updates the listed classes.
        Parameters:
        managed - whether to list only managed classes or all
        See Also:
        setListedClassNames(List)

      • setListedClassNames

        public void setListedClassNames​(String[] classes)
        Sets the class names to list.
        Parameters:
        classes - the class names

      • setListedClassNames

        public void setListedClassNames​(List<String> classes)
        Sets the class names to list.
        Parameters:
        classes - the class names

      • getListedClassNames

        public List<String> getListedClassNames()
        Returns the currently listed class names.
        Returns:
        the class names

      • setSelectedClass

        public void setSelectedClass​(String value)
        Sets the initially selected class.
        Parameters:
        value - the class to select

      • getSelectedClassName

        public String getSelectedClassName()
        Returns the currently selected class.
        Returns:
        the class, null if none selected

      • addChangeListener

        public void addChangeListener​(ChangeListener l)
        Adds the change listener to notify whenever the class changes.
        Parameters:
        l - the listener to add

      • removeChangeListener

        public void removeChangeListener​(ChangeListener l)
        Removes the change listener from notifications whenever the class changes.
        Parameters:
        l - the listener to remove

      • notifyChangeListeners

        protected void notifyChangeListeners()
        Notifies all change listeners.

      • setDoubleClickListener

        public void setDoubleClickListener​(DoubleClickListener l)
        Sets the listener for double-clicks on the classes (eg shortcut for selection).
        Parameters:
        l - the listener to use, null to remove

      • getDoubleClickListener

        public DoubleClickListener getDoubleClickListener()
        Returns the current double-click listener on classes.
        Returns:
        the listener in use, can be null

      • removeDoubleClickListener

        public void removeDoubleClickListener()
        Removes any specified double-click listener.