Save This Page
Home » bsf-src-2.4.0 » org.apache.bsf.engines.javascript » [javadoc | source]
org.apache.bsf.engines.javascript
public class: DocumentCell [javadoc | source]
java.lang.Object
   org.apache.bsf.engines.javascript.DocumentCell
A document cell materializes a known document. A document is a container for scripts or functions in JavaScript. The document is known as soon as a function or script is compiled in the engine. Compilation occurs as a side-effect of evaluating or executing a function or a script. Upon the first loading of a function or script of a document, the document becomes known and the debug manager is notified of the load. The debug manager will in turn notify the engine of all the known breakpoints for that document. When a breakpoint is propagated from the debug manager to an engine, the document will be added a breakpoint. The document will memorize the breakpoints if their corresponding function or script is not known at that time. If it is known, it is the FnOrScript that will memorize the breakpoint. See FnOrScript to see how a breakpoint is actually forwarded to the underlying Rhino engine.
Field Summary
 RhinoEngineDebugger m_rhinoDebugger     
 String m_docName     
 Vector m_fnOrScripts     
 Vector m_breakpoints     
 Hashtable m_functionMap     
Constructor:
 public DocumentCell(RhinoEngineDebugger rhinoDebugger,
    String name) 
Method from org.apache.bsf.engines.javascript.DocumentCell Summary:
addBreakpointAtLine,   addBreakpointAtOffset,   findBreakpointAtLine,   findBreakpointAtOffset,   findFnOrScript,   findFnOrScriptContaining,   fnOrScripts,   getEntryExit,   getLastFnOrScript,   getName,   registerFnOrScriptLines,   registerFnOrScriptLines,   registerFnOrScriptRange,   registerFnOrScriptRange,   removeBreakpoint,   setEntryExit,   setLastFnOrScript
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.bsf.engines.javascript.DocumentCell Detail:
 public  void addBreakpointAtLine(int brkptId,
    int lineno) 
    Add a breakpoint. Two cases exist. If a function or a script (FnOrScript) is known for the given line number, the breakpoint will be remembered by that FnOrScript. Otherwise, the breakpoint is memorized at the document level until a function or script is known, that is, compiled in our engine.
 public  void addBreakpointAtOffset(int brkptId,
    int offset) 
    Same as above, except the breakpoint is specified at an character offset rather than a line number.
 public BreakPoint findBreakpointAtLine(int lineno) throws BSFException 
 public BreakPoint findBreakpointAtOffset(int offset) throws BSFException 
 public FnOrScript findFnOrScript(int startLine,
    int column) 
 public FnOrScript findFnOrScriptContaining(int line) 
 public Enumeration fnOrScripts() 
 public boolean getEntryExit() 
 public FnOrScript getLastFnOrScript() 
 public String getName() 
 public FnOrScript registerFnOrScriptLines(Reader reader,
    int startLine,
    int column) throws BSFException 
 public FnOrScript registerFnOrScriptLines(String source,
    int startLine,
    int column) throws BSFException 
 public FnOrScript registerFnOrScriptRange(Reader reader,
    int offset) throws BSFException 
 public FnOrScript registerFnOrScriptRange(String source,
    int offset) throws BSFException 
 public BreakPoint removeBreakpoint(int brkptId) 
    Removing a breakpoint. Two cases, a breakpoint is only remembered at the document level, it has not been propagated to a function or script (FnOrScript). Then, just drop it. Second case, the breakpoint has been propagated, then scan the FnOrScript objects and ask them to drop the breakpoint. Note: only one will have it, see addBreakpoint...
 public  void setEntryExit(boolean on_value) 
 public  void setLastFnOrScript(FnOrScript fnos)