codesimian
Class Scroll

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

All Implemented Interfaces:

CodeSimian, java.util.EventListener, javax.swing.event.ChangeListener

public class Scroll
extends DefaultCS
implements javax.swing.event.ChangeListener

Vertical and/or horizontal scrollbars automatically appear around P(0) when P(0) becomes too large to be completely viewed in its current part of the screen.

someScroll.L(java.awt.Component.class) contains someScroll.P(0).L(java.awt.Component.class);

Use someScroll.L(java.awt.JScrollPane.class) to get the JScrollPane. Or use someScroll.L(java.awt.Component.class) because JScrollPane extends Component.

P(1) is optional and is X scroll position, range 0 to 1. If P(1) is negative, the default JScrollPane horizontal scrolling behavior is used. TODO: Values above 1 may be used for other things later, like int position instead of fraction.

Similarly, P(2) is Y scroll position.

Field Summary

Fields inherited from class codesimian.CS

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

Constructor Summary

Scroll()

Method Summary

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() Execute this CS and cast to double.
int	getMaxScrollXPosition()
int	getMaxScrollYPosition()
int	getMinScrollXPosition()
int	getMinScrollYPosition()
double	getScrollXFraction()
int	getScrollXPosition()
double	getScrollYFraction()
int	getScrollYPosition()
javax.swing.JViewport	getViewport()
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()".
java.lang.Object	LForProxy(java.lang.Class c) the default implementation can use many Class parameters.
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	setP(int index, CS setTo) Every CS is a list of other CSs, between size minP() and maxP() inclusive.
void	setScrollPosition(int x, int y) top-left corner.
void	setScrollXFraction(double fraction)
void	setScrollXPosition(int x)
void	setScrollYFraction(double fraction)
void	setScrollYPosition(int y)
void	stateChanged(javax.swing.event.ChangeEvent ev)

Methods inherited from class codesimian.DefaultCS

B, C, countP, decrementMyFuel, F, fuel, getExec, getObject, heap, I, indexP, indexPName, insertB, insertC, insertD, insertF, insertI, insertJ, insertL, insertL, insertL1, insertP, insertS, insertZ, J, javaCode, 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, setObject, 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

Scroll

public Scroll()

Method Detail

LForProxy

public java.lang.Object LForProxy(java.lang.Class c)

Description copied from class: DefaultCS

the default implementation can use many Class parameters. If you override but do not know what to return, return super.LForProxy(Class). All EXEC objects must override L(Class) the same way they override D(), reversed.

TODO: add ability to return List, or should I make every CS be a list?

Overrides:

LForProxy in class DefaultCS

See Also:

execProxy(), setExecProxy(CS)

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

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

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

setScrollPosition

public void setScrollPosition(int x,
                              int y)

top-left corner. x and y are never negative. TODO: test this function.

getScrollXFraction

public double getScrollXFraction()

getScrollYFraction

public double getScrollYFraction()

setScrollXFraction

public void setScrollXFraction(double fraction)

setScrollYFraction

public void setScrollYFraction(double fraction)

setScrollXPosition

public void setScrollXPosition(int x)

setScrollYPosition

public void setScrollYPosition(int y)

getScrollXPosition

public int getScrollXPosition()

getScrollYPosition

public int getScrollYPosition()

getMinScrollXPosition

public int getMinScrollXPosition()

getMaxScrollXPosition

public int getMaxScrollXPosition()

getMinScrollYPosition

public int getMinScrollYPosition()

getMaxScrollYPosition

public int getMaxScrollYPosition()

getViewport

public javax.swing.JViewport getViewport()

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

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

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent ev)

Specified by:

stateChanged in interface javax.swing.event.ChangeListener