Class StringTree

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

    public class StringTree
    extends AbstractGraphicalDisplay
    Generates a tree from the strings arriving at the input, splitting them into parts using the specified separator. This can be used to display files from various directories in a hierarchical view.

    - accepts:

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -name <java.lang.String> (property: name)
        The name of the actor.
        default: StringTree
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -skip <boolean> (property: skip)
        If set to true, transformation is skipped and the input token is just forwarded 
        as it is.
        default: false
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
        If set to true, the flow gets stopped in case this actor encounters an error;
         useful for critical actors.
        default: false
    -short-title <boolean> (property: shortTitle)
        If enabled uses just the name for the title instead of the actor's full 
        default: false
    -width <int> (property: width)
        The width of the dialog.
        default: 800
        minimum: -1
    -height <int> (property: height)
        The height of the dialog.
        default: 600
        minimum: -1
    -x <int> (property: x)
        The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
        default: -1
        minimum: -3
    -y <int> (property: y)
        The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
        default: -1
        minimum: -3
    -writer <adams.gui.print.JComponentWriter> (property: writer)
        The writer to use for generating the graphics output.
        default: adams.gui.print.NullWriter
    -separator <java.lang.String> (property: separator)
        The separator to use for splitting the strings into parts.
        default: .
    -sorted <boolean> (property: sorted)
        Whether to sort the entries in the tree.
        default: false
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Separator

        protected String m_Separator
        the separator to use.
      • m_Sorted

        protected boolean m_Sorted
        whether to sort the items in the tree.
    • Constructor Detail

      • StringTree

        public StringTree()
    • Method Detail

      • setSeparator

        public void setSeparator​(String value)
        Sets name of the content.
        value - the content name
      • getSeparator

        public String getSeparator()
        Returns the name of the content.
        the content name
      • separatorTipText

        public String separatorTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setSorted

        public void setSorted​(boolean value)
        Sets whether to sort the entries in the tree.
        value - true if sorted
      • getSorted

        public boolean getSorted()
        Returns whether to store the entries in the tree.
        true if sorted
      • sortedTipText

        public String sortedTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        the Class of objects that can be processed
      • display

        protected void display​(Token token)
        Displays the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class AbstractDisplay
        token - the token to display