The Yoix^® Scripting Language

• ADD_CHILD indicates that the JTreeNode provided as arg1 is to be added to the tree as a child of the JTreeNode provided as arg2. The child is added last among its siblings, if any. The added node is returned.
• ADD_SIBLING_ABOVE indicates that the JTreeNode provided as arg1 is to be added to the tree as a sibling of the JTreeNode provided as arg2. The sibling is added above, namely before, the given sibling. The added node is returned.
• ADD_SIBLING_BELOW indicates that the JTreeNode provided as arg1 is to be added to the tree as a sibling of the JTreeNode provided as arg2. The sibling is added below, namely after, the given sibling. The added node is returned.
• BREADTH_FIRST returns an Array of nodes resulting from a breadth first traversal of the tree starting at and including the JTreeNode provided as arg1.
• COLLAPSE_NODE updates the JTree display, as appropriate, so that the JTreeNode provided as arg1 is collapsed, namely its descendants are no longer displayed and its icon and handle is updated appropriately.
• DELETE_NODE removes the JTreeNode provided as arg1 and all of its descendants, if any, from this tree.
• DEPTH_FIRST returns an Array of nodes resulting from a depth first traversal of the tree starting at and including the JTreeNode provided as arg1.
• DESELECT_INTERVAL causes all nodes inclusive to the range of rows starting at the int provided as arg1 and ending at the int provided as arg2 to be deselected.
• DESELECT_NODE deselects the JTreeNode provided as arg1.
• DESELECT_NODES deselects the Array of nodes provided as arg1.
• EDIT_CANCEL cancels the current interactive node label editing session. Any changes made in the session are discarded. An editing session is started in one of three ways: by means of the action associated with the EDIT_START flag, by triple-clicking on a node displayed in the tree or by clicking on the text of an already selected node displayed in the tree.
• EDIT_START starts an interactive node label editing session on the JTreeNode provided as arg1.
• EDIT_STOP stops the current interactive node label editing session. Any changes made in the session are accepted. An editing session is started in one of three ways: by means of the action associated with the EDIT_START flag, by triple-clicking on a node displayed in the tree or by clicking on the text of an already selected node displayed in the tree.
• ELEMENT_COUNT returns a count of the nodes that descend from the supplied node including supplied node. If no JTreeNode argument is supplied or it is NULL, then a count of all nodes in the current tree is returned.
• EXPAND_ALL updates the JTree display, as appropriate, so that all the nodes that have children are expanded, namely all descendants are displayed. Icons and handles are updated appropriately.
• EXPAND_NODE updates the JTree display, as appropriate, so that the JTreeNode provided as arg1 is expanded, namely its descendants are displayed and its icon and handle is updated appropriately.
• GET_EXPANDED_NODES returns a growable Array of nodes currently expanded in the tree.
• GET_NODE_FOR_ROW returns the JTreeNode associated with the currently displayed row of the tree indicated by the int supplied as arg1.
• GET_PARENT returns the JTreeNode that is the parent of the JTreeNode provided as arg1.
• GET_ROW_COUNT returns an int indicating, for this tree, the number of rows currently displayed.
• GET_ROW_FOR_NODE returns an int corresponding to the displayed row containing the JTreeNode provided as arg1. Row numbering starts at zero. The value -1 is returned when the supplied node is not displayed.
• GET_SELECTED_NODES returns a growable Array of nodes currently selected in the tree.
• GET_SELECTED_COUNT returns an int giving a count of nodes currently selected in the tree.
• GET_SIBLING_ABOVE returns a JTreeNode that is the sibling within the tree which is above, namely before, the JTreeNode provided as arg1. If there is no such sibling, a NULL is returned.
• GET_SIBLING_BELOW returns a JTreeNode that is the sibling within the tree which is below, namely after, the JTreeNode provided as arg1. If there is no such sibling, a NULL is returned.
• MAKE_NODE_VISIBLE causes the display of the tree to be expanded so that the JTreeNode provided as arg1 is made visible, namely all its ancestors are expanded. Moreover, if possible, the node will be scrolled into the display area.
• NEW_FOR_OLD replaces the JTreeNode provided as arg2 with the JTreeNode provided as arg1. All descendants of these nodes are also removed or installed, as appropriate.
• NODE_HAS_BEEN_EXPANDED returns a non-zero int if the JTreeNode provided as arg1 has ever been expanded.
• NODE_IS_EXPANDED returns a non-zero int if the JTreeNode provided as arg1 is currently expanded. A zero value is always returned for the case of a leaf node.
• NODE_IS_SELECTED returns a non-zero int if the JTreeNode provided as arg1 is currently selected.
• NODE_IS_VISIBLE returns a non-zero int if the JTreeNode provided as arg1 is currently visible.
• SCROLL_NODE scrolls the JTreeNode provided as arg1 into the display area, if scrolling is possible.
• SCROLL_ROW scrolls the row provided as arg1 into the display area, if scrolling is possible.
• SELECT_ALL causes all nodes in the tree to be visible and selected.
• SELECT_ALL_VISIBLE causes all nodes in the tree that are currently visible to be selected.
• SELECT_INTERVAL causes all nodes inclusive to the range of rows starting at the int provided as arg1 and ending at the int provided as arg2 to be selected.
• SELECT_NODE selects the JTreeNode provided as arg1 and, if possible, scrolls to move the selected node into the display area.
• SELECT_NODES selects the Array of nodes provided as arg1.
• SELECT_NONE deselects all nodes.
• SELECT_TOGGLE toggles the selection state of the JTreeNode provided as arg1. Namely, an unselected node will become selected and a selected node will become unselected.
• TAGGED_COPY returns a copy of the JTreeNode provided as arg1 and all of its descendants, if any, but leaves them unaffiliated with a particular tree, namely the root field is NULL, and the children and tag fields are writeable. The tag field is forced to NULL.
• UNTAGGED_COPY returns a copy of the JTreeNode provided as arg1 and all of its descendants, if any, but leaves them unaffiliated with a particular tree, namely the root field is NULL, and the children and tag fields are writeable. The tag field is the same as the corresponding original node.
• UPDATE_TREE uses the fields in the JTreeNode provided as arg1, except the children field, to update the node in the tree that has the matching tag value.
• UPDATE_COPY returns a copy of the JTreeNode provided as arg1, but includes none of its descendants, if any. The returned node is unaffiliated with a particular tree, namely the root field is NULL. The tag field is the same as the corresponding original node. The children field is forced to NULL. This sort of copy is useful in conjunction with the UPDATE_TREE action described above since the children field is ignored by that action.

Reading returns the current cursor. Writing immediately changes the tree's cursor to the new value. Storing STANDARD_CURSOR (the default) or NULL in cursor is special and means use the cursor assigned to the nearest component that contains the tree and was assigned a cursor other than STANDARD_CURSOR; if no component qualifies the tree uses DEFAULT_CURSOR.

Swing components that provide automatic drag handling start out with a transferhandler field that is not NULL, but the automatic drag handling is not enabled until 1 is stored in dragenabled. Swing components that provide their own drag and drop event handlers currently must store NULL in transferhandler before those event handlers will start working.

import yoix.*.*;

JTree original = {
 JTreeNode top = {
  String text = "The C Programming Language";
  String tooltiptext =
   "by Brian W. Kernighan and Dennis M. Ritchie";
  Array children = {
   new JTreeNode {
    String text = "Introduction";
    String tooltiptext = "Chapter 0";
    String font = "TimesRoman-bold-14";
   },
   new JTreeNode {
    String text = "A Tutorial Introduction";
    String tooltiptext = "Chapter 1";
    Array children = {
     new JTreeNode {
      String text = "Getting Started";
      String tooltiptext = "Section 1.1";
     },
     new JTreeNode {
      String text = "Variables and Arithmetic";
      String tooltiptext = "Section 1.2";
     },
    };
   },
   new JTreeNode {
    String text = "Types, Operators and Expressions";
    String tooltiptext = "Chapter 2";
    Image openicon = null;
    Array children = {
     new JTreeNode {
      String text = "Variable Names";
      String tooltiptext = "Section 2.1";
     },
     new JTreeNode {
      String text = "Data Types and Sizes";
      String tooltiptext = "Section 2.2";
      Array children = {
       new JTreeNode {
        String text = "Variable Names";
        String tooltiptext = "Section 2.1";
       },
       new JTreeNode {
        String text = "Data Types and Sizes";
        String tooltiptext = "Section 2.2";
       },
      };
     },
    };
   },
  };
 };
};

JTreeNode copy = original.action(UNTAGGED_COPY, original.top);

JFrame jf = {
 Color background = yoix.xcolor.antiquewhite1;
 int   visible = 1;
 Array layout = {
  new JScrollPane {
   Array layout = {
    new JTree {
     String tag = "$_jt";
     int tooltips = 1;
     String font = "TimesRoman-14";
     JTreeNode top = copy;

     mouseClicked(MouseEvent e) {
      JTreeNode node = item(e.location.x, e.location.y);

      if (node != null) {
       copy = original.action(UNTAGGED_COPY, original.top);
       node.root.action(NEW_FOR_OLD, copy, node);
      }
     }
    },
   };
  }, CENTER,
 };
};