codesimian
Class ButtonCS

java.lang.Object
  codesimian.CS<CSGeneric>
      codesimian.DefaultCS
          codesimian.ButtonCS

All Implemented Interfaces:

CodeSimian, java.awt.event.ActionListener, java.util.EventListener

public class ButtonCS
extends DefaultCS
implements java.awt.event.ActionListener

A GUI JButton wrapped in a CS. When the button is clicked, I execute my param0. If I have no param0, I return 0 and do nothing. To get the JButton, call L(java.awt.Component.class) or L(javax.swing.JButton) etc.

If param1 exists, param1 is the text on the button.

Field Summary

Fields inherited from class codesimian.CS

DESCRIPTION, END, EXECPROXY, HEAP, JAVACODE, MYFUEL, NAME, NEWINSTANCE, NULL, PARENT, PARSEPRIORITY, PREV, TESTER, THIS

Constructor Summary

ButtonCS()

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
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.
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() Execute this CS and cast to double.
java.lang.Object	getObject() Returns the main Object that this CS wraps (if one exists).
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.
boolean	setName(java.lang.String newName) sets the name of this CS
boolean	setObject(java.lang.Object setTo) false
boolean	setP(int index, CS setTo) if index==1, tries to update JButton text.

Methods inherited from class codesimian.DefaultCS

B, C, countP, decrementMyFuel, deleteP, F, fuel, getExec, heap, I, indexP, indexPName, insertB, insertC, insertD, insertF, insertI, insertJ, insertL, insertL, insertL1, insertP, 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, setPrevExec, setPType, setS, setZ, start, toString, V, Z

Methods inherited from class codesimian.CS

addB, addC, addD, addF, addI, addJ, addL, addP, addP, addP, addP, addP, addS, addZ, BForProxy, CForProxy, clone, D, deleteP, FForProxy, GETB, GETC, GETD, GETF, GETI, GETJ, GETL, GETS, GETZ, IForProxy, isIllusion, 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, reflect6, setB, SETB, setC, SETC, setCost, SETD, setDescription, setF, SETF, setHeap, setI, SETI, setJ, SETJ, SETL, setL, setL, setParent, setParsePriority, setProxyOf, setS, SETS, setTester, setZ, SETZ, SForProxy, tester, toJavaCode, VForProxy, voidReflect, ZForProxy

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ButtonCS

public ButtonCS()

Method Detail

DForProxy

public double DForProxy()

Description copied from class: CS

Execute this CS and cast to double.

D() and DForProxy() are the 2 most important functions in CS. They execute this CS. All other execute functions, by default, return DForProxy cast to their own type.

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

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

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

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

getObject

public java.lang.Object getObject()

Description copied from class: CS

Returns the main Object that this CS wraps (if one exists). This function is deprecated and should be replaced with L(Object.class), which uses getObject(). Then getObject() should be completely removed. L(Class) is more flexible.

Overrides:

getObject in class DefaultCS

See Also:

anyObject

setObject

public boolean setObject(java.lang.Object setTo)

false

Overrides:

setObject in class DefaultCS

See Also:

anyObject

setName

public boolean setName(java.lang.String newName)

Description copied from class: CS

sets the name of this CS

Overrides:

setName in class DefaultCS

setP

public boolean setP(int index,
                    CS setTo)

if index==1, tries to update JButton text. Calls super.setP()

Overrides:

setP in class DefaultCS

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener