Changes between Version 10 and Version 11 of GROUP_SCRIPTING_R0

Timestamp:

07/11/09 11:05:51 (16 years ago)

Author:

mitex

Comment:

--

GROUP_SCRIPTING_R0

@@ -56 +56 @@
    * RwProp<String> scriptText - the javascript source code text
   * subpackage {{{persistence}}}
-   * class {{{ScriptPersister}}} extends {{{Persister<String, Storage>}}}
+   * class {{{ScriptResPersister}}} extends {{{Persister<String, Storage>}}}
     * schema "resource:script|storage|r3"
     * the storage should have one child for the script text
     * this persister is needed when the parent book is persisted.
-   * class {{{ScriptFilePersister}}} extends {{{Persister<Storage, File>}}}
-    * schema "storage|file|js"
-    * the script is persisted as a plain text file with ".js" extension
-   * register the persisters as extensions
+   * register the persister as an extension
 
  * view:
@@ -71 +68 @@
    * INSERT_SCRIPT_FILE
    * RUN_SCRIPT
-   * EDIT_SCRIPT
+   * TEXT_CHANGED
+   * OPEN_WINDOW
   * document window for resource viewing, editing and running:
    * class {{{ScriptDocumentWindow}}} extends {{{DefaultDocumentWindow}}} implements {{{DocumentView}}}
-   * RwProp<ResourceRef> model - the script resource that is displayed
+   * In DocumentWindow add Prop<ResourceRef> modelDocument()
+   * RwProp<ResourceRef> modelDocument - the script resource that is displayed
    * resource property {{{swingFrameSync}}} that adds the following components to {{{swingComponent}}}:
-    * a text area that fires EDIT_SCRIPT
-    * and "Run" {{{LogicR3Button}}} that fires RUN_SCRIPT
+    * a text area that fires TEXT_CHANGED
+    * "Run" {{{LogicR3Button}}} that fires RUN_SCRIPT
+    * a text area for the script result or error messages
   * class {{{ScriptDocumentWindowProvider}}} implements {{{DocumentWindowProvider}}} (see last section)
    * getWindow should return a new {{{ScriptDocumentWindow}}} for the given script resource
@@ -85 +85 @@
     * {{{getResourceKind()}}} should return the kind in {{{ScriptResource}}}
     * {{{filterKind()}}} should return "Script"
-    * nested private static class {{{ScriptResourcePreview}}}
+    * nested static class {{{ScriptResourcePreview}}} which is a {{{SwingVisualElement}}}
      * constructor with argument of type {{{ScriptResource}}}
-     * in {{{swingComponent}}} create a new JPanel, analogic to the panel in {{{ScriptDocumentWindow}}}
-      * components should fire the same events as in {{{ScriptDocumentWindow}}}
+     * in {{{swingComponent}}} create a new JPanel with:
+      * read-only JTextArea that displays the script content
+      * "Open" LogicR3Button that fires OPEN_WINDOW
     * {{{getVisualElement(Resource element)}}} should return a new instance of {{{ScriptResourcePreview}}}
+   * In ResourceDetailsPalette create a property RwProp<SwingVisualElement> previewVisualElement
+    * use @Own annotation because the parent is required in the logic of OPEN_WINDOW
    * register the class as an extension
 
  * logic:
   * enum ScriptingLogic that implements OperationDef:
-   * all of the following items should listen for an event with the same id
+   * all of the following items should listen for an event with the corresponding id
    * INSERT_SCRIPT
     * listens for the event in {{{InsertScriptItem}}}
     * creates a new empty {{{ScriptResource}}} in current book (use {{{CurrentBookUtil.getCurrentBook}}})
     * adds it to {{{App.documents}}} (see last section for details)
+    * sets it as current
    * INSERT_SCRIPT_FILE
     * listens for the event in {{{InsertScriptFileItem}}}
@@ -104 +108 @@
     * using the persisters, creates a new {{{ScriptResource}}} in current book
     * adds it to {{{App.documents}}} (see last section)
+    * sets it as current
    * RUN_SCRIPT
     * write the following temporary solution:
@@ -109 +114 @@
      * initialize the standard objects (Object, Function, etc.) using {{{Scriptable scope = cx.initStandardObjects();}}}
      * evaluate the resource's text: {{{Object result = cx.evaluateString(scope, s, "<cmd>", 1, null);}}}
-     * if there's a result, open a message box to display the result by creating a new {{{MessageDialogInput}}} and invoking {{{DialogManager#showDialog}}}
+     * display the result in the result text area.
+     * if org.mozilla.javascript.EcmaError or org.mozilla.javascript.EvaluatorException is thrown, display the message in the result text area
      * exit from the context with {{{Context.exit();}}}. Call this from a finally block.
-   * EDIT_SCRIPT
+   * TEXT_CHANGED
     * the following solution can be optimized:
-     * create a new AutoChange that changes the text in the resource with that from the text area. Register the change to script's book.
+     * create a new AutoChange that changes the text in the resource with that from the text area. Register the change to the script resource.
+   * OPEN_WINDOW
+    * get the source which is of type {{{ScriptResourcePreview}}}
+    * add its model to the list {{{App.documents}}}, but only if it is not already added
+    * set the document as current
    * register the enum as an extension
 
@@ -120 +130 @@
   * Create an interface {{{org.sophie2.main.app.commons.windows.DocumentWindowProvider}}}
    * String getResourceKind() - Gets the resource kind of the resource for which this provider should create appropriate document window.
-   * DocumentWindow getWindow(ResourceRef ref) - Creates a new concrete implementation of {{{DocumentWindow}}} for the given resource.
+   * DocumentWindowProvider getWindowProvider(ResourceRef ref) - Creates a new concrete implementation of {{{DocumentWindowProvider}}} for the given resource.
   * Create an extension point in {{{MainAppModule}}} for document window providers
   * Class {{{org.sophie2.main.app.commons.windows.BookDocumentWindowProvider}}} implements {{{DocumentWindowProvider}}} and creates book document windows
    * Register it as an extension
   * Class {{{org.sophie2.main.app.commons.windows.DocumentWindowProviderFactory}}}
-   * static DocumentWindow createWindow(ResourceRef ref)
+   * static DocumentWindowProvider getWindowProvider(ResourceRef ref)
     * iterates over all extensions in the extension point
-    * if an appropriate provider is found, creates a document window with it
-  * Remove the properties {{{currentBook}}} and {{{lastCurrentBook}}} in {{{App}}}.
-   * Create analogical property {{{lastCurrentWindow}}} in {{{AppDocumentsDesktop}}}.
-   * Refactor the {{{AppDocumentsDesktop.currentWindow}}}.
-   * Replace all calls of currentBook with calls of currentWindow.
-  * On book closing close all children resources too (currently they can be scripts).
+    * if an appropriate provider is found, returns it
+  * Refactor {{{AppDocumentsDesktop.windows}}}:
+   * create a class DocumentInfo that has two fields - ResourceRef ref and DocumentWindowProvider provider
+   * create a hash map with keys of type DocumentInfo and values of type DocumentWindow
+    * override equals and hashCode methods
+    * create a hashCode in ResourceRef too
+   * replace the TrackingProList with ComposingProList
+   * iterate over all open documents and use the factory to find the appropriate provider
+   * if the cache (the hash map) contains DocumentInfo with these resource reference and provider, return the window
+   * if not, create a new window with the factory and store it in the cache
 
  * Source code: [source:/branches/private/deni/scripting/]
+  * Tests: [source:/branches/private/deni/scripting/modules/org.sophie2.extra.func.scripting/src/test/java/org/sophie2/extra/func/scripting]
 
 = Implementation =
-^(Describe and link the implementation results here (from the wiki or the repository).)^
+ * Source code: [source:/branches/private/deni/scripting/]
 
 = Testing =