Changes between Version 8 and Version 9 of SCRIPTING_ACTIONS_API_R0

Timestamp:

07/16/09 09:42:52 (16 years ago)

Author:

mitex

Comment:

--

SCRIPTING_ACTIONS_API_R0

@@ -57 +57 @@
 
 == Implementation idea ==
- * Decide whether to expose the model classes (org.sophie2.base.model.book.Book, org.sophie2.base.model.book.Page, org.sophie2.base.model.book.Frame, etc.) or to write facade classes.
+ * Decide whether to expose the model classes (org.sophie2.base.model.book.Book, org.sophie2.base.model.book.Page, org.sophie2.base.model.book.Frame, etc.) or to write adapter classes.
   * The first approach will make scripts very powerful - the user will be able to do with them everything he/she can do with the application. In addition, it won't be necessary to update the facade every time we change something.
   * The second approach however will be more convenient for the user. It will also solve most of the security issues.
@@ -96 +96 @@
    * The swing component should be a panel with the combo box.
    * Register it as an extension
-  * Enum {{{RunScriptLogic}}} implements {{{OperationDef}}}
+  * Enum {{{org.sophie2.extra.func.scripting.logic.RunScriptLogic}}} implements {{{OperationDef}}}
    * Move RUN_SCRIPT from {{{ScriptLogic}}}
-   * ...ACTION_RUN_SCRIPT
-    * ...
+   * ACTION_RUN_SCRIPT
+    * Use this when activating a {{{RunScriptLinkAction}}}.
 
  * For the API:
   * Package {{{org.sophie2.extra.func.scripting.facade}}}
   * Class {{{JSBook}}} extends {{{ScriptableObject}}}
-   * Override {{{getClassName}}} to return "Book". That means that Sophie users will see that name instead of "JSBook".
+   * Override {{{getClassName}}} to return "Book". That means that script writers will use "Book" instead of "JSBook".
+   * Create getters and setters according to the analysis.
+    * For example, for the title write {{{String jsGet_title()}}} and {{{void jsSet_title(String title)}}}. This will allow users to benefit from the easy JavaScript syntax: "book.title = 'Design Patterns'".
   * Class {{{JSPage}}} extends {{{ScriptableObject}}}
    * {{{getClassName}}} returns "Page".
   * Class {{{JSFrame}}} extends {{{ScriptableObject}}}
    * {{{getClassName}}} returns "Frame".
+  * Class {{{JSApp}}} extends {{{ScriptableObject}}}
+   * {{{getClassName}}} returns "App".
+   * Create method {{{JSBook jsFunction_newBook()}}} which 
   * In {{{RunScriptLogic}}}:
-   * ...
+   * Use {{{ScriptableObject.defineClass(scope, JSBook.class);}}} to expose a given {{{ScriptableObject}}} to JavaScript.
+   * When executing a script from a document window, expose all adapter and facade classes. When the script is used as a link action, do not expose {{{JSApp}}}.
+   * Use
+{{{
+Scriptable scriptableJsBook = context.newObject(scope, "Book");
+ScriptableObject.putProperty(scope, "book", scriptableJsBook); 
+JSBook jsBook = (JSBook) Context.jsToJava(scriptableJsBook, JSBook.class);
+jsBook.setBook(bookRef);
+}}}
+    to expose a global variable {{{book}}} which represents the book where the script is created.
+   * Expose the app too, if running a script from a document window.
+   * Limit the scope of visible Java classes to only Rhino classes using {{{context.setClassShutter}}}.
 
  * Source code: [source:/branches/private/deni/scripting_actions/]