Describing DocumentElements internal html structure
[fnpeditor.git] / modules / rng / rng.js
index 4b9aecf..2078494 100644 (file)
-define([\r
-'fnpjs/layout',\r
-'views/tabs/tabs',\r
-'libs/text!./mainLayout.html'\r
-], function(layout, tabs, mainLayoutTemplate) {\r
-\r
-return function(sandbox) {\r
-    'use strict';\r
-    \r
-    var mainTabs = (new tabs.View()).render();\r
-    var mainLayout = new layout.Layout(mainLayoutTemplate);\r
-    sandbox.getDOM().append(mainLayout.getAsView());\r
-    \r
-    function addTab(title, slug, view) {\r
-        mainTabs.addTab(title, slug, view);\r
-    }\r
-    \r
-    /* Events handling */\r
-    \r
-    var eventHandlers = {};\r
-     \r
-    eventHandlers.sourceEditor = {\r
-        ready: function() {\r
-            addTab(gettext('Source'), 'source',  sandbox.getModule('sourceEditor').getView());\r
-            sandbox.getModule('sourceEditor').setDocument(sandbox.getModule('data').getDocument());\r
-        }\r
-    };\r
-    \r
-    eventHandlers.visualEditor = {\r
-        ready: function() {\r
-            sandbox.getModule('visualEditor').setDocument(sandbox.getModule('data').getDocument());\r
-            addTab(gettext('Visual'), 'visual', sandbox.getModule('visualEditor').getView());\r
-            \r
-        }\r
-    };\r
-    \r
-    eventHandlers.data = {\r
-        ready: function() {\r
-            mainLayout.setView('mainView', mainTabs.getAsView());\r
-            \r
-            _.each(['visualEditor', 'sourceEditor', 'rng2', 'mainBar', 'indicator'], function(moduleName) {\r
-                sandbox.getModule(moduleName).start();\r
-            });\r
-        },\r
-        documentChanged: function(document, reason) {\r
-            var slug = (reason === 'visual_edit' ? 'source' : 'visual');\r
-            sandbox.getModule(slug+'Editor').setDocument(document);\r
-        },\r
-        savingStarted: function() {\r
-            sandbox.getModule('mainBar').setCommandEnabled('save', false);\r
-            sandbox.getModule('indicator').showMessage(gettext('Saving...'));\r
-        },\r
-        savingEnded: function(status) {\r
-            sandbox.getModule('mainBar').setCommandEnabled('save', true);\r
-            sandbox.getModule('indicator').clearMessage();\r
-        }\r
-    }\r
-    \r
-    eventHandlers.rng2 = {\r
-        ready: function() {\r
-           addTab('rng2 test', 'rng2test', sandbox.getModule('rng2').getView());\r
-           \r
-        }\r
-    }\r
-    \r
-    eventHandlers.mainBar = {\r
-        ready: function() {\r
-            mainLayout.setView('topPanel', sandbox.getModule('mainBar').getView());\r
-        },\r
-        'cmd.save': function() {\r
-            sandbox.getModule('data').fakeSave();\r
-        }\r
-    }\r
-    \r
-    eventHandlers.indicator = {\r
-        ready: function() {\r
-            mainLayout.setView('messages', sandbox.getModule('indicator').getView());\r
-        }\r
-    }\r
-    \r
-    /* api */\r
-    \r
-    return {\r
-        start: function() {\r
-            sandbox.getModule('data').start();\r
-        },\r
-        handleEvent: function(moduleName, eventName, args) {\r
-            if('')\r
-                wysiwigHandler.handleEvent(moduleName, eventName, args);\r
-            else if(eventHandlers[moduleName] && eventHandlers[moduleName][eventName]) {\r
-                eventHandlers[moduleName][eventName].apply(eventHandlers, args);\r
-            }\r
-        }\r
-    }\r
-};\r
-\r
+define([
+'fnpjs/layout',
+'fnpjs/vbox',
+'views/tabs/tabs',
+'libs/text!./mainLayout.html',
+'libs/text!./editingLayout.html',
+'libs/text!./diffLayout.html',
+], function(layout, vbox, tabs, mainLayoutTemplate, visualEditingLayoutTemplate, diffLayoutTemplate) {
+
+'use strict';
+
+return function(sandbox) {
+    
+    function addMainTab(title, slug, view) {
+        views.mainTabs.addTab(title, slug, view);
+    }
+    
+    var dirty = {
+        sourceEditor: false,
+        documentCanvas: false,
+        metadataEditor: false,
+    };
+    
+    var synchronizeTab = function(slug) {
+        function tabIsDirty(slug) {
+            if(slug === 'editor' && (dirty.documentCanvas || dirty.metadataEditor))
+                return true;
+            if(slug === 'sourceEditor' && dirty.sourceEditor)
+                return true;
+            return false;
+        }
+    
+        if(tabIsDirty(slug)) {
+            var reason, doc;
+            if(slug === 'sourceEditor') {
+                doc = sandbox.getModule('sourceEditor').getDocument();
+                reason = 'source_edit';
+                dirty.sourceEditor = false;
+            }
+            if(slug === 'editor') {
+                doc = dirty.documentCanvas ? sandbox.getModule('documentCanvas').getDocument() : sandbox.getModule('data').getDocument();
+                if(dirty.metadataEditor) {
+                    doc = sandbox.getModule('metadataEditor').attachMetadata(doc);
+                }
+                reason = 'edit';
+                dirty.documentCanvas = dirty.metadataEditor = false;
+            }
+            sandbox.getModule('data').commitDocument(doc, reason);
+        }
+    };
+    
+    var commands = {
+        highlightDocumentNode: function(canvasNode, origin) {
+            ['documentCanvas', 'nodeBreadCrumbs', 'nodeFamilyTree'].forEach(function(moduleName) {
+                if(!origin || moduleName != origin)
+                    sandbox.getModule(moduleName).highlightNode(canvasNode);
+            });
+        },
+        dimDocumentNode: function(canvasNode, origin) {
+            ['documentCanvas', 'nodeBreadCrumbs', 'nodeFamilyTree'].forEach(function(moduleName) {
+                if(!origin || moduleName != origin)
+                    sandbox.getModule(moduleName).dimNode(canvasNode);
+            });
+        },
+        selectNode: function(canvasNode, origin) {
+            sandbox.getModule('documentCanvas').selectNode(canvasNode);
+            this.updateNodesModules(canvasNode);           
+        },
+        updateNodesModules: function(canvasNode) {
+            sandbox.getModule('nodePane').setNode(canvasNode);
+            sandbox.getModule('nodeFamilyTree').setNode(canvasNode);
+            sandbox.getModule('nodeBreadCrumbs').setNode(canvasNode);
+        },
+        resetDocument: function(document, reason) {
+            var modules = [];
+            if(reason === 'source_edit')
+                modules = ['documentCanvas', 'metadataEditor'];
+            else if (reason === 'edit')
+                modules = ['sourceEditor'];
+            else if (reason === 'revert')
+                modules = ['documentCanvas', 'metadataEditor', 'sourceEditor'];
+                
+            modules.forEach(function(moduleName) {
+                sandbox.getModule(moduleName).setDocument(document);
+            });
+        }
+    };
+    
+
+    var views = {
+        mainLayout: new layout.Layout(mainLayoutTemplate),
+        mainTabs: (new tabs.View()).render(),
+        visualEditing: new layout.Layout(visualEditingLayoutTemplate),
+        visualEditingSidebar: (new tabs.View({stacked: true})).render(),
+        currentNodePaneLayout: new vbox.VBox(),
+        diffLayout: new layout.Layout(diffLayoutTemplate)
+    };
+    
+    views.visualEditing.setView('rightColumn', views.visualEditingSidebar.getAsView());
+    addMainTab('Edytor', 'editor', views.visualEditing.getAsView());
+    addMainTab(gettext('Source'), 'sourceEditor',  '');
+    addMainTab('Historia', 'history', views.diffLayout.getAsView());
+    
+    sandbox.getDOM().append(views.mainLayout.getAsView());
+    
+    views.visualEditingSidebar.addTab({icon: 'pencil'}, 'edit', views.currentNodePaneLayout.getAsView());
+
+    views.mainTabs.on('tabSelected', function(event) {
+        if(event.prevSlug) {
+            synchronizeTab(event.prevSlug);
+        }
+    });
+    
+    /* Events handling */
+    
+    var eventHandlers = {};
+     
+    eventHandlers.sourceEditor = {
+        ready: function() {
+            addMainTab(gettext('Source'), 'sourceEditor',  sandbox.getModule('sourceEditor').getView());
+            sandbox.getModule('sourceEditor').setDocument(sandbox.getModule('data').getDocument());
+        },
+        xmlChanged: function() {
+            dirty.sourceEditor = true;
+        },
+        documentSet: function() {
+            dirty.sourceEditor = false;
+        }
+    };
+    
+    eventHandlers.data = {
+        ready: function() {
+            views.mainLayout.setView('mainView', views.mainTabs.getAsView());
+            
+            _.each(['sourceEditor', 'documentCanvas', 'documentToolbar', 'nodePane', 'metadataEditor', 'nodeFamilyTree', 'nodeBreadCrumbs', 'mainBar', 'indicator', 'documentHistory', 'diffViewer'], function(moduleName) {
+                sandbox.getModule(moduleName).start();
+            });
+        },
+        documentChanged: function(document, reason) {
+            commands.resetDocument(document, reason);
+        },
+        savingStarted: function() {
+            sandbox.getModule('mainBar').setCommandEnabled('save', false);
+            sandbox.getModule('indicator').showMessage(gettext('Saving...'));
+        },
+        savingEnded: function(status) {
+            sandbox.getModule('mainBar').setCommandEnabled('save', true);
+            sandbox.getModule('indicator').clearMessage({message:'Dokument zapisany'});
+        },
+        restoringStarted: function(event) {
+            sandbox.getModule('mainBar').setCommandEnabled('save', false);
+            sandbox.getModule('indicator').showMessage(gettext('Restoring version ') + event.version + '...');
+        },
+        historyItemAdded: function(item) {
+            sandbox.getModule('documentHistory').addHistory([item], {animate: true});
+        },
+        diffFetched: function(diff) {
+            sandbox.getModule('diffViewer').setDiff(diff);
+        },
+        documentReverted: function(event) {
+            commands.resetDocument(event.document, 'revert');
+            sandbox.getModule('mainBar').setCommandEnabled('save', true);
+            sandbox.getModule('indicator').clearMessage({message:'Wersja ' + event.reverted_version + ' przywrócona'});
+            sandbox.getModule('mainBar').setVersion(event.current_version);
+        }
+    };
+    
+    eventHandlers.mainBar = {
+        ready: function() {
+            sandbox.getModule('mainBar').setVersion(sandbox.getModule('data').getDocumentVersion());
+            views.mainLayout.setView('topPanel', sandbox.getModule('mainBar').getView());
+        },
+        'cmd.save': function() {
+            synchronizeTab(views.mainTabs.getCurrentSlug());
+            sandbox.getModule('data').saveDocument();
+        }
+    };
+    
+    eventHandlers.indicator = {
+        ready: function() {
+            views.mainLayout.setView('messages', sandbox.getModule('indicator').getView());
+        }
+    };
+    
+
+    
+    eventHandlers.documentCanvas = {
+        ready: function() {
+            sandbox.getModule('documentCanvas').setDocument(sandbox.getModule('data').getDocument());
+            views.visualEditing.setView('leftColumn', sandbox.getModule('documentCanvas').getView());
+        },
+        documentSet: function() {
+            dirty.documentCanvas = false;
+        },
+        
+        nodeSelected: function(canvasNode) {
+            commands.selectNode(canvasNode);
+        },
+        
+        contentChanged: function() {
+            dirty.documentCanvas = true;
+        },
+        
+        currentNodeChanged: function(canvasNode) {
+            commands.updateNodesModules(canvasNode);
+        },
+
+        nodeHovered: function(canvasNode) {
+            commands.highlightDocumentNode(canvasNode);
+        },
+        
+        nodeBlured: function(canvasNode) {
+            commands.dimDocumentNode(canvasNode);
+        }
+    };
+
+    eventHandlers.nodePane = {
+        ready: function() {
+            views.currentNodePaneLayout.appendView(sandbox.getModule('nodePane').getView());
+        },
+        
+        nodeChanged: function(attr, value) {
+            sandbox.getModule('documentCanvas').modifyCurrentNode(attr, value);
+        }
+    };
+    
+    eventHandlers.metadataEditor = {
+        ready: function() {
+            sandbox.getModule('metadataEditor').setDocument(sandbox.getModule('data').getDocument());
+            views.visualEditingSidebar.addTab({icon: 'info-sign'}, 'metadataEditor', sandbox.getModule('metadataEditor').getView());
+        },
+        metadataChanged: function(metadata) {
+            dirty.metadataEditor = true;
+        },
+        metadataSet: function() {
+            dirty.metadataEditor = false;
+        },
+    };
+    
+    eventHandlers.nodeFamilyTree = {
+        ready: function() {
+            views.currentNodePaneLayout.appendView(sandbox.getModule('nodeFamilyTree').getView());
+        },
+        nodeEntered: function(canvasNode) {
+            commands.highlightDocumentNode(canvasNode, 'nodeFamilyTree');
+        },
+        nodeLeft: function(canvasNode) {
+            commands.dimDocumentNode(canvasNode, 'nodeFamilyTree');
+        },
+        nodeSelected: function(canvasNode) {
+            commands.selectNode(canvasNode);
+        }
+    };
+    
+    eventHandlers.documentToolbar = {
+        ready: function() {
+            views.visualEditing.setView('toolbar', sandbox.getModule('documentToolbar').getView());
+        },
+        toggleGrid: function(toggle) {
+            sandbox.getModule('documentCanvas').toggleGrid(toggle);
+        },
+        newNodeRequested: function(wlxmlTag, wlxmlClass) {
+                sandbox.getModule('documentCanvas').insertNewNode(wlxmlTag, wlxmlClass);
+        },
+        command: function(cmd, meta) {
+            sandbox.getModule('documentCanvas').command(cmd, meta);
+        }
+    };
+    
+    eventHandlers.nodeBreadCrumbs = {
+        ready: function() {
+            views.visualEditing.setView('statusBar', sandbox.getModule('nodeBreadCrumbs').getView());
+        },
+        nodeHighlighted: function(canvasNode) {
+            commands.highlightDocumentNode(canvasNode, 'nodeBreadCrumbs');
+        },
+        nodeDimmed: function(canvasNode) {
+            commands.dimDocumentNode(canvasNode, 'nodeBreadCrumbs');
+        },
+        nodeSelected: function(canvasNode) {
+            commands.selectNode(canvasNode);
+        }        
+    };
+    
+    eventHandlers.documentHistory = {
+        ready: function() {
+            sandbox.getModule('documentHistory').addHistory(sandbox.getModule('data').getHistory());
+            views.diffLayout.setView('left', sandbox.getModule('documentHistory').getView());
+        },
+        compare: function(ver1, ver2) {
+            sandbox.getModule('data').fetchDiff(ver1, ver2);
+        },
+        restoreVersion: function(event) {
+            sandbox.getModule('data').restoreVersion(event);
+        },
+        displayVersion: function(event) {
+            window.open('/' + gettext('editor') + '/' + sandbox.getModule('data').getDocumentId() + '?version=' + event.version, _.uniqueId());
+        }
+    };
+    
+    eventHandlers.diffViewer = {
+        ready: function() {
+            views.diffLayout.setView('right', sandbox.getModule('diffViewer').getView());
+        }
+    };
+    
+    /* api */
+    
+    return {
+        start: function() {
+            sandbox.getModule('data').start();
+        },
+        handleEvent: function(moduleName, eventName, args) {
+            if('')
+                wysiwigHandler.handleEvent(moduleName, eventName, args);
+            else if(eventHandlers[moduleName] && eventHandlers[moduleName][eventName]) {
+                eventHandlers[moduleName][eventName].apply(eventHandlers, args);
+            }
+        }
+    };
+};
+
 });
\ No newline at end of file
 });
\ No newline at end of file