Package adams.gui.goe

Class RatReferenceEditor

  • All Implemented Interfaces:
    adams.core.HelpProvider, adams.gui.goe.CustomStringRepresentationHandler, PropertyEditor

    public class RatReferenceEditor
    extends adams.gui.goe.AbstractPropertyEditorSupport
    implements adams.gui.goe.CustomStringRepresentationHandler
    A PropertyEditor for RatReference objects.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    • Field Detail

      • m_TextValue

        protected adams.gui.core.BaseTextField m_TextValue
        The text field with the value.
      • m_Tree

        protected RatsTree m_Tree
        The tree displaying all the callable actors.
    • Constructor Detail

      • RatReferenceEditor

        public RatReferenceEditor()
    • Method Detail

      • toCustomStringRepresentation

        public String toCustomStringRepresentation​(Object obj)
        Returns a custom string representation of the object.
        Specified by:
        toCustomStringRepresentation in interface adams.gui.goe.CustomStringRepresentationHandler
        Parameters:
        obj - the object to turn into a string
        Returns:
        the string representation
      • fromCustomStringRepresentation

        public Object fromCustomStringRepresentation​(String str)
        Returns an object created from the custom string representation.
        Specified by:
        fromCustomStringRepresentation in interface adams.gui.goe.CustomStringRepresentationHandler
        Parameters:
        str - the string to turn into an object
        Returns:
        the object
      • parse

        protected RatReference parse​(String s)
        Parses the given string and returns the generated object. The string has to be a valid one, i.e., the isValid(String) check has been performed already and succeeded.
        Parameters:
        s - the string to parse
        Returns:
        the generated object, or null in case of an error
      • updateValue

        protected boolean updateValue​(TreePath path)
        Updates the value of the text field if possble, using the last component on the given tree path.
        Parameters:
        path - the path to use for updating the value
        Returns:
        true if the text field got updated
      • createCustomEditor

        protected JComponent createCustomEditor()
        Gets the custom editor component.
        Specified by:
        createCustomEditor in class adams.gui.goe.AbstractPropertyEditorSupport
        Returns:
        the editor
      • isValid

        protected boolean isValid​(String s)
        Checks whether the string is valid.
        Parameters:
        s - the string to check
        Returns:
        true if the string is valid
      • isUnchanged

        protected boolean isUnchanged​(String s)
        Checks whether the string is the same as the currently used one.
        Parameters:
        s - the string to check
        Returns:
        true if the strings are the same
      • acceptInput

        protected void acceptInput()
        Accepts the input and closes the dialog.
      • discardInput

        protected void discardInput()
        Discards the input and closes the dialog.
      • findRats

        protected List<String> findRats()
        Locates all the callable actors for the node.
        Returns:
        the located callable actors (including Rats nodes)
      • initForDisplay

        protected void initForDisplay()
        Initializes the display of the value.
        Overrides:
        initForDisplay in class adams.gui.goe.AbstractPropertyEditorSupport