contents   index   previous   next



PARAMS

 

This parameter is a object that contains several access methods. You use the access methods to set the various option variables in the object. You can pass null if you do not want to specify any of them. Here are the access methods of the SEEvalParams class:

 

public SEObject getScopeStart();

public void setScopeStart(SEObject scopestart);

public SEObject getScopeEnd();

public void setScopeEnd(SEObject scopeend);

 

The scope chain is how ScriptEase determines what a variable name is referring to. The scope chain is a list of objects. For a typical function, the list contains the activation object in which local variables are stored and the global object in which global variables are stored. The variables themselves are members of the object they are a part of. As a result, for a typical function, the local variables are first search for a variable name followed by the global variables. You can specify your own objects to be added to the list.

 

The scopestart and scopeend members of the params object are SEObjects created using the seMakeStack API call. The members of these objects should be objects to be added to the scope chain. These objects are added at the start or end of the scope chain respectively. Those added at the start are searched first.

 

Adding objects to the start of the scope chain is analogous to a script execution inside a with statement. A with statement adds a single object to the start of the scope chain. setScopeStart allows you to add a list of objects, but the same principle applies. setScopeEnd works similarly but adds objects to be searched after all other places to search for a variable name.

 

public SEObject getGlobal();

public void setGlobal(SEObject global);

 

Indicates a new global variable to evaluate the script using.

 

public SEObject getDefaultThis();

public void setDefaultThis(SEObject default_this);

 

The default_this parameter allows you to determine which object will be the this variable for the executed script or function. For a script, the null value is traditionally used which makes the global variable the default this for the evaluated script as well. For a function, if the function is being invoked as a member of some object, that object should be passed as the default_this variable instead.

 

public SEObject getSecurityInit();

public void setSecurityInit(SEObject security_init);

public SEObject getSecurityTerm();

public void setSecurityInit(SEObject security_term);

public SEObject getSecurityGuard();

public void setSecurityGuard(SEObject security_guard);

public SEObject getSecurityObject();

public void setSecurityObject(SEObject security_object);

 

These are the standard security functions as described in the ScriptEase language manual chapter on security. These objects work exactly the same in the ScriptEase ISDK as they do for any other ScriptEase security application.

 

public String getFileName();

public void setFileName(String filename);

public int getLineNum();

public void setLineNum(int linenum);

 

These parameters are used when the SE.TEXT form of script is executed. They specify the virtual filename and starting line number for the script text. This is helpful in reporting errors that might occur in the script text.


FUNCTION GLOBALS