codesimian
Class TreeOfCodeGUI

java.lang.Object
  extended by codesimian.CS
      extended by codesimian.DefaultCS
          extended by codesimian.TreeOfCodeGUI
All Implemented Interfaces:
CodeSimian, java.awt.event.MouseListener, java.io.Serializable, java.util.EventListener, javax.swing.event.TreeModelListener, javax.swing.event.TreeSelectionListener
Direct Known Subclasses:
TreeOfCode

public class TreeOfCodeGUI
extends DefaultCS
implements javax.swing.event.TreeSelectionListener, javax.swing.event.TreeModelListener, java.awt.event.MouseListener

A GUI component that displays a JTree of CodeSimian code. The tree is a depth-first traversal starting from param0.

If there is a param1, param1 is replaced by the CS selected in the GUI every time a new CS is selected. When you setP(1, selectThisCS), and selectThisCS is contained in a TreeNode in the JTree, the JTree selects that TreeNode and shows it in the GUI. If its not in the JTree, param1 is not set.

If there is a param2, param2 is used as an anonymous function with 1 param. When a CS is selected in the JTree, tries to set TreeOfCodeGUI.param2.param0 to TreeOfCodeGUI.param1 then executes TreeOfCodeGUI.param2. If that fails, does nothing. Maybe it will work for next CS clicked by mouse.

Each TreeNode is updated when it is selected in the GUI. Update means to display the new params of that TreeNode's CS if they have changed.

If the CS at the tree's root changes, the JTree returned by getObject() is replaced by a new JTree, but only if the GUI object that contains me calls getObject() (or L(JTree.class)) again.

Use getObject() and setObject(CS jtreeOrCSThatContainsAJTree) to access the JTree. Or, use the normal PARAM functions on param0 to change the root CS that the JTree displays.

See Also:
Serialized Form

Nested Class Summary
static class TreeOfCodeGUI.TreeNodeForCS
          User-object (getUserObject()) can be any Object to put in a tree.
 
Field Summary
 
Fields inherited from class codesimian.CS
DESCRIPTION, END, EXECPROXY, FUEL, HEAP, JAVACODE, MYFUEL, NAME, NEWINSTANCE, NULL, PARENT, PARSEPRIORITY, PREV, TESTER
 
Constructor Summary
TreeOfCodeGUI()
          initial JTree displays a mostly empty tree containing only Const.zero
TreeOfCodeGUI(CS treeRoot)
          initial JTree displays treeRoot
 
Method Summary
 javax.swing.tree.TreeNode[] allTreeNodes(javax.swing.tree.TreeNode root)
          returns all TreeNodes that can be reached through some TreePath starting from 'root'
 double cost()
          cost() should be changed to return a float, and should be renamed to costToExecute()

cost of EXECUTING this CS, not including any CSs it executes recursively.
 boolean deleteP(int index)
          WARNING: if returns false, could have deleted but not moved other params down 1 index.
WARNING: if duplicates not allowed, can not slide params down 1 index the standard way, returns false.
 java.lang.String description()
          a short description of this CS, shorter than the javadoc, but long enough to tell what the params are for.
 double DForProxy()
          D() and DForProxy() are the 2 most important functions in CS.
 java.lang.Object getObject()
          returns the JTree that this TreeOfCodeGUI represents
 boolean insertP(int index, CS insertMe)
          same as setP(int,CS) but inserts instead of overwriting.
 java.lang.String keyword()
          For the CodeSimian language as a String.
CodeSimian language keyword, like "+" "*" "max" ">" etc.

Override this function if you want to specify a keyword other than how I derive them from the class name, like + for Add.

Some CSs might never be intended to be used in the language by their keyword.
The best example (4/05) is Num, because it is used in the language like "3.4" instead of "num()".
 int maxP()
          Maximum quantity of Params
 int minP()
          For DForProxy().
Minimum number of parameters in param[] needed to call DForProxy().
Defines which indexs of param[] DForProxy() can use.
Functions with a different number of parameters must override this.
OVERRIDE THIS FUNCTION IF EXEC USES A DIFFERENT NUMBER OF PARAMETERS.
Default is 1.
 void mouseClicked(java.awt.event.MouseEvent e)
           
 void mouseEntered(java.awt.event.MouseEvent e)
           
 void mouseExited(java.awt.event.MouseEvent e)
           
 void mousePressed(java.awt.event.MouseEvent e)
           
 void mouseReleased(java.awt.event.MouseEvent e)
           
 javax.swing.tree.TreePath path(javax.swing.tree.TreeNode start, javax.swing.tree.TreeNode end)
          null if no path exists
 boolean selectInGUI(CS selectMe)
           
 boolean setObject(java.lang.Object setTo)
          Sets the JTree that this TreeOfCodeGUI represents, to a new JTree.
 boolean setP(int index, CS setTo)
          Every CS is a list of other CSs, between size minP() and maxP() inclusive.
 java.awt.Dimension sizeIShouldBe()
           
 void treeNodesChanged(javax.swing.event.TreeModelEvent e)
           
 void treeNodesInserted(javax.swing.event.TreeModelEvent e)
           
 void treeNodesRemoved(javax.swing.event.TreeModelEvent e)
           
 javax.swing.JTree treeOfCode(CS treeRoot)
           
 javax.swing.tree.TreePath treePathToCS(javax.swing.tree.TreeNode startHere, CS lastTreeNodeContainsThisCS)
          Returns a TreePath from startHere to the TreeNode that contains lastTreeNodeContainsThisCS, or null if no such path exists.
 void treeStructureChanged(javax.swing.event.TreeModelEvent e)
           
 void updateSize()
           
 boolean updateTreeNode(javax.swing.tree.TreeNode updateMe)
          updateMe's child TreeNodes should contain the child CSs of updateMe's CS.
 void valueChanged(javax.swing.event.TreeSelectionEvent e)
           
 
Methods inherited from class codesimian.DefaultCS
B, C, countP, decrementMyFuel, F, fuel, getExec, heap, I, indexP, indexPName, insertB, insertC, insertD, insertF, insertI, insertJ, insertL, insertL, insertL1, insertS, insertZ, J, javaCode, LForProxy, LForProxy, myFuel, name, newInstance, objectToCS, objectToCSArray, objectToCSArray, P, prevD, prevL, PType, S, setB, setC, setCountP, setD, setD, setExec, setF, setFuel, setI, setJ, setL, setL, setL, setL1, setMyFuel, setName, setPrevExec, setS, setZ, start, toString, V, Z
 
Methods inherited from class codesimian.CS
addP, addP, addP, addP, addP, BForProxy, CForProxy, clone, D, deleteP, FForProxy, IForProxy, isIllusion, javaCode, JForProxy, L, L, L, L, L, maxD, minD, overwrites, parent, parsePriority, PB, PC, PD, PF, PI, PJ, PL, prevB, prevC, prevF, prevI, prevJ, prevS, prevZ, proxyOf, PS, PZ, reflect, reflect, setB, setC, setCost, setDescription, setF, setHeap, setI, setJ, setL, setL, setParent, setParsePriority, setProxyOf, setPType, setS, setTester, setZ, SForProxy, tester, VForProxy, voidReflect, ZForProxy
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TreeOfCodeGUI

public TreeOfCodeGUI(CS treeRoot)
initial JTree displays treeRoot


TreeOfCodeGUI

public TreeOfCodeGUI()
initial JTree displays a mostly empty tree containing only Const.zero

Method Detail

DForProxy

public double DForProxy()
Description copied from class: CS
D() and DForProxy() are the 2 most important functions in CS. They execute this CS. All other execute functions, by default, use DForProxy instead of reinventing-the-wheel for their own type.

For example, J() calls JForProxy() which calls DForProxy(). D() calls DForProxy() directly.

Execute this CS and cast to double. D() is the main EXECUTE function. D() uses DForProxy(). DForProxy() is the main action of every CS, the most important function. By default, all other primitive EXECUTE functions defer to D.
Functions that EXECUTE this CS: L(Class) L(int,Class,int) Z() B() C() S() I() J() F() D() V()

Specified by:
DForProxy in class DefaultCS

minP

public int minP()
Description copied from class: DefaultCS
For DForProxy().
Minimum number of parameters in param[] needed to call DForProxy().
Defines which indexs of param[] DForProxy() can use.
Functions with a different number of parameters must override this.
OVERRIDE THIS FUNCTION IF EXEC USES A DIFFERENT NUMBER OF PARAMETERS.
Default is 1.

Overrides:
minP in class DefaultCS

maxP

public int maxP()
Description copied from class: CS
Maximum quantity of Params

Overrides:
maxP in class CS

keyword

public java.lang.String keyword()
Description copied from class: DefaultCS
For the CodeSimian language as a String.
CodeSimian language keyword, like "+" "*" "max" ">" etc.

Override this function if you want to specify a keyword other than how I derive them from the class name, like + for Add.

Some CSs might never be intended to be used in the language by their keyword.
The best example (4/05) is Num, because it is used in the language like "3.4" instead of "num()".
Default: Returns class name, minus package name (and its dots), and change the first letter to lowercase.

For example, CS.MaxParams does not override keyword(), which returns "maxP".

Overrides:
keyword in class DefaultCS
See Also:
CS.parent(), CS.newInstance(), CS.name()

description

public java.lang.String description()
Description copied from class: CS
a short description of this CS, shorter than the javadoc, but long enough to tell what the params are for. Example use: in automatically generated webpages for CodeSimian. Example: "returns sum of all params" for Add.

Overrides:
description in class DefaultCS

cost

public double cost()
Description copied from class: CS
cost() should be changed to return a float, and should be renamed to costToExecute()

cost of EXECUTING this CS, not including any CSs it executes recursively. The INTERNAL cost.

One unit of myFuel() costs cost() units of fuel(). Beware of CSs that counterfeit fuel.

Returns 1 by default.

Overrides:
cost in class CS

getObject

public java.lang.Object getObject()
returns the JTree that this TreeOfCodeGUI represents

Overrides:
getObject in class DefaultCS
See Also:
anyObject

setObject

public boolean setObject(java.lang.Object setTo)
Sets the JTree that this TreeOfCodeGUI represents, to a new JTree.

Object setTo must be a JTree or CS. If its a JTree, quickly sets OBJECT to that JTree. If its a CS whose getObject() returns a JTree (example: TreeOfCodeGUI), then that JTree is the new OBJECT. Else a new JTree is created with that CS as the root.

IF YOU CAN NOT GET THE JTREE TO UPDATE IN THE GUI...
A GUI object that contains this TreeOfCodeGUI will not update the displayed JTree's root until it calls my getObject() again, which should happen when the outer object's DForProxy() is called, but it might be lazy and getObject() only once.

Overrides:
setObject in class DefaultCS
See Also:
anyObject

updateSize

public void updateSize()

sizeIShouldBe

public java.awt.Dimension sizeIShouldBe()

treeOfCode

public javax.swing.JTree treeOfCode(CS treeRoot)

setP

public boolean setP(int index,
                    CS setTo)
Description copied from class: CS
Every CS is a list of other CSs, between size minP() and maxP() inclusive. setP overwrites one of those CSs or adds a new one at the end, depending on the index. If index is between 0 and countP()-1, overwrites. If it equals countP(), adds at end.

Overrides:
setP in class DefaultCS

insertP

public boolean insertP(int index,
                       CS insertMe)
Description copied from class: CS
same as setP(int,CS) but inserts instead of overwriting. All higher params slide up 1 index.

Overrides:
insertP in class DefaultCS

deleteP

public boolean deleteP(int index)
Description copied from class: DefaultCS
WARNING: if returns false, could have deleted but not moved other params down 1 index.
WARNING: if duplicates not allowed, can not slide params down 1 index the standard way, returns false.

Overrides:
deleteP in class DefaultCS

selectInGUI

public boolean selectInGUI(CS selectMe)

updateTreeNode

public boolean updateTreeNode(javax.swing.tree.TreeNode updateMe)
updateMe's child TreeNodes should contain the child CSs of updateMe's CS. If not, replaces updateMe's childs with new TreeNodes that contain the correct CSs. Returns true if anything changes.


path

public javax.swing.tree.TreePath path(javax.swing.tree.TreeNode start,
                                      javax.swing.tree.TreeNode end)
null if no path exists


treePathToCS

public javax.swing.tree.TreePath treePathToCS(javax.swing.tree.TreeNode startHere,
                                              CS lastTreeNodeContainsThisCS)
Returns a TreePath from startHere to the TreeNode that contains lastTreeNodeContainsThisCS, or null if no such path exists.


allTreeNodes

public javax.swing.tree.TreeNode[] allTreeNodes(javax.swing.tree.TreeNode root)
returns all TreeNodes that can be reached through some TreePath starting from 'root'


valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent e)
Specified by:
valueChanged in interface javax.swing.event.TreeSelectionListener

treeNodesChanged

public void treeNodesChanged(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesChanged in interface javax.swing.event.TreeModelListener

treeNodesInserted

public void treeNodesInserted(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesInserted in interface javax.swing.event.TreeModelListener

treeNodesRemoved

public void treeNodesRemoved(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesRemoved in interface javax.swing.event.TreeModelListener

treeStructureChanged

public void treeStructureChanged(javax.swing.event.TreeModelEvent e)
Specified by:
treeStructureChanged in interface javax.swing.event.TreeModelListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
Specified by:
mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
Specified by:
mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
Specified by:
mouseReleased in interface java.awt.event.MouseListener