MINOR Removed legacy code from LeftAndMain.Tree.js, replaced with a list of @todo items

This commit is contained in:
Ingo Schommer 2011-03-10 16:46:08 +13:00
parent d22e80b1bd
commit 885597a754

View File

@ -4,6 +4,32 @@
(function($) {
$(document).ready(function() {
/**
* @todo Selectable tree with multiselect (toggled via "Batch Actions" panel)
* @todo Fix initial, unnecessary html_data replacement of existing tree (see below)
* @todo Icon and page type hover support
* @todo Sorting of sub nodes (originally placed in context menu)
* @todo Refresh after language <select> change (with Translatable enabled)
* @todo Automatic load of full subtree via ajax on node checkbox selection (minNodeCount = 0)
* to avoid doing partial selection with "hidden nodes" (unloaded markup)
* @todo Add siteTreeHints to field (as "data-hints" attribute with serialized JSON instead of javascript global variable)
* @todo Disallow drag'n'drop when not matching "allowedChildren" or "allowedParents" (see siteTreeHints)
* @todo Disallow drag'n'drop when node has "noChildren" set (see siteTreeHints)
* @todo Disallow moving of pages marked as deleted
* @todo Enforce sitetreeHints rules on page creation ("allowedChildren", "noChildren") -
* most likely by server response codes rather than clientside
* @todo "defaultChild" when creating a page (sitetreeHints)
* @todo Duplicate page (originally located in context menu)
* @todo Update tree node title information and modified state after reordering (response is a JSON array)
*
* Tasks most likely not required after moving to a standalone tree:
*
* @todo Context menu - to be replaced by a bezel UI
* @todo Refresh form for selected tree node if affected by reordering (new parent relationship)
* @todo Cancel current form load via ajax when new load is requested (synchronous loading)
* @todo When new edit form is loaded, automatically: Select matching node, set correct parent,
* update icon and title
*/
var treeContainer = $('#sitetree_ul');
treeContainer
.jstree({
@ -94,647 +120,3 @@
});
}(jQuery));
// if(typeof SiteTreeHandlers == 'undefined') SiteTreeHandlers = {};
// SiteTreeHandlers.parentChanged_url = 'admin/ajaxupdateparent';
// SiteTreeHandlers.orderChanged_url = 'admin/ajaxupdatesort';
// SiteTreeHandlers.showRecord_url = 'admin/show/';
// SiteTreeHandlers.controller_url = 'admin';
//
// var _HANDLER_FORMS = {
// addpage : 'Form_AddForm',
// batchactions : 'batchactionsforms',
// search : 'search_options'
// };
//
// (function($) {
// $(window).bind('load', function(e) {
// // behaviour.js load handlers need to be fired before this event, so we artificially delay it
// setTimeout(function() {
// // make sure current ID of loaded form is actually selected in tree
// var tree = $('#sitetree')[0], id = $('#Form_EditForm :input[name=ID]').val();
// if(!id) id = 0;
// if(tree) tree.setCurrentByIdx(id);
// }, 200);
// });
// }(jQuery));
//
// /**
// * Overload this with a real context menu if necessary
// */
// var TreeContextMenu = null;
//
// /**
// * Class: TreeAPI
// *
// * Extra methods for the tree when used in the LHS of the CMS
// */
// TreeAPI = Class.create();
// TreeAPI.prototype = {
//
// setCustomURL: function(url, arguments) {
// this.customURL = url;
// this.customArguments = $H(arguments);
// },
//
// clearCustomURL: function() {
// this.customURL = this.customArguments = null;
// },
//
// url: function(args) {
// var args = $H(args).merge(this.customArguments);
//
// var url = this.customURL ? this.customURL : SiteTreeHandlers.loadTree_url;
// url = url + (url.match(/\?/) ? '&' : '?') + args.toQueryString();
//
// return url;
// },
//
// reload: function(options) {
// this.innerHTML = 'Loading...';
//
// var args = {ajax:1, ID:0};
// if ($('LangSelector')) args.locale = $('LangSelector').value;
//
// var url = this.url(args);
//
// var self = this;
// jQuery.get(
// url,
// function(data, status){
// self.innerHTML = data;
// self.castAsTreeNode(self.firstChild);
// if (options && options.onSuccess) options.onSuccess(data);
// },
// 'html'
// );
// },
//
// /**
// * Perform the given code on the each tree node with the given index.
// * There could be more than one :-)
// * @param idx The index of the tree node
// * @param code A method to be executed, that will be passed the tree node
// */
// performOnTreeNode: function(idx, code) {
// var treeNode = this.getTreeNodeByIdx(idx);
// if(!treeNode) return;
//
// if(treeNode.className.indexOf('manyparents') == -1) {
// code(treeNode);
//
// } else {
// var i,item,allNodes = this.getElementsByTagName('li');
// for(i=0;item=allNodes[i];i++) {
// if(treeNode.id == item.id) code(item);
// }
// }
// },
//
// getTreeNodeByIdx : function(idx) {
// if(!idx) idx = "0";
// var node = document.getElementById('record-' + idx);
// if(idx == "0" && !node) node = document.getElementById('record-root');
// return node;
// },
// getIdxOf : function(treeNode) {
// if(treeNode && treeNode.id && treeNode.id.match(/record-([0-9a-zA-Z\-]+)$/))
// return RegExp.$1;
// },
// createTreeNode : function(idx, title, pageType) {
// var i;
// var node = document.createElement('li');
// node.id = 'record-' + idx;
// node.className = pageType;
//
// var aTag = document.createElement('a');
// aTag.href = SiteTreeHandlers.showRecord_url + idx;
// aTag.title = 'Page type: ' + pageType;
// aTag.innerHTML = title;
// node.appendChild(aTag);
//
// SiteTreeNode.create(node, this.options);
//
// return node;
// },
//
// setNodeIdx : function(idx, newIdx) {
// this.performOnTreeNode(idx, function(treeNode) {
// treeNode.id = 'record-' + newIdx;
// var aTag = treeNode.getElementsByTagName('a')[0];
// aTag.href = aTag.href.replace(idx, newIdx);
// });
//
// var treeNode = this.getTreeNodeByIdx(idx);
// },
//
// setNodeTitle : function(idx, title) {
// this.performOnTreeNode(idx, function(treeNode) {
// var aTag = treeNode.getElementsByTagName('a')[0];
// aTag.innerHTML = title;
// });
// },
//
// setNodeIcon: function(idx, newClassName) {
// this.performOnTreeNode(idx, function(treeNode) {
// treeNode.className = treeNode.className.replace(/(class-)[^\s]*/,'$1' + newClassName);
// treeNode.aSpan.className = 'a ' + treeNode.className.replace('closed','spanClosed');
// var aTag = treeNode.getElementsByTagName('a')[0];
// aTag.title = 'Page type: ' + newClassName;
// treeNode.setIconByClass();
// });
// },
//
// /**
// * Set the parent ID of a tree node
// */
// setNodeParentID: function (idx, parentID) {
// var treeNode = this.getTreeNodeByIdx(idx);
// var parentNode = this.getTreeNodeByIdx(parentID);
// var currentParentNode = jQuery(treeNode).parents('li')[0];
// // Only change parent node if its different than the current,
// // otherwise we affect the sort order unnecessarily due to
// // appendTreeNode() not looking at existing sorts
// if(!currentParentNode || parentNode != currentParentNode) parentNode.appendTreeNode(treeNode);
// },
//
// setCurrentByIdx : function(idx) {
// if(this.selected) {
// var i,item;
// for(i=0;item=this.selected[i];i++) {
// item.removeNodeClass('current');
// }
// }
//
// __tree = this;
// __tree.selected = [];
//
// this.performOnTreeNode(idx, function(treeNode) {
// __tree.selected.push(treeNode);
// treeNode.expose();
// treeNode.addNodeClass('current');
// });
// },
//
// changeCurrentTo : function(newNode) {
// if(this.selected) {
// var i,item;
// for(i=0;item=this.selected[i];i++) {
// item.removeNodeClass('current');
// }
// }
//
// newNode.addNodeClass('current');
//
// this.selected = [newNode];
// newNode.expose();
// },
//
// firstSelected : function() {
// if(this.selected) return this.selected[0];
// }
// };
//
// /**
// * Extra methods for the tree node when used in the LHS of the CMS
// */
// TreeNodeAPI = Class.create();
// TreeNodeAPI.prototype = {
// selectTreeNode : function() {
// var url = jQuery(this).find('a').attr('href');
// if(url && url != '#') {
// jQuery('#sitetree').trigger('selectionchanged', {node: this});
// // don't get page if either event was cancelled,
// // or the tree is currently in a selectable state.
// if($('sitetree').notify('SelectionChanged', this) && !jQuery(this.tree).hasClass('multiselect')) {
// this.getPageFromServer();
// }
// } else {
// jQuery('#Form_EditForm').entwine('ss').removeForm();
// }
// },
//
// getPageFromServer : function() {
// var self = this;
// var xmlhttp = jQuery('#Form_EditForm').entwine('ss').loadForm(
// jQuery(this).find('a').attr('href'),
// function(response) {
// self.removeNodeClass('loading');
//
// var pageID = jQuery(this).find(':input[name=ID]').val();
// jQuery('#sitetree')[0].setCurrentByIdx(pageID);
// }
// );
//
// if(xmlhttp) this.addNodeClass('loading');
// },
// ajaxExpansion : function() {
// this.addNodeClass('loading');
// var ul = this.treeNodeHolder(false);
// ul.innerHTML = 'loading...';
//
// // Any attempts to add children to this page should, in fact, cue them up for insertion later
// ul.cuedNewNodes = [];
// ul.appendTreeNode = function(node) {
// this.cuedNewNodes[this.cuedNewNodes.length] = node;
// }
//
// var args = {ajax:1, ID:this.getIdx()};
//
// // Add current locale for any subtree selection
// if ($('LangSelector')) args.locale = $('LangSelector').value;
//
// // If the tree is selectable, we have to show all available children without
// // artificial limitations from the serverside (minNodeCount). This is a measure
// // to ensure no unexpanded nodes are missed in batch selection
// if(Element.hasClassName('sitetree', 'multiselect')) args.minNodeCount = 0;
//
// url = this.tree.url(args);
//
// new Ajax.Request(url, {
// onSuccess : this.installSubtree.bind(this),
// onFailure : this.showSubtreeLoadingError
// });
// },
// showSubtreeLoadingError: function(response) {
// errorMessage('error loading subtree', response);
// },
//
// /**
// * Context menu
// */
// oncontextmenu: function(event) {
// if(TreeContextMenu) {
// if(!event) event = window.event;
// createContextMenu(event, this, TreeContextMenu);
// Event.stop(event);
// return false;
// }
// },
// duplicatePage: function() {
// // Pass the parent ID to the duplicator, which helps ensure that multi-parent pages are duplicated into the node that the user clicked
// var parentClause = "";
// if(this.parentTreeNode && this.parentTreeNode.getIdx) {
// parentClause = "&parentID=" + this.parentTreeNode.getIdx();
// }
//
// new Ajax.Request(jQuery('base').attr('href') + 'admin/duplicate/' + this.getIdx() + '?ajax=1' + parentClause, {
// method : 'get',
// onSuccess : Ajax.Evaluator,
// onFailure : function(response) {
// errorMessage('Error: ', response);
// }
// });
// },
// duplicatePageWithChildren: function() {
// new Ajax.Request(jQuery('base').attr('href') + 'admin/duplicatewithchildren/' + this.getIdx() + '?ajax=1', {
// method : 'get',
// onSuccess : Ajax.Evaluator,
// onFailure : function(response) {
// errorMessage('Error: ', response);
// }
// });
// }
// }
//
//
//
//
// /**
// * In the case of Tree & DraggableTree, the root tree and the sub-trees all use the same class.
// * In this case, however, SiteTree has a much bigger API and so SiteSubTree is smaller.
// */
// SiteSubTree = Class.extend('Tree').extend('TreeAPI');
// SiteSubTree.prototype = {
// castAsTreeNode: function(li) {
// behaveAs(li, SiteTreeNode, this.options);
// }
// }
//
//
// /**
// * Our SiteTree class extends the tree object with a richer manipulation API.
// * The server will send a piece javascript that uses these functions. In this way, the server
// * has flexibility over its operation, but the Script->HTML interface is kept client-side.
// */
// SiteTree = Class.extend('SiteSubTree');
// SiteTree.prototype = {
// initialize : function() {
// this.Tree.initialize();
//
// /*
// if(!this.tree.selected) this.tree.selected = [];
// var els = this.getElementsByTagName('li');
// for(var i=0;i<els.length;i++) if(els[i].className.indexOf('current') > -1) {
// this.tree.selected.push(els[i]);
// break;
// }
// */
//
// this.observeMethod('SelectionChanged', this.interruptLoading.bind(this) );
//
// jQuery('#Form_EditForm').bind('loadnewpage', this.onLoadNewPage.bind(this));
// },
// destroy: function () {
// if(this.Tree) this.Tree.destroy();
// this.Tree = null;
// this.SiteSubTree = null;
// this.TreeAPI = null;
// this.selected = null;
// },
//
// /**
// * Stop the currently loading node from loading.
// */
// interruptLoading: function( newLoadingNode ) {
// if( this.loadingNode ) this.loadingNode.removeNodeClass('loading');
// this.loadingNode = newLoadingNode;
// },
//
// /**
// * Assumes to be triggered by a form element with the following input fields:
// * ID, ParentID, TreeTitle (or Title), ClassName
// */
// onLoadNewPage: function(e, eventData) {
// // finds a certain value in an array generated by jQuery.serializeArray()
// var findInSerializedArray = function(arr, name) {
// for(var i=0; i<arr.length; i++) {
// if(arr[i].name == name) return arr[i].value;
// };
// return false;
// };
//
// var id = jQuery(e.target.ID).val();
//
// // check if a form with a valid ID exists
// if(id) {
// var parentID = jQuery(e.target.ParentID).val();
//
// // set title (either from TreeTitle or from Title fields)
// // Treetitle has special HTML formatting to denote the status changes.
// var title = jQuery((e.target.TreeTitle) ? e.target.TreeTitle : e.target.Title).val();
// if(title) this.setNodeTitle(id, title);
//
// // update icon (only if it has changed)
// var className = jQuery(e.target.ClassName).val();
// if(className) this.setNodeIcon(id, className);
//
// // check if node exists, might have been created instead
// if(!this.getTreeNodeByIdx(id)) {
// var newNode = $('sitetree').createTreeNode(id, title, className);
// var parentNode = $('sitetree').getTreeNodeByIdx(parentID);
// if(parentNode) parentNode.appendTreeNode(newNode);
// //newNode.selectTreeNode();
// }
//
// // set correct parent (only if it has changed)
// if(parentID) this.setNodeParentID(id, jQuery(e.target.ParentID).val());
//
// // set current tree element
// this.setCurrentByIdx(id);
// } else {
// if(typeof eventData.origData != 'undefined') {
// var node = this.getTreeNodeByIdx(eventData.origData.ID);
// if(node && node.parentTreeNode) node.parentTreeNode.removeTreeNode(node);
// }
// }
//
// }
// }
//
// SiteTreeNode = Class.extend('TreeNode').extend('TreeNodeAPI');
// SiteTreeNode.prototype = {
// initialize: function(options) {
// this.TreeNode.initialize(options);
// if(this.className && this.className.match(/class\-([^\s]*)/)) {
// var klass = RegExp.$1;
// if(typeof siteTreeHints != 'undefined' && siteTreeHints[klass]) {
// this.hints = siteTreeHints[klass];
// this.dropperOptions = {
// accept : (this.hints.allowedChildren && (this.className.indexOf('nochildren') == -1))
// ? this.hints.allowedChildren : 'none'
// };
// }
// }
//
// if(this.className.indexOf('current') > -1) {
// if(!this.tree.selected) this.tree.selected = [];
// this.tree.selected.push(this);
// }
//
// if(!this.hints) this.hints = {}
// },
//
// destroy: function () {
// if(this.TreeNode) this.TreeNode.destroy();
// this.TreeNode = null;
// this.TreeNodeAPI = null;
// },
//
// castAsTree: function(childUL) {
// behaveAs(childUL, SiteSubTree, this.options);
// if(this.draggableObj) childUL.makeDraggable();
// },
//
// onselect: function() {
// this.selectTreeNode();
// return false;
// },
//
//
//
// /**
// * Drag'n'drop handlers - Ajax saving
// */
// onParentChanged : function(node, oldParent, newParent) {
// var self = this;
//
// if(newParent.id.match(/^record-new/)) {
// alert("You must save the page before dragging children into it");
// return false;
// }
//
// if( node == newParent || node.getIdx() == newParent.getIdx() ) {
// alert("You cannot add a page to itself");
// return false;
// }
//
// if(node.innerHTML.toLowerCase().indexOf('<del') > -1) {
// alert("You can't moved deleted pages");
// return false;
// }
//
// if( Element.hasClassName( newParent, 'nochildren' ) ) {
// alert("You can't add children to that node");
// return false;
// }
//
// jQuery.post(
// SiteTreeHandlers.parentChanged_url,
// 'ID=' + node.getIdx() + '&ParentID=' + newParent.getIdx(),
// function(data, status) {
// // TODO This should use a more common serialization in a new tree library
// if(data.modified) {
// for(var id in data.modified) {
// self.tree.setNodeTitle(id, data.modified[id]['TreeTitle']);
// }
// }
//
// // Check if current page still exists, and refresh it.
// // Otherwise remove the current form
// var selectedNode = self.tree.firstSelected();
// if(selectedNode) {
// var selectedNodeId = self.tree.getIdxOf(selectedNode);
// if(data.modified[selectedNode.getIdx()]) {
// // only if the current page was modified
// selectedNode.selectTreeNode();
// }
// }
// },
// 'json'
// );
//
// return true;
// },
//
// /**
// * Called when the tree has been resorted
// * nodeList is a list of all the nodes in the correct rder
// * movedNode is the node that actually got moved to trigger this resorting
// */
// onOrderChanged : function(nodeList, movedNode) {
// var self = this;
//
// var i, parts = Array();
// sort = 0;
//
// for(i=0;i<nodeList.length;i++) {
// if(nodeList[i].getIdx && nodeList[i].getIdx()) {
// parts[parts.length] = 'ID[]=' + nodeList[i].getIdx();
//
// // Ensure that the order of new records is preserved when they are moved THEN saved
// if(
// nodeList[i].id.indexOf("record-new") == 0
// && $('Form_EditForm_ID')
// && ('record-' + $('Form_EditForm_ID').value == nodeList[i].id)
// && $('Form_EditForm_Sort')
// ) {
// $('Form_EditForm_Sort').value = ++sort
// }
// }
// }
//
// if(movedNode.getIdx && movedNode.getIdx()) {
// parts[parts.length] = 'MovedNodeID=' + movedNode.getIdx();
// }
//
// if(parts) {
// jQuery.post(
// SiteTreeHandlers.orderChanged_url,
// parts.join('&'),
// function(data, status) {
// // TODO This should use a more common serialization in a new tree library
// if(data.modified) {
// for(var id in data.modified) {
// self.tree.setNodeTitle(id, data.modified[id]['TreeTitle']);
// }
// }
//
// // Check if current page still exists, and refresh it.
// // Otherwise remove the current form
// var selectedNode = self.tree.firstSelected();
// if(selectedNode) {
// var selectedNodeId = self.tree.getIdxOf(selectedNode);
// if(data.modified[selectedNode.getIdx()]) {
// // only if the current page was modified
// selectedNode.selectTreeNode();
// }
// }
// },
// 'json'
// );
// }
//
// return true;
// }
// }
//
// // Build the site tree
// SiteTree.applyTo('#sitetree');
//
// /**
// * Reorganise action checkbox
// */
// ReorganiseAction = Class.create();
// ReorganiseAction.applyTo('#sortitems');
// ReorganiseAction.prototype = {
// initialize: function () {
// },
//
// onclick : function() {
// if ($('sitetree').isDraggable == false) {
// $('sitetree').makeDraggable();
// } else {
// $('sitetree').stopBeingDraggable();
// }
// }
// }
//
// var _CURRENT_CONTEXT_MENU = null;
//
// /**
// * Create a new context menu
// * @param event The event object
// * @param owner The DOM element that this context-menu was requested from
// * @param menuItems A map of title -> method; context-menu operations to get called
// */
// function createContextMenu(event, owner, menuItems) {
// if(_CURRENT_CONTEXT_MENU) {
// document.body.removeChild(_CURRENT_CONTEXT_MENU);
// _CURRENT_CONTEXT_MENU = null;
// }
//
// var menu = document.createElement("ul");
// menu.className = 'contextMenu';
// menu.style.position = 'absolute';
// menu.style.left = event.clientX + 'px';
// menu.style.top = event.clientY + 'px';
//
// var menuItemName, menuItemTag, menuATag;
// for(menuItemName in menuItems) {
// menuItemTag = document.createElement("li");
//
// menuATag = document.createElement("a");
// menuATag.href = "#";
// menuATag.onclick = menuATag.oncontextmenu = contextmenu_onclick;
// menuATag.innerHTML = menuItemName;
// menuATag.handler = menuItems[menuItemName];
// menuATag.owner = owner;
//
// menuItemTag.appendChild(menuATag);
// menu.appendChild(menuItemTag);
// }
//
// document.body.appendChild(menu);
//
// document.body.onclick = contextmenu_close;
//
// _CURRENT_CONTEXT_MENU = menu;
//
// return menu;
// }
//
// function contextmenu_close() {
// if(_CURRENT_CONTEXT_MENU) {
// document.body.removeChild(_CURRENT_CONTEXT_MENU);
// _CURRENT_CONTEXT_MENU = null;
// }
// }
//
// function contextmenu_onclick() {
// this.handler(this.owner);
// contextmenu_close();
// return false;
// }