diff options
Diffstat (limited to 'webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source')
37 files changed, 2968 insertions, 0 deletions
diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Application.js b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Application.js new file mode 100644 index 0000000000..ac44e36e97 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Application.js @@ -0,0 +1,75 @@ +/* ************************************************************************ + + qooxdoo - the new era of web development + + http://qooxdoo.org + + Copyright: + 2004-2007 1&1 Internet AG, Germany, http://www.1and1.org + + License: + LGPL: http://www.gnu.org/licenses/lgpl.html + EPL: http://www.eclipse.org/org/documents/epl-v10.php + See the LICENSE file in the project's top-level directory for details. + + Authors: + * Til Schneider (til132) + * Sebastian Werner (wpbasti) + * Andreas Ecker (ecker) + * Fabian Jakobs (fjakobs) + +************************************************************************ */ + +/* ************************************************************************ + +#module(apiviewer) +#resource(css:css) +#resource(image:image) +#embed(apiviewer.css/*) + +************************************************************************ */ + +/** + * Your custom application + */ +qx.OO.defineClass("apiviewer.Application", qx.component.AbstractApplication, +function () { + qx.component.AbstractApplication.call(this); +}); + +qx.Settings.setDefault("resourceUri", "./resource"); + + + + + +/* +--------------------------------------------------------------------------- + METHODS +--------------------------------------------------------------------------- +*/ + +qx.Proto.initialize = function(e) +{ + // Define alias for custom resource path + qx.manager.object.AliasManager.getInstance().add("api", qx.Settings.getValueOfClass("apiviewer.Application", "resourceUri")); + + // Reduce log level + qx.log.Logger.ROOT_LOGGER.setMinLevel(qx.log.Logger.LEVEL_WARN); + + // Include CSS file + qx.html.StyleSheet.includeFile(qx.manager.object.AliasManager.getInstance().resolvePath("api/css/apiviewer.css")); +}; + +qx.Proto.main = function(e) +{ + // Initialize the viewer + this.viewer = new apiviewer.Viewer; + this.viewer.addToDocument(); +}; + +qx.Proto.finalize = function(e) +{ + // Finally load the data + this.viewer.load("script/apidata.js"); +}; diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/ClassViewer.js b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/ClassViewer.js new file mode 100755 index 0000000000..083b558fa3 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/ClassViewer.js @@ -0,0 +1,1684 @@ +/* ************************************************************************ + + qooxdoo - the new era of web development + + http://qooxdoo.org + + Copyright: + 2004-2007 1&1 Internet AG, Germany, http://www.1and1.org + + License: + LGPL: http://www.gnu.org/licenses/lgpl.html + EPL: http://www.eclipse.org/org/documents/epl-v10.php + See the LICENSE file in the project's top-level directory for details. + + Authors: + * Til Schneider (til132) + * Sebastian Werner (wpbasti) + * Andreas Ecker (ecker) + * Fabian Jakobs (fjakobs) + +************************************************************************ */ + +/* ************************************************************************ + +#module(apiviewer) + +************************************************************************ */ + +/** + * Shows the class details. + */ +qx.OO.defineClass("apiviewer.ClassViewer", qx.ui.embed.HtmlEmbed, +function() { + qx.ui.embed.HtmlEmbed.call(this); + + this.setOverflow("auto"); + this.setPadding(20); + this.setEdge(0); + this.setHtmlProperty("id", "ClassViewer"); + this.setVisibility(false); + + apiviewer.ClassViewer.instance = this; +}); + + +qx.Proto._fixLinks = function(el) +{ + var a = el.getElementsByTagName("a"); + for (var i=0; i<a.length; i++) + { + if (typeof a[i].href == "string" && a[i].href.indexOf("http://") == 0) { + a[i].target = "_blank"; + } + } +} + +/** + * Initializes the content of the embedding DIV. Will be called by the + * HtmlEmbed element initialization routine. + */ +qx.Proto._syncHtml = function() +{ + var ClassViewer = apiviewer.ClassViewer; + + document._detailViewer = this; + + this._infoPanelHash = {}; + + var html = ""; + + // Add title + html += '<h1></h1>'; + + // Add description + html += ClassViewer.DIV_START + ClassViewer.DIV_END; + + html += '<div id="ControlFrame">'; + html += '<input type="checkbox" id="showInherited" onclick="document._detailViewer._onInheritedCheckBoxClick()"/><label for="showInherited">Show Inherited</label>'; + html += ' '; + html += '<input type="checkbox" id="showProtected" onclick="document._detailViewer._onProtectedCheckBoxClick()"/><label for="showProtected">Show Protected</label>'; + html += '</div>'; + + + + // BASICS + + // Add constructor info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_CONSTRUCTOR, + "constructor", "constructor", this._createMethodInfo, + this._methodHasDetails, false, true); + + // Add event info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_EVENT, + "events", "events", this._createEventInfo, + this._eventHasDetails, true, true); + + // Add properties info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_PROPERTY, + "properties", "properties", this._createPropertyInfo, + qx.lang.Function.returnTrue, true, true); + + + + // PUBLIC + + // Add methods info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_METHOD, + "methods", "methods", this._createMethodInfo, + this._methodHasDetails, true, true); + + // Add static methods info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_METHOD_STATIC, + "methods-static", "static methods", this._createMethodInfo, + this._methodHasDetails, false, true); + + // Add constants info + html += this._createInfoPanel(ClassViewer.NODE_TYPE_CONSTANT, + "constants", "constants", this._createConstantInfo, + this._constantHasDetails, false, true); + + + + + // Set the html + // doc.body.innerHTML = html; + this.getElement().innerHTML = html; + this._fixLinks(this.getElement()); + + // Extract the main elements + var divArr = this.getElement().childNodes; + this._titleElem = divArr[0]; + this._classDescElem = divArr[1]; + this._controlFrame = divArr[2]; + + this._infoPanelHash[ClassViewer.NODE_TYPE_CONSTRUCTOR].infoElem = divArr[3]; + this._infoPanelHash[ClassViewer.NODE_TYPE_EVENT].infoElem = divArr[4]; + this._infoPanelHash[ClassViewer.NODE_TYPE_PROPERTY].infoElem = divArr[5]; + this._infoPanelHash[ClassViewer.NODE_TYPE_METHOD].infoElem = divArr[6]; + this._infoPanelHash[ClassViewer.NODE_TYPE_METHOD_STATIC].infoElem = divArr[7]; + this._infoPanelHash[ClassViewer.NODE_TYPE_CONSTANT].infoElem = divArr[8]; + + // Get the child elements + for (var nodeType in this._infoPanelHash) + { + var typeInfo = this._infoPanelHash[nodeType]; + typeInfo.infoTitleElem = typeInfo.infoElem.firstChild; + typeInfo.infoBodyElem = typeInfo.infoElem.lastChild; + } + + // Update the view + if (this._currentClassDocNode) + { + // NOTE: We have to set this._currentClassDocNode to null beore, because + // otherwise showClass thinks, there's nothing to do + var classDocNode = this._currentClassDocNode; + this._currentClassDocNode = null; + this.showClass(classDocNode); + } +} + + +/** + * Creates an info panel. An info panel shows the information about one item + * type (e.g. for public methods). + * + * @param nodeType {Integer} the node type to create the info panel for. + * @param listName {String} the name of the node list in the class doc node where + * the items shown by this info panel are stored. + * @param labelText {String} the label text describing the node type. + * @param infoFactory {function} the factory method creating the HTML for one + * item. + * @param hasDetailDecider {function} a function returning <code>true</code> + * when a item has details. + * @param addInheritedCheckBox {Boolean} whether to add a "show inherited ..." + * checkbox. + * @param isOpen {Boolean} whether the info panel is open by default. + * @return {String} the HTML for the info panel. + */ +qx.Proto._createInfoPanel = function(nodeType, listName, labelText, infoFactory, + hasDetailDecider, addInheritedCheckBox, isOpen) +{ + var uppercaseLabelText = labelText.charAt(0).toUpperCase() + labelText.substring(1); + + typeInfo = { listName:listName, labelText:labelText, infoFactory:infoFactory, + hasDetailDecider:hasDetailDecider, isOpen:isOpen, + hasInheritedCheckBox:addInheritedCheckBox }; + this._infoPanelHash[nodeType] = typeInfo; + + var html = '<div class="infoPanel"><h2>'; + + html += '<img class="openclose" src="' + + qx.manager.object.AliasManager.getInstance().resolvePath('api/image/' + (isOpen ? 'close.gif' : 'open.gif')) + '"' + + " onclick=\"document._detailViewer._onShowInfoPanelBodyClicked(" + nodeType + ")\"/> " + + '<span ' + + " onclick=\"document._detailViewer._onShowInfoPanelBodyClicked(" + nodeType + ")\">" + + uppercaseLabelText + + '</span>'; + + html += '</h2><div></div></div>'; + + return html; +} + + +/** + * Shows the information about a class. + * + * @param classNode {Map} the doc node of the class to show. + */ +qx.Proto.showClass = function(classNode) { + if (this._currentClassDocNode == classNode) { + // Nothing to do + return; + } + + this._currentClassDocNode = classNode; + + if (!this._titleElem) { + // _initContentDocument was not called yet + // -> Do nothing, the class will be shown in _initContentDocument. + return; + } + + var ClassViewer = apiviewer.ClassViewer; + + var titleHtml = ""; + + titleHtml += '<div class="packageName">' + classNode.attributes.packageName + '</div>'; + + titleHtml += '<span class="typeInfo">'; + + if (classNode.attributes.isAbstract) { + titleHtml += "Abstract "; + } else if (classNode.attributes.isStatic) { + titleHtml += "Static "; + } + + titleHtml += "Class "; + titleHtml += '</span>'; + titleHtml += classNode.attributes.name; + + this._titleElem.innerHTML = titleHtml; + + var classHtml = ""; + + // Add the class description + var descNode = apiviewer.TreeUtil.getChild(classNode, "desc"); + if (descNode) { + var desc = descNode.attributes.text; + + if (desc != "") + { + classHtml += '<div class="classDescription">' + this._createDescriptionHtml(desc, classNode) + '</div>'; + classHtml += "<br/>"; + } + } + + + // Create the class hierarchy + classHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Inheritance hierarchy:" + ClassViewer.DIV_END; + + var classHierarchy = []; + var currClass = classNode; + while (currClass != null) { + classHierarchy.push(currClass); + currClass = this._getClassDocNode(currClass.attributes.superClass); + } + this._currentClassHierarchy = classHierarchy; + + // Add the class hierarchy + classHtml += ClassViewer.createImageHtml("api/image/class18.gif") + "Object<br/>"; + var indent = 0; + for (var i = classHierarchy.length - 1; i >= 0; i--) { + classHtml += ClassViewer.createImageHtml("api/image/nextlevel.gif", null, "margin-left:" + indent + "px") + + ClassViewer.createImageHtml(apiviewer.TreeUtil.getIconUrl(classHierarchy[i])); + if (i != 0) { + classHtml += this._createItemLinkHtml(classHierarchy[i].attributes.fullName, null, false); + } else { + classHtml += classHierarchy[i].attributes.fullName; + } + classHtml += "<br/>"; + indent += 18; + } + + classHtml += '<br/>'; + + // Add child classes + if (classNode.attributes.childClasses) { + classHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Direct subclasses:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT; + + var classNameArr = classNode.attributes.childClasses.split(","); + for (var i = 0; i < classNameArr.length; i++) { + if (i != 0) { + classHtml += ", "; + } + classHtml += this._createItemLinkHtml(classNameArr[i], null, true, false); + } + + classHtml += ClassViewer.DIV_END; + classHtml += '<br/>'; + } + + // Add @see attributes + var ctorList = apiviewer.TreeUtil.getChild(classNode, "constructor"); + if (ctorList) { + classHtml += this._createSeeAlsoHtml(ctorList.children[0], classNode); + classHtml += '<br/>'; + } + + this._classDescElem.innerHTML = classHtml; + this._fixLinks(this._classDescElem); + + // Refresh the info viewers + this._updateInfoViewers(); + + // Scroll to top + this.getElement().scrollTop = 0; +} + +qx.Proto._updateInfoViewers = function() +{ + for (var nodeType in this._infoPanelHash) { + this._updateInfoPanel(parseInt(nodeType)); + } +} + +qx.Proto.showInfo = function(classNode) { + if (this._currentClassDocNode == classNode) { + // Nothing to do + return; + } + + this._currentClassDocNode = classNode; + + if (!this._titleElem) { + // _initContentDocument was not called yet + // -> Do nothing, the class will be shown in _initContentDocument. + return; + } + + var ClassViewer = apiviewer.ClassViewer; + + this._titleElem.innerHTML = "Info View"; + this._classDescElem.innerHTML = ""; + + // Scroll to top + this.getElement().scrollTop = 0; +} + +/** + * Highlights an item (property, method or constant) and scrolls it visible. + * + * @param itemName {String} the name of the item to highlight. + */ +qx.Proto.showItem = function(itemName) { + var itemNode = apiviewer.TreeUtil.getItemDocNode(this._currentClassDocNode, itemName); + if (! itemNode) { + alert("Item '" + itemName + "' not found"); + } + + var nodeType = this._getTypeForItemNode(itemNode); + var elem = this._getItemElement(nodeType, itemNode.attributes.name).parentNode.parentNode; + + // Handle mark + if (this._markedElement) { + this._markedElement.className = ""; + } + + elem.className = "marked"; + this._markedElement = elem; + + // Scroll the element visible + var top = qx.html.Location.getPageBoxTop(elem); + var height = elem.offsetHeight; + + var doc = this.getElement(); + var scrollTop = doc.scrollTop; + var clientHeight = doc.offsetHeight; + + if (scrollTop > top) { + doc.scrollTop = top; + } else if (scrollTop < top + height - clientHeight) { + doc.scrollTop = top + height - clientHeight; + } +} + +qx.Proto._showProtected = false; +qx.Proto._showInherited = false; + +/** + * Updates an info panel. + * + * @param nodeType {Integer} the node type of which to update the info panel. + */ +qx.Proto._updateInfoPanel = function(nodeType) +{ + var ClassViewer = apiviewer.ClassViewer; + + var typeInfo = this._infoPanelHash[nodeType]; + + // Get the nodes to show + var nodeArr = []; + var fromClassHash = null; + + if (this._currentClassDocNode) + { + if (this._showInherited && (nodeType == apiviewer.ClassViewer.NODE_TYPE_EVENT || nodeType == apiviewer.ClassViewer.NODE_TYPE_PROPERTY || nodeType == apiviewer.ClassViewer.NODE_TYPE_METHOD)) + { + fromClassArr = []; + fromClassHash = {}; + + var currClassNode = this._currentClassDocNode; + + while (currClassNode != null) + { + var currParentNode = apiviewer.TreeUtil.getChild(currClassNode, typeInfo.listName); + var currNodeArr = currParentNode ? currParentNode.children : null; + if (currNodeArr) + { + // Add the nodes from this class + for (var i = 0; i < currNodeArr.length; i++) + { + var name = currNodeArr[i].attributes.name; + + if (fromClassHash[name] == null) + { + fromClassHash[name] = currClassNode; + nodeArr.push(currNodeArr[i]); + } + } + } + + var superClassName = currClassNode.attributes.superClass; + currClassNode = superClassName ? this._getClassDocNode(superClassName) : null; + } + } + else + { + var parentNode = apiviewer.TreeUtil.getChild(this._currentClassDocNode, typeInfo.listName); + nodeArr = parentNode ? parentNode.children : null; + } + } + + if (nodeArr) + { + // Filter protected + if (nodeType == apiviewer.ClassViewer.NODE_TYPE_METHOD || nodeType == apiviewer.ClassViewer.NODE_TYPE_METHOD_STATIC) + { + if (nodeArr.length != 0 && !this._showProtected) + { + copyArr = nodeArr.concat(); + + for (var i=nodeArr.length-1; i>=0; i--) + { + var node = nodeArr[i]; + + if (nodeArr[i].attributes.name.charAt(0) == "_") { + qx.lang.Array.removeAt(copyArr, i); + } + } + + nodeArr = copyArr; + } + } + + // Sort the nodeArr by name + // Move protected methods to the end + nodeArr.sort(function(obj1, obj2) + { + var n1 = obj1.attributes.name; + var n2 = obj2.attributes.name; + var p1 = n1.charAt(0) == "_"; + var p2 = n2.charAt(0) == "_"; + var h1 = n1.charAt(0) == "__"; + var h2 = n2.charAt(0) == "__"; + + if (p1 == p2 && h1 == h2) + { + return n1.toLowerCase() < n2.toLowerCase() ? -1 : 1; + } + else + { + return h1 ? 1 : p1 ? 1 : -1; + } + }); + } + + // Show the nodes + if (nodeArr && nodeArr.length > 0) + { + var html = '<table cellspacing="0" cellpadding="0" class="info" width="100%">'; + + for (var i = 0; i < nodeArr.length; i++) + { + var node = nodeArr[i]; + + var fromClassNode = fromClassHash ? fromClassHash[node.attributes.name] : null; + if (fromClassNode == null) { + fromClassNode = this._currentClassDocNode; + } + + var info = typeInfo.infoFactory.call(this, node, nodeType, fromClassNode, false); + var inherited = fromClassNode && (fromClassNode != this._currentClassDocNode); + var iconUrl = apiviewer.TreeUtil.getIconUrl(node, inherited, "_updateInfoPanel"); + + // Create the title row + html += '<tr>'; + + html += '<td class="icon">' + ClassViewer.createImageHtml(iconUrl) + '</td>'; + html += '<td class="type">' + ((info.typeHtml.length != 0) ? (info.typeHtml + " ") : "") + '</td>'; + + html += '<td class="toggle">'; + if (typeInfo.hasDetailDecider.call(this, node, nodeType, fromClassNode)) + { + // This node has details -> Show the detail button + html += '<img src="' + qx.manager.object.AliasManager.getInstance().resolvePath("api/image/open.gif") + '"' + + " onclick=\"document._detailViewer._onShowItemDetailClicked(" + nodeType + ",'" + + node.attributes.name + "'" + + ((fromClassNode != this._currentClassDocNode) ? ",'" + fromClassNode.attributes.fullName + "'" : "") + + ")\"/>"; + } + else + { + html += " "; + } + html += '</td>'; + + html += '<td class="text">'; + + // Create headline + html += '<h3'; + + if (typeInfo.hasDetailDecider.call(this, node, nodeType, fromClassNode)) + { + html += " onclick=\"document._detailViewer._onShowItemDetailClicked(" + nodeType + ",'" + + node.attributes.name + "'" + + ((fromClassNode != this._currentClassDocNode) ? ",'" + fromClassNode.attributes.fullName + "'" : "") + + ")\">"; + } + else + { + html += '>'; + } + + html += info.titleHtml; + html += '</h3>'; + + // Create content area + html += '<div _itemName="' + nodeArr[i].attributes.name + '">'; + html += info.textHtml; + html += '</div>'; + + html += '</td>'; + html += '</tr>'; + } + + html += '</table>'; + + typeInfo.infoBodyElem.innerHTML = html; + this._fixLinks(typeInfo.infoBodyElem); + typeInfo.infoBodyElem.style.display = !typeInfo.isOpen ? "none" : ""; + typeInfo.infoElem.style.display = ""; + } + else + { + typeInfo.infoElem.style.display = "none"; + } +} + + +/** + * Event handler. Called when the user clicked a button for showing/hiding the + * details of an item. + * + * @param nodeType {Integer} the node type of the item to show/hide the details. + * @param name {String} the name of the item. + * @param fromClassName {String} the name of the class the item the item was + * defined in. + */ +qx.Proto._onShowItemDetailClicked = function(nodeType, name, fromClassName) { + try { + var typeInfo = this._infoPanelHash[nodeType]; + var textDiv = this._getItemElement(nodeType, name); + + if (!textDiv) { + throw Error("Element for name '" + name + "' not found!"); + } + + var showDetails = textDiv._showDetails ? !textDiv._showDetails : true; + textDiv._showDetails = showDetails; + + var fromClassNode = this._currentClassDocNode; + if (fromClassName) { + fromClassNode = this._getClassDocNode(fromClassName); + } + + var listNode = apiviewer.TreeUtil.getChild(fromClassNode, typeInfo.listName); + var node; + if (nodeType == apiviewer.ClassViewer.NODE_TYPE_CONSTRUCTOR) { + node = listNode.children[0]; + } else { + node = apiviewer.TreeUtil.getChildByAttribute(listNode, "name", name); + } + + // Update the close/open image + var opencloseImgElem = textDiv.parentNode.previousSibling.firstChild; + opencloseImgElem.src = qx.manager.object.AliasManager.getInstance().resolvePath(showDetails ? 'api/image/close.gif' : 'api/image/open.gif'); + + // Update content + var info = typeInfo.infoFactory.call(this, node, nodeType, fromClassNode, showDetails); + textDiv.innerHTML = info.textHtml; + this._fixLinks(textDiv); + } catch (exc) { + this.error("Toggling item details failed", exc); + } +} + + +/** + * Event handler. Called when the user clicked on the "show inherited ..." checkbox. + */ +qx.Proto._onInheritedCheckBoxClick = function() +{ + this._showInherited = document.getElementById("showInherited").checked; + this._updateInfoViewers(); +} + +/** + * Event handler. Called when the user clicked on the "show protected ..." checkbox. + */ +qx.Proto._onProtectedCheckBoxClick = function() +{ + this._showProtected = document.getElementById("showProtected").checked; + this._updateInfoViewers(); +} + + +/** + * Event handler. Called when the user clicked a button for showing/hiding the + * body of an info panel. + * + * @param nodeType {Integer} the node type of which the show/hide-body-button was + * clicked. + */ +qx.Proto._onShowInfoPanelBodyClicked = function(nodeType) { + try { + var typeInfo = this._infoPanelHash[nodeType]; + typeInfo.isOpen = !typeInfo.isOpen; + + var imgElem = typeInfo.infoTitleElem.getElementsByTagName("img")[0]; + imgElem.src = qx.manager.object.AliasManager.getInstance().resolvePath(typeInfo.isOpen ? 'api/image/close.gif' : 'api/image/open.gif'); + + this._updateInfoPanel(nodeType); + } catch (exc) { + this.error("Toggling info body failed", exc); + } +} + + +/** + * Gets the HTML element showing the details of an item. + * + * @param nodeType {Integer} the node type of the item. + * @param name {String} the item's name. + * @return {Element} the HTML element showing the details of the item. + */ +qx.Proto._getItemElement = function(nodeType, name) { + var typeInfo = this._infoPanelHash[nodeType]; + var elemArr = typeInfo.infoBodyElem.getElementsByTagName("TBODY")[0].childNodes; + + for (var i = 0; i < elemArr.length; i++) { + // ARRG, should be implemented in a more fault-tolerant way + // iterate over tr's, look inside the third "td" and there the second element + if (elemArr[i].childNodes[3].childNodes[1].getAttribute("_itemName") == name) { + return elemArr[i].childNodes[3].childNodes[1]; + } + } +} + + +/** + * Selects an item. + * + * @param itemName {String} the name of the item. + * @see ApiViewer#selectItem + */ +qx.Proto._selectItem = function(itemName) { + try { + apiviewer.Viewer.instance.selectItem(itemName); + qx.ui.core.Widget.flushGlobalQueues(); + } catch (exc) { + this.error("Selecting item '" + itemName + "' failed", exc); + } +} + + +/** + * Gets the doc node of a class. + * + * @param className {String} the name of the class. + * @return {Map} the doc node of the class. + */ +qx.Proto._getClassDocNode = function(className) { + if (className) { + return apiviewer.TreeUtil.getClassDocNode(apiviewer.Viewer.instance.getDocTree(), className); + } else { + return null; + } +} + + +/** + * Creates the HTML showing the information about a property. + * + * @param node {Map} the doc node of the property. + * @param nodeType {Integer} the node type of the property. + * @param fromClassNode {Map} the doc node of the class the property was defined. + * @param showDetails {Boolean} whether to show the details. + * @return {String} the HTML showing the information about the property. + */ +qx.Proto._createPropertyInfo = function(node, nodeType, fromClassNode, showDetails) { + var ClassViewer = apiviewer.ClassViewer; + + var info = {} + + var typeInfo = this._infoPanelHash[nodeType]; + + // Get the property node that holds the documentation + var docClassNode = fromClassNode; + var docNode = node; + if (node.attributes.docFrom) { + docClassNode = this._getClassDocNode(node.attributes.docFrom); + var listNode = apiviewer.TreeUtil.getChild(docClassNode, typeInfo.listName); + docNode = apiviewer.TreeUtil.getChildByAttribute(listNode, "name", node.attributes.name); + } + + // Add the title + info.typeHtml = this._createTypeHtml(node, fromClassNode, "var"); + info.titleHtml = node.attributes.name; + + // Add the description + info.textHtml = this._createDescHtml(docNode, fromClassNode, showDetails); + + if (showDetails) { + // Add allowed values + var allowedValue = null; + if (node.attributes.possibleValues) { + allowedValue = node.attributes.possibleValues; + } else if (node.attributes.classname) { + allowedValue = "instances of " + node.attributes.classname; + } else if (node.attributes.instance) { + allowedValue = "instances of " + node.attributes.instance + " or sub classes"; + } else if (node.attributes.unitDetection) { + allowedValue = "units: " + node.attributes.unitDetection; + } else if (node.attributes.type) { + allowedValue = "any " + node.attributes.type; + } + + if (allowedValue) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Allowed values:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT; + + if (node.attributes.allowNull != "false") { + info.textHtml += "null, "; + } + info.textHtml += allowedValue + ClassViewer.DIV_END; + } + + // Add default value + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Default value:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + (node.attributes.defaultValue ? node.attributes.defaultValue : "null") + + ClassViewer.DIV_END; + + // Add get alias + if (node.attributes.getAlias) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Get alias:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + node.attributes.getAlias + ClassViewer.DIV_END; + } + + // Add set alias + if (node.attributes.setAlias) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Set alias:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + node.attributes.setAlias + ClassViewer.DIV_END; + } + + // Add inherited from or overridden from + if (fromClassNode && fromClassNode != this._currentClassDocNode) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Inherited from:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createItemLinkHtml(fromClassNode.attributes.fullName) + + ClassViewer.DIV_END; + } else if (node.attributes.overriddenFrom) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Overridden from:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createItemLinkHtml(node.attributes.overriddenFrom) + + ClassViewer.DIV_END; + } + + // Add @see attributes + info.textHtml += this._createSeeAlsoHtml(docNode, docClassNode); + + // Add documentation errors + info.textHtml += this._createErrorHtml(docNode, docClassNode); + } + + return info; +} + + +/** + * Checks whether an event has details. + * + * @param node {Map} the doc node of the event. + * @param nodeType {Integer} the node type of the event. + * @param fromClassNode {Map} the doc node of the class the event was defined. + * @return {Boolean} whether the event has details. + */ +qx.Proto._eventHasDetails = function(node, nodeType, fromClassNode) { + return (fromClassNode != this._currentClassDocNode) // event is inherited + || this._hasSeeAlsoHtml(node) + || this._hasErrorHtml(node) + || this._descHasDetails(node); +}; + + +/** + * Creates the HTML showing the information about an event. + * + * @param node {Map} the doc node of the event. + * @param nodeType {Integer} the node type of the event. + * @param fromClassNode {Map} the doc node of the class the event was defined. + * @param showDetails {Boolean} whether to show the details. + * @return {String} the HTML showing the information about the event. + */ +qx.Proto._createEventInfo = function(node, nodeType, fromClassNode, showDetails) { + var ClassViewer = apiviewer.ClassViewer; + + var info = {} + + var typeInfo = this._infoPanelHash[nodeType]; + + // Add the title + info.typeHtml = this._createTypeHtml(node, fromClassNode, "var"); + info.titleHtml = node.attributes.name; + + // Add the description + info.textHtml = this._createDescHtml(node, fromClassNode, showDetails); + + if (showDetails) { + // Add inherited from or overridden from + if (fromClassNode && fromClassNode != this._currentClassDocNode) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Inherited from:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createItemLinkHtml(fromClassNode.attributes.fullName) + + ClassViewer.DIV_END; + } + + // Add @see attributes + info.textHtml += this._createSeeAlsoHtml(node, fromClassNode); + + // Add documentation errors + info.textHtml += this._createErrorHtml(node, fromClassNode); + } + + return info; +}; + + +/** + * Checks whether a method has details. + * + * @param node {Map} the doc node of the method. + * @param nodeType {Integer} the node type of the method. + * @param fromClassNode {Map} the doc node of the class the method was defined. + * @return {Boolean} whether the method has details. + */ +qx.Proto._methodHasDetails = function(node, nodeType, fromClassNode) { + var TreeUtil = apiviewer.TreeUtil; + + var typeInfo = this._infoPanelHash[nodeType]; + + // Get the method node that holds the documentation + var docClassNode = fromClassNode; + var docNode = node; + if (node.attributes.docFrom) { + docClassNode = this._getClassDocNode(node.attributes.docFrom); + var listNode = TreeUtil.getChild(docClassNode, typeInfo.listName); + docNode = TreeUtil.getChildByAttribute(listNode, "name", node.attributes.name); + } + + // Check whether there are details + var hasParams = TreeUtil.getChild(docNode, "params") != null; + var hasReturn = TreeUtil.getChild(docNode, "return") != null; + var isOverridden = fromClassNode != this._currentClassDocNode; + + return (fromClassNode != this._currentClassDocNode) // method is inherited + || (node.attributes.overriddenFrom != null) // method is overridden + || (TreeUtil.getChild(docNode, "params") != null) // method has params + || (TreeUtil.getChild(docNode, "return") != null) // method has return value + || this._hasSeeAlsoHtml(docNode) + || this._hasErrorHtml(docNode) + || this._descHasDetails(docNode); +} + + +/** + * Creates the HTML showing the information about a method. + * + * @param node {Map} the doc node of the method. + * @param nodeType {Integer} the node type of the method. + * @param fromClassNode {Map} the doc node of the class the method was defined. + * @param showDetails {Boolean} whether to show the details. + * @return {String} the HTML showing the information about the method. + */ +qx.Proto._createMethodInfo = function(node, nodeType, fromClassNode, showDetails) { + var ClassViewer = apiviewer.ClassViewer; + var TreeUtil = apiviewer.TreeUtil; + + var info = {} + + var typeInfo = this._infoPanelHash[nodeType]; + + // Get the method node that holds the documentation + var docClassNode = fromClassNode; + var docNode = node; + if (node.attributes.docFrom) { + docClassNode = this._getClassDocNode(node.attributes.docFrom); + var listNode = TreeUtil.getChild(docClassNode, typeInfo.listName); + docNode = TreeUtil.getChildByAttribute(listNode, "name", node.attributes.name); + } + + if (node.attributes.isAbstract) { + info.typeHtml = "abstract "; + } else { + info.typeHtml = ""; + } + + // Get name, icon and return type + var returnNode = TreeUtil.getChild(docNode, "return"); + if (node.attributes.isCtor) { + info.titleHtml = fromClassNode.attributes.name; + } else { + info.titleHtml = node.attributes.name; + info.typeHtml += this._createTypeHtml(returnNode, fromClassNode, "void"); + } + + // Add the title (the method signature) + info.titleHtml += '<span class="methodSignature"> <span class="parenthesis">(</span>'; + var paramsNode = TreeUtil.getChild(docNode, "params"); + if (paramsNode) { + for (var i = 0; i < paramsNode.children.length; i++) { + var param = paramsNode.children[i]; + if (i != 0) { + info.titleHtml += '<span class="separator">,</span> '; + } + info.titleHtml += '<span class="parameterType">' + this._createTypeHtml(param, fromClassNode, "var") + "</span> " + + param.attributes.name; + if (param.attributes.defaultValue) { + info.titleHtml += "?"; + } + } + } + info.titleHtml += '<span class="parenthesis">)</span></span>'; + + // Add the description + if (node.attributes.isCtor) { + info.textHtml = "Creates a new instance of " + fromClassNode.attributes.name + "."; + } else { + info.textHtml = this._createDescHtml(docNode, docClassNode, showDetails); + } + + + if (showDetails) { + // Add Parameters + var paramsNode = TreeUtil.getChild(docNode, "params"); + if (paramsNode) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Parameters:" + ClassViewer.DIV_END; + for (var i = 0; i < paramsNode.children.length; i++) { + var param = paramsNode.children[i]; + var paramType = param.attributes.type ? param.attributes.type : "var"; + var dims = param.attributes.arrayDimensions; + if (dims) { + for (var i = 0; i < dims; i++) { + paramType += "[]"; + } + } + var defaultValue = param.attributes.defaultValue; + + info.textHtml += ClassViewer.DIV_START_DETAIL_TEXT; + if (defaultValue) { + info.textHtml += ClassViewer.SPAN_START_OPTIONAL; + } + info.textHtml += ClassViewer.SPAN_START_PARAM_NAME + param.attributes.name + ClassViewer.SPAN_END; + if (defaultValue) { + info.textHtml += " (default: " + defaultValue + ") " + ClassViewer.SPAN_END; + } + + var paramDescNode = TreeUtil.getChild(param, "desc"); + if (paramDescNode) { + info.textHtml += " " + this._createDescriptionHtml(paramDescNode.attributes.text, docClassNode); + } + info.textHtml += ClassViewer.DIV_END; + } + } + + // Add return value + if (returnNode) { + var returnDescNode = TreeUtil.getChild(returnNode, "desc"); + if (returnDescNode) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Returns:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createDescriptionHtml(returnDescNode.attributes.text, docClassNode) + + ClassViewer.DIV_END; + } + } + + // Add inherited from or overridden from + if (fromClassNode && fromClassNode != this._currentClassDocNode) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Inherited from:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createItemLinkHtml(fromClassNode.attributes.fullName) + + ClassViewer.DIV_END; + } else if (node.attributes.overriddenFrom) { + info.textHtml += ClassViewer.DIV_START_DETAIL_HEADLINE + "Overridden from:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + + this._createItemLinkHtml(node.attributes.overriddenFrom) + + ClassViewer.DIV_END; + } + + // Add @see attributes + info.textHtml += this._createSeeAlsoHtml(docNode, docClassNode); + + // Add documentation errors + info.textHtml += this._createErrorHtml(docNode, docClassNode); + } + + return info; +} + + +/** + * Checks whether a constant has details. + * + * @param node {Map} the doc node of the constant. + * @param nodeType {Integer} the node type of the constant. + * @param fromClassNode {Map} the doc node of the class the constant was defined. + * @return {Boolean} whether the constant has details. + */ +qx.Proto._constantHasDetails = function(node, nodeType, fromClassNode) { + return ( + this._hasSeeAlsoHtml(node) || + this._hasErrorHtml(node) || + this._descHasDetails(node) || + this._hasConstantValueHtml(node) + ); +} + + +/** + * Creates the HTML showing the information about a constant. + * + * @param node {Map} the doc node of the constant. + * @param nodeType {Integer} the node type of the constant. + * @param fromClassNode {Map} the doc node of the class the constant was defined. + * @param showDetails {Boolean} whether to show the details. + * @return {String} the HTML showing the information about the constant. + */ +qx.Proto._createConstantInfo = function(node, nodeType, fromClassNode, showDetails) { + var info = {} + + // Add the title + info.typeHtml = this._createTypeHtml(node, fromClassNode, "var"); + info.titleHtml = node.attributes.name; + + // Add the description + info.textHtml = this._createDescHtml(node, fromClassNode, showDetails); + + if (showDetails) { + info.textHtml += this._createConstantValueHtml(node, fromClassNode); + + // Add @see attributes + info.textHtml += this._createSeeAlsoHtml(node, fromClassNode); + + // Add documentation errors + info.textHtml += this._createErrorHtml(node, fromClassNode); + + } + + return info; +} + + +/** + * Returns whether the description of an item has details (has more than one + * sentence). + * + * @param node {Map} the doc node of the item. + * @return {Boolean} whether the description of an item has details. + */ +qx.Proto._descHasDetails = function(node) { + var descNode = apiviewer.TreeUtil.getChild(node, "desc"); + if (descNode) { + var desc = descNode.attributes.text; + return this._extractFirstSentence(desc) != desc; + } else { + return false; + } +} + + +/** + * Creates the HTML showing the description of an item. + * + * @param node {Map} the doc node of the item. + * @param fromClassNode {Map} the doc node of the class the item was defined. + * @param showDetails {Boolean} whether to show details. If <code>false</code> + * only the first sentence of the description will be shown. + * @return {String} the HTML showing the description. + */ +qx.Proto._createDescHtml = function(node, fromClassNode, showDetails) { + var descNode = apiviewer.TreeUtil.getChild(node, "desc"); + if (descNode) { + var desc = descNode.attributes.text; + if (!showDetails) { + desc = this._extractFirstSentence(desc); + } + return apiviewer.ClassViewer.DIV_START_DESC + + this._createDescriptionHtml(desc, fromClassNode) + + apiviewer.ClassViewer.DIV_END; + } else { + return ""; + } +} + + +/** + * Extracts the first sentence from a text. + * + * @param text {String} the text. + * @return {String} the first sentence from the text. + */ +qx.Proto._extractFirstSentence = function(text) +{ + var ret = text; + + // Extract first block + var pos = ret.indexOf("</p>"); + if (pos != -1) + { + ret = ret.substr(0, pos+4); + + var hit = apiviewer.ClassViewer.SENTENCE_END_REGEX.exec(ret); + if (hit != null) { + ret = text.substring(0, hit.index + hit[0].length - 1) + "</p>"; + } + } + + return ret; +} + + +/** + * Checks whether a constant value is provided + * + * @param node {Map} the doc node of the item. + * @return {Boolean} whether the constant provides a value + */ +qx.Proto._hasConstantValueHtml = function(node) { + return node.attributes.value ? true : false; +} + + +/** + * Creates the HTML showing the value of a constant + * + * @param node {Map} the doc node of the item. + * @param fromClassNode {Map} the doc node of the class the item was defined. + * @return {String} the HTML showing the value of the constant + */ +qx.Proto._createConstantValueHtml = function(node, fromClassNode) { + var ClassViewer = apiviewer.ClassViewer; + this.debug (node.attributes.value) + if (this._hasConstantValueHtml(node)) { + return ( + ClassViewer.DIV_START_DETAIL_HEADLINE + "Value: " + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + qx.html.String.escape(qx.io.Json.stringify(node.attributes.value)) + ClassViewer.DIV_END + ); + } else { + return ""; + } +} + + +/** + * Checks whether a item has @see attributes. + * + * @param node {Map} the doc node of the item. + * @return {Boolean} whether the item has @see attributes. + */ +qx.Proto._hasSeeAlsoHtml = function(node) { + return apiviewer.TreeUtil.getChild(node, "see") ? true : false; +} + + +/** + * Creates the HTML showing the @see attributes of an item. + * + * @param node {Map} the doc node of the item. + * @param fromClassNode {Map} the doc node of the class the item was defined. + * @return {String} the HTML showing the @see attributes. + */ +qx.Proto._createSeeAlsoHtml = function(node, fromClassNode) { + var ClassViewer = apiviewer.ClassViewer; + + var descNode = apiviewer.TreeUtil.getChild(node, "see"); + + if (node.children) + { + var seeAlsoHtml = ""; + for (var i = 0; i < node.children.length; i++) { + if (node.children[i].type == "see") { + // This is a @see attribute + if (seeAlsoHtml.length != 0) { + seeAlsoHtml += ", "; + } + seeAlsoHtml += this._createItemLinkHtml(node.children[i].attributes.name, fromClassNode); + } + } + if (seeAlsoHtml.length != 0) { + // We had @see attributes + return ClassViewer.DIV_START_DETAIL_HEADLINE + "See also:" + ClassViewer.DIV_END + + ClassViewer.DIV_START_DETAIL_TEXT + seeAlsoHtml + ClassViewer.DIV_END; + } + } + + // Nothing found + return ""; +} + + +/** + * Checks whether a item has documentation errors. + * + * @param node {Map} the doc node of the item. + * @return {Boolean} whether the item has documentation errors. + */ +qx.Proto._hasErrorHtml = function(node) { + var errorNode = apiviewer.TreeUtil.getChild(node, "errors"); + return (errorNode != null); +} + + +/** + * Creates the HTML showing the documentation errors of an item. + * + * @param node {Map} the doc node of the item. + * @param fromClassNode {Map} the doc node of the class the item was defined. + * @return {String} the HTML showing the documentation errors. + */ +qx.Proto._createErrorHtml = function(node, fromClassNode) { + var ClassViewer = apiviewer.ClassViewer; + + var errorNode = apiviewer.TreeUtil.getChild(node, "errors"); + if (errorNode) { + var html = ClassViewer.DIV_START_ERROR_HEADLINE + "Documentation errors:" + ClassViewer.DIV_END; + var errArr = errorNode.children; + for (var i = 0; i < errArr.length; i++) { + html += ClassViewer.DIV_START_DETAIL_TEXT + errArr[i].attributes.msg + " <br/>"; + html += "(" + if (fromClassNode && fromClassNode != this._currentClassDocNode) { + html += fromClassNode.attributes.fullName + "; "; + } + html += "Line: " + errArr[i].attributes.line + ", Column:" + errArr[i].attributes.column + ")" + ClassViewer.DIV_END; + } + return html; + } else { + return ""; + } +} + + +/** + * Creates the HTML showing the type of a doc node. + * + * @param typeNode {Map} the doc node to show the type for. + * @param packageBaseClass {Map} the doc node of the class <code>typeNode</code> + * belongs to. + * @param defaultType {String} the type name to use if <code>typeNode</code> is + * <code>null</code> or defines no type. + * @param useShortName {Boolean,true} whether to use short class names + * (without package). + * @return {String} the HTML showing the type. + */ +qx.Proto._createTypeHtml = function(typeNode, packageBaseClass, defaultType, useShortName) { + if (useShortName == null) { + useShortName = true; + } + + var types = []; + var typeHtml, typeDimensions, typeName, linkText, dims; + + if (typeNode) + { + // read in children + if (typeNode.children && apiviewer.TreeUtil.getChild(typeNode, "types")) + { + for (var i=0, a=apiviewer.TreeUtil.getChild(typeNode, "types").children, l=a.length; i<l; i++) + { + if (a[i].type == "entry") + { + types.push(a[i].attributes); + } + } + } + + // read from attributes (alternative) + if (types.length == 0 && typeNode.attributes) + { + typeName = typeNode.attributes.instance ? typeNode.attributes.instance : typeNode.attributes.type; + + if (typeName != undefined) + { + dims = typeNode.attributes.dimensions; + + if (typeof dims == "number" && dims > 0) { + types.push({ "type" : typeName, "dimensions" : dims }); + } else { + types.push({ "type" : typeName }); + } + } + } + } + + if (types.length == 0) + { + typeHtml = defaultType; + } + else + { + typeHtml = ""; + + if (types.length > 1) { + typeHtml += "(" + } + + for (var j=0; j<types.length; j++) + { + if (j>0) { + typeHtml += " | "; + } + + typeName = types[j].type; + typeDimensions = types[j].dimensions; + + if (apiviewer.ClassViewer.PRIMITIVES[typeName]) + { + typeHtml += typeName; + } + else + { + linkText = typeName; + if (useShortName) + { + var lastDot = typeName.lastIndexOf("."); + if (lastDot != -1) { + linkText += " " + typeName.substring(lastDot + 1); + } + } + typeHtml += this._createItemLinkHtml(linkText, packageBaseClass, false, true); + } + + if (typeDimensions) + { + for (var i = 0; i < parseInt(typeDimensions); i++) { + typeHtml += "[]"; + } + } + } + + if (types.length > 1) { + typeHtml += ")" + } + } + + return typeHtml; +} + + +/** + * Creates HTML that replaces all @link-attributes with links. + * + * @param description {String} the description. + * @param packageBaseClass {Map,null} the doc node of the class to use for + * auto-adding packages. + */ +qx.Proto._createDescriptionHtml = function(description, packageBaseClass) { + var linkRegex = /\{@link([^\}]*)\}/mg; + + var html = ""; + var hit; + var lastPos = 0; + while ((hit = linkRegex.exec(description)) != null) { + // Add the text before the link + html += description.substring(lastPos, hit.index) + + this._createItemLinkHtml(hit[1], packageBaseClass); + + lastPos = hit.index + hit[0].length; + } + + // Add the text after the last hit + html += description.substring(lastPos, description.length); + + return html; +} + + +/** + * Creates the HTML for a link to an item. + * + * @param linkText {String} the link text + * (e.g. "mypackage.MyClass#myMethod alt text") + * @param packageBaseClass {Map,null} the doc node of the class to use when + * auto-adding the package to a class name having no package specified. + * If null, no automatic package addition is done. + * @param useIcon {Boolean,true} whether to add an icon to the link. + * @param useShortName {Boolean,false} whether to use the short name. + */ +qx.Proto._createItemLinkHtml = function(linkText, packageBaseClass, useIcon, + useShortName) +{ + if (useIcon == null) { + useIcon = true; + } + + linkText = qx.lang.String.trim(linkText); + + if (linkText.charAt(0) == '"' || linkText.charAt(0) == '<') { + // This is a String or a link to a URL -> Just use it as it is + return linkText; + } else { + // This is a link to another class or method -> Create an item link + + // Separate item name from label + var hit = apiviewer.ClassViewer.ITEM_SPEC_REGEX.exec(linkText); + if (hit == null) { + // Malformed item name + return linkText; + } else { + var className = hit[2]; + var itemName = hit[3]; + var label = hit[6]; + + // Make the item name absolute + if (className == null || className.length == 0) { + // This is a relative link to a method -> Add the current class + className = packageBaseClass.attributes.fullName; + } else if (packageBaseClass && className.indexOf(".") == -1) { + // The class name has no package -> Use the same package as the current class + var name = packageBaseClass.attributes.name; + var fullName = packageBaseClass.attributes.fullName; + var packageName = fullName.substring(0, fullName.length - name.length); + className = packageName + className; + } + + // Get the node info + if (label == null || label.length == 0) { + // We have no label -> Use the item name as label + label = hit[1]; + } + + // Add the right icon + if (useIcon) { + var classNode = this._getClassDocNode(className); + if (classNode) { + var itemNode; + if (itemName) { + // The links points to a item of the class + var cleanItemName = itemName.substring(1); + var parenPos = cleanItemName.indexOf("("); + if (parenPos != -1) { + cleanItemName = qx.lang.String.trim(cleanItemName.substring(0, parenPos)); + } + itemNode = apiviewer.TreeUtil.getItemDocNode(classNode, cleanItemName); + } else { + // The links points to the class + itemNode = classNode; + } + if (itemNode) { + var iconUrl = apiviewer.TreeUtil.getIconUrl(itemNode); + var iconCode = apiviewer.ClassViewer.createImageHtml(iconUrl); + } + } + } + + // Create a real bookmarkable link + // NOTE: The onclick-handler must be added by HTML code. If it + // is added using the DOM element then the href is followed. + var fullItemName = className + (itemName ? itemName : ""); + return '<span style="white-space: nowrap;">' + + (typeof iconCode != "undefined" ? iconCode : "") + + '<a href="' + window.location.protocol + '//' + window.location.pathname + + '#' + fullItemName + '" onclick="' + + 'document._detailViewer._selectItem(\'' + fullItemName + '\'); return false;"' + + ' title="' + fullItemName + '">' + label + '</a></span>'; + } + } +} + + +/** + * Gets the node type for a doc node. + * + * @param itemNode {Map} the doc node of the item. + * @return {Integer} the item's node type. + */ +qx.Proto._getTypeForItemNode = function(itemNode) { + var ClassViewer = apiviewer.ClassViewer; + + if (itemNode.type == "constant") { + return ClassViewer.NODE_TYPE_CONSTANT; + } else if (itemNode.type == "property") { + return ClassViewer.NODE_TYPE_PROPERTY; + } else if (itemNode.type == "event") { + return ClassViewer.NODE_TYPE_EVENT; + } else if (itemNode.type == "method") { + var name = itemNode.attributes.name; + if (name == null) { + return ClassViewer.NODE_TYPE_CONSTRUCTOR; + } else { + if (itemNode.attributes.isStatic) { + return ClassViewer.NODE_TYPE_METHOD_STATIC; + } else { + return ClassViewer.NODE_TYPE_METHOD; + } + } + } +} + + +// overridden +qx.Proto.dispose = function() { + if (this.getDisposed()) { + return; + } + + this._titleElem = null; + this._classDescElem = null; + this._markedElement = null; + + for (var nodeType in this._infoPanelHash) { + this._infoPanelHash[nodeType].infoElem = null; + this._infoPanelHash[nodeType].infoTitleElem = null; + this._infoPanelHash[nodeType].infoBodyElem = null; + } + + document._detailViewer = null; + + return qx.ui.embed.HtmlEmbed.prototype.dispose.call(this); +} + + +/** {Map} The primitive types. These types will not be shown with links. */ +qx.Class.PRIMITIVES = { "var":true, "void":true, "undefined":true, "arguments":true, + "Boolean":true, "String":true, "Float":true, "Double":true, + "Number":true, "Integer":true, "Error":true, + "RegExp":true, "Array":true, "Map":true, "Date":true, "Element":true, + "Document":true, "Window":true, "Node":true, "Function":true, "Object":true, + "Event":true }; + +/** + * {regexp} The regexp for parsing a item name + * (e.g. "mypackage.MyClass#MY_CONSTANT alternative text"). + */ +qx.Class.ITEM_SPEC_REGEX = /^(([\w\.]+)?(#\w+(\([^\)]*\))?)?)(\s+(.*))?$/; + +/** {regexp} The regexp that finds the end of a sentence. */ +qx.Class.SENTENCE_END_REGEX = /[^\.].\.(\s|<)/; + +/** {int} The node type of a constructor. */ +qx.Class.NODE_TYPE_CONSTRUCTOR = 1; +/** {int} The node type of an event. */ +qx.Class.NODE_TYPE_EVENT = 2; +/** {int} The node type of a property. */ +qx.Class.NODE_TYPE_PROPERTY = 3; + +/** {int} The node type of a public method. */ +qx.Class.NODE_TYPE_METHOD = 4; +/** {int} The node type of a static public method. */ +qx.Class.NODE_TYPE_METHOD_STATIC = 5; +/** {int} The node type of a constant. */ +qx.Class.NODE_TYPE_CONSTANT = 6; + +/** {string} The start tag of a div. */ +qx.Class.DIV_START = '<div>'; +/** {string} The start tag of a div containing an item description. */ +qx.Class.DIV_START_DESC = '<div class="item-desc">'; +/** {string} The start tag of a div containing the headline of an item detail. */ +qx.Class.DIV_START_DETAIL_HEADLINE = '<div class="item-detail-headline">'; +/** {string} The start tag of a div containing the text of an item detail. */ +qx.Class.DIV_START_DETAIL_TEXT = '<div class="item-detail-text">'; +/** {string} The start tag of a div containing the headline of an item error. */ +qx.Class.DIV_START_ERROR_HEADLINE = '<div class="item-detail-error">'; +/** {string} The end tag of a div. */ +qx.Class.DIV_END = '</div>'; + +/** {string} The start tag of a span containing an optional detail. */ +qx.Class.SPAN_START_OPTIONAL = '<span class="item-detail-optional">'; +/** {string} The start tag of a span containing a parameter name. */ +qx.Class.SPAN_START_PARAM_NAME = '<span class="item-detail-param-name">'; +/** {string} The end tag of a span. */ +qx.Class.SPAN_END = '</span>'; + + +/** + * Creates the HTML showing an image. + * + * @param imgUrl {var} the URL of the image. May be a string or an array of + * strings (for overlay images). + * @param tooltip {String} the tooltip to show. + * @param styleAttributes {String} the style attributes to add to the image. + */ +qx.Class.createImageHtml = function(imgUrl, tooltip, styleAttributes) { + if (typeof imgUrl == "string") { + return '<img src="' + qx.manager.object.AliasManager.getInstance().resolvePath(imgUrl) + '" class="img"' + + (styleAttributes ? ' style="' + styleAttributes + '"' : "") + '/>'; + } else { + if (styleAttributes) { + styleAttributes += ";vertical-align:top"; + } else { + styleAttributes = "vertical-align:top"; + } + return apiviewer.ClassViewer.createOverlayImageHtml(18, 18, imgUrl, tooltip, styleAttributes); + } +} + + +/** + * Creates HTML that shows an overlay image (several images on top of each other). + * The resulting HTML will behave inline. + * + * @param width {Integer} the width of the images. + * @param height {Integer} the height of the images. + * @param imgUrlArr {String[]} the URLs of the images. The last image will be + * painted on top. + * @param toolTip {String,null} the tooltip of the icon. + * @param styleAttributes {String,null} custom CSS style attributes. + * @return {String} the HTML with the overlay image. + */ +qx.Class.createOverlayImageHtml + = function(width, height, imgUrlArr, toolTip, styleAttributes) +{ + var html = '<div style="position:relative;top:0;left:0;width:' + width + 'px;height:' + height + 'px' + + ((styleAttributes == null) ? '' : (';' + styleAttributes)) + '">'; + + for (var i = 0; i < imgUrlArr.length; i++) { + html += '<img'; + if (toolTip != null) { + html += ' title="' + toolTip + '"'; + } + html += ' style="position:absolute;top:0px;left:0px" src="' + qx.manager.object.AliasManager.getInstance().resolvePath(imgUrlArr[i]) + '"/>'; + } + + html += '</div>'; + + /* + // NOTE: See testOverlay.html + var html = '<table cellpadding="0" cellspacing="0" ' + + 'style="display:inline;position:relative;border:1px solid blue' + + ((styleAttributes == null) ? '' : (';' + styleAttributes)) + '"><tr>' + + '<td style="width:' + width + 'px;height:' + height + 'px">'; + for (var i = 0; i < imgUrlArr.length; i++) { + html += '<img'; + if (toolTip != null) { + html += ' title="' + toolTip + '"'; + } + html += ' style="position:absolute;top:0px;left:0px" src="' + imgUrlArr[i] + '"></img>'; + } + html += '</td></tr></table>'; + */ + + return html; +}
\ No newline at end of file diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/InfoViewer.js b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/InfoViewer.js new file mode 100644 index 0000000000..01c13e43d7 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/InfoViewer.js @@ -0,0 +1,59 @@ +/* ************************************************************************ + + qooxdoo - the new era of web development + + http://qooxdoo.org + + Copyright: + 2004-2007 1&1 Internet AG, Germany, http://www.1and1.org + + License: + LGPL: http://www.gnu.org/licenses/lgpl.html + EPL: http://www.eclipse.org/org/documents/epl-v10.php + See the LICENSE file in the project's top-level directory for details. + + Authors: + * Til Schneider (til132) + * Sebastian Werner (wpbasti) + * Andreas Ecker (ecker) + * Fabian Jakobs (fjakobs) + +************************************************************************ */ + +/* ************************************************************************ + +#module(apiviewer) + +************************************************************************ */ + +/** + * Shows the class details. + */ +qx.OO.defineClass("apiviewer.InfoViewer", qx.ui.embed.HtmlEmbed, +function() { + qx.ui.embed.HtmlEmbed.call(this); + + this.setOverflow("auto"); + this.setPadding(20); + this.setEdge(0); + this.setHtmlProperty("id", "InfoViewer"); + this.setVisibility(false); + + apiviewer.InfoViewer.instance = this; +}); + +qx.Proto.showInfo = function(classNode) +{ + var vHtml = ""; + + // Title + vHtml += '<h1>'; + vHtml += '<div class="pkgtitle">package</div>'; + vHtml += classNode.attributes.fullName; + vHtml += '</h1>'; + + // TODO: Overview of classes in this package + + // Apply HTML + this.setHtml(vHtml); +} diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/TreeUtil.js b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/TreeUtil.js new file mode 100755 index 0000000000..05f26a5597 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/TreeUtil.js @@ -0,0 +1,382 @@ +/* ************************************************************************ + + qooxdoo - the new era of web development + + http://qooxdoo.org + + Copyright: + 2004-2007 1&1 Internet AG, Germany, http://www.1and1.org + + License: + LGPL: http://www.gnu.org/licenses/lgpl.html + EPL: http://www.eclipse.org/org/documents/epl-v10.php + See the LICENSE file in the project's top-level directory for details. + + Authors: + * Til Schneider (til132) + * Sebastian Werner (wpbasti) + * Andreas Ecker (ecker) + * Fabian Jakobs (fjakobs) + +************************************************************************ */ + +/* ************************************************************************ + +#module(apiviewer) +#embed(apiviewer.image/*) + +************************************************************************ */ + +/** + * A util class for handling the documentation tree. + */ +qx.OO.defineClass("apiviewer.TreeUtil", qx.core.Object, +function () { + qx.core.Object.call(this); +}); + + +/** + * Gets the child of a doc node having a certain type. + * + * @param docNode {Map} the doc node to get the child of. + * @param childType {String} the type of the child to get. + * @return {Map} the wanted child or <code>null</code> if <code>docNode</code> + * is <code>null</code> or has no such child. + */ +qx.Class.getChild = function(docNode, childType) { + if (docNode != null && docNode.children != null) { + for (var i = 0; i < docNode.children.length; i++) { + if (docNode.children[i].type == childType) { + return docNode.children[i]; + } + } + } + + return null; +} + + +/** + * Gets the child of a doc node having a certain attribute value. + * + * @param docNode {Map} the doc node to get the child of. + * @param attributeName {String} the name of the attribute the wanted child must have. + * @param attributeValue {String} the value of the attribute the wanted child must have. + * @return {Map} the wanted child or <code>code</code> if there is no such child. + */ +qx.Class.getChildByAttribute = function(docNode, attributeName, attributeValue) { + if (docNode.children != null) { + for (var i = 0; i < docNode.children.length; i++) { + var node = docNode.children[i]; + if (node.attributes && node.attributes[attributeName] == attributeValue) { + return node; + } + } + } + + return null; +} + + +/** + * Searches the doc node of a item. Only use this method if you don't know the + * type of the item. + * + * @param classNode {Map} the class node the item belongs to. + * @param itemName {String} the name of the item to search. + * @return {Map} the doc node of the item or <code>null</code> if the class has + * no such item. + */ +qx.Class.getItemDocNode = function(classNode, itemName) { + var TreeUtil = apiviewer.TreeUtil; + + // Go through the item lists and check whether one contains the wanted item + for (var i = 0; i < TreeUtil.ITEM_LIST_ARR.length; i++) { + var listNode = TreeUtil.getChild(classNode, TreeUtil.ITEM_LIST_ARR[i]); + if (listNode) { + var itemNode = TreeUtil.getChildByAttribute(listNode, "name", itemName); + if (itemNode) { + return itemNode; + } + } + } + + // Nothing found + return null; +} + + +/** + * Gets the doc node of a class. + * + * @param docTree {Map} the documentation tree. + * @param className {String} the name of the class. + * @return {Map} the doc node of the class. + */ +qx.Class.getClassDocNode = function(docTree, className) { + var splits = className.split("."); + var currNode = docTree; + for (var i = 0; i < splits.length && currNode != null; i++) { + if (i < splits.length - 1) { + // The current name is a package name + var packages = this.getChild(currNode, "packages"); + currNode = packages ? this.getChildByAttribute(packages, "name", splits[i]) : null; + } else { + // The current name is a class name + var classes = this.getChild(currNode, "classes"); + currNode = classes ? this.getChildByAttribute(classes, "name", splits[i]) : null; + } + } + + return currNode; +} + + +/** + * Gets the icon URL of a doc node. + * + * @param node {Map} the node to get the icon for. + * @param inherited {Boolean,false} whether the node was inherited. + * @return {var} the URL of the icon. May be a string or an array of string + * (in case of an overlay icon). + */ +qx.Class.getIconUrl = function(node, inherited, context) { + var constName; + switch (node.type) { + case "package": + constName = "ICON_PACKAGE"; + break; + case "class": + constName = "ICON_CLASS"; + + if (node.attributes.isStatic) { + constName += "_STATIC"; + } else if (node.attributes.isAbstract) { + constName += "_ABSTRACT"; + } + + break; + case "property": + constName = "ICON_PROPERTY"; + break; + case "event": + constName = "ICON_EVENT"; + break; + case "method": + var isCtor = node.attributes.name == null; + var isPublic = isCtor || (node.attributes.name.charAt(0) != "_"); + + constName = "ICON_METHOD" + (isPublic ? "_PUB" : "_PROT"); + + if (isCtor) { + constName += "_CTOR"; + } else if (node.attributes.isStatic) { + constName += "_STATIC"; + } else if (node.attributes.isAbstract) { + constName += "_ABSTRACT"; + } + + break; + case "constant": + constName = "ICON_CONSTANT"; + break; + default: throw new Error("Unknown node type: " + node.type); + } + + if (inherited) { + constName += "_INHERITED"; + } else if (node.attributes.overriddenFrom) { + constName += "_OVERRIDDEN"; + } + + if (node.attributes.hasError) { + constName += "_ERROR"; + } else if (node.attributes.hasWarning) { + constName += "_WARN"; + } + + var iconUrl = apiviewer.TreeUtil[constName]; + if (iconUrl == null) { + throw new Error("Unknown img constant: " + constName); + } + + return iconUrl; +} + + +/** {string[]} The names of lists containing items. */ +qx.Class.ITEM_LIST_ARR = [ "constants", "properties", "methods-pub", "methods-pub", + "methods-static-prot", "methods-static-prot" ]; + + +/** {string} The URL of the overlay "abstract". */ +qx.Class.OVERLAY_ABSTRACT = "api/image/overlay_abstract18.gif"; +/** {string} The URL of the overlay "error". */ +qx.Class.OVERLAY_ERROR = "api/image/overlay_error18.gif"; +/** {string} The URL of the overlay "inherited". */ +qx.Class.OVERLAY_INHERITED = "api/image/overlay_inherited18.gif"; +/** {string} The URL of the overlay "overridden". */ +qx.Class.OVERLAY_OVERRIDDEN = "api/image/overlay_overridden18.gif"; +/** {string} The URL of the overlay "static". */ +qx.Class.OVERLAY_STATIC = "api/image/overlay_static18.gif"; +/** {string} The URL of the overlay "warning". */ +qx.Class.OVERLAY_WARN = "api/image/overlay_warning18.gif"; + + +/** {string} The icon URL of a package. */ +qx.Class.ICON_PACKAGE = "api/image/package18.gif"; +/** {string} The icon URL of a package with warning. */ +qx.Class.ICON_PACKAGE_WARN = "api/image/package_warning18.gif"; + + +/** {string} The icon URL of a class. */ +qx.Class.ICON_CLASS = "api/image/class18.gif"; +/** {string} The icon URL of a class with warning. */ +qx.Class.ICON_CLASS_WARN = "api/image/class_warning18.gif"; +/** {string} The icon URL of a class with error. */ +qx.Class.ICON_CLASS_ERROR = "api/image/class_warning18.gif"; + +/** {string} The icon URL of a static class. */ +qx.Class.ICON_CLASS_STATIC = "api/image/class_static18.gif"; +/** {string} The icon URL of a static class with warning. */ +qx.Class.ICON_CLASS_STATIC_WARN = "api/image/class_static_warning18.gif"; +/** {string} The icon URL of a static class with error. */ +qx.Class.ICON_CLASS_STATIC_ERROR = "api/image/class_static_warning18.gif"; + +/** {string} The icon URL of an abstract class. */ +qx.Class.ICON_CLASS_ABSTRACT = "api/image/class_abstract18.gif"; +/** {string} The icon URL of an abstract class with warning. */ +qx.Class.ICON_CLASS_ABSTRACT_WARN = "api/image/class_abstract_warning18.gif"; +/** {string} The icon URL of an abstract class with error. */ +qx.Class.ICON_CLASS_ABSTRACT_ERROR = "api/image/class_abstract_warning18.gif"; + + +/** {string} The icon URL of a property. */ +qx.Class.ICON_PROPERTY = "api/image/property18.gif"; +/** {string[]} The icon URL of a property with warning. */ +qx.Class.ICON_PROPERTY_WARN = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of a property with error. */ +qx.Class.ICON_PROPERTY_ERROR = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an inherited property. */ +qx.Class.ICON_PROPERTY_INHERITED = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_INHERITED ]; +/** {string[]} The icon URL of an inherited property with warning. */ +qx.Class.ICON_PROPERTY_INHERITED_WARN = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an inherited property with error. */ +qx.Class.ICON_PROPERTY_INHERITED_ERROR = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an overridden property. */ +qx.Class.ICON_PROPERTY_OVERRIDDEN = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_OVERRIDDEN ]; +/** {string[]} The icon URL of an overridden property with warning. */ +qx.Class.ICON_PROPERTY_OVERRIDDEN_WARN = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an overridden property with error. */ +qx.Class.ICON_PROPERTY_OVERRIDDEN_ERROR = [ qx.Class.ICON_PROPERTY, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_ERROR ]; + + +/** {string} The icon URL of an event. */ +qx.Class.ICON_EVENT = "api/image/event18.gif"; + +/** {string[]} The icon URL of an inherited event. */ +qx.Class.ICON_EVENT_INHERITED = [ qx.Class.ICON_EVENT, qx.Class.OVERLAY_INHERITED ]; + + +/** {string} The icon URL of a public method. */ +qx.Class.ICON_METHOD_PUB = "api/image/method_public18.gif"; +/** {string[]} The icon URL of a public method with warning. */ +qx.Class.ICON_METHOD_PUB_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ERROR ]; +/** {string[]} The icon URL of a public method with error. */ +qx.Class.ICON_METHOD_PUB_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an inherited public method. */ +qx.Class.ICON_METHOD_PUB_INHERITED = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_INHERITED ]; +/** {string[]} The icon URL of an inherited public method with warning. */ +qx.Class.ICON_METHOD_PUB_INHERITED_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an inherited public method with error. */ +qx.Class.ICON_METHOD_PUB_INHERITED_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an overridden public method. */ +qx.Class.ICON_METHOD_PUB_OVERRIDDEN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_OVERRIDDEN ]; +/** {string[]} The icon URL of an overridden public method with warning. */ +qx.Class.ICON_METHOD_PUB_OVERRIDDEN_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an overridden public method with error. */ +qx.Class.ICON_METHOD_PUB_OVERRIDDEN_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of a public static method. */ +qx.Class.ICON_METHOD_PUB_STATIC = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_STATIC ]; +/** {string[]} The icon URL of a public static method with error. */ +qx.Class.ICON_METHOD_PUB_STATIC_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_STATIC, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of a public abstract method. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT ]; +/** {string[]} The icon URL of a public abstract method with warning. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of a public abstract method with error. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an overridden public abstract method. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_OVERRIDDEN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_OVERRIDDEN ]; +/** {string[]} The icon URL of an overridden public abstract method with warning. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_OVERRIDDEN_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an overridden public abstract method with error. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_OVERRIDDEN_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an inherited public abstract method. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_INHERITED = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED ]; +/** {string[]} The icon URL of an inherited public abstract method with warning. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_INHERITED_WARN = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an inherited public abstract method with error. */ +qx.Class.ICON_METHOD_PUB_ABSTRACT_INHERITED_ERROR = [ qx.Class.ICON_METHOD_PUB, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_ERROR ]; + + +/** {string} The icon URL of a constructor. */ +qx.Class.ICON_METHOD_PUB_CTOR = "api/image/constructor18.gif"; +/** {string[]} The icon URL of a constructor with error. */ +qx.Class.ICON_METHOD_PUB_CTOR_ERROR = [ qx.Class.ICON_METHOD_PUB_CTOR, qx.Class.OVERLAY_ERROR ]; + + +/** {string} The icon URL of a protected method. */ +qx.Class.ICON_METHOD_PROT = "api/image/method_protected18.gif"; +/** {string[]} The icon URL of a protected method with warning. */ +qx.Class.ICON_METHOD_PROT_WARN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ERROR ]; +/** {string[]} The icon URL of a protected method with error. */ +qx.Class.ICON_METHOD_PROT_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an inherited protected method. */ +qx.Class.ICON_METHOD_PROT_INHERITED = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_INHERITED ]; +/** {string[]} The icon URL of an inherited protected method with warning. */ +qx.Class.ICON_METHOD_PROT_INHERITED_WARN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an inherited protected method with error. */ +qx.Class.ICON_METHOD_PROT_INHERITED_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an overridden protected method. */ +qx.Class.ICON_METHOD_PROT_OVERRIDDEN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_OVERRIDDEN ]; +/** {string[]} The icon URL of an overridden protected method with warning. */ +qx.Class.ICON_METHOD_PROT_OVERRIDDEN_WARN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an overridden protected method with error. */ +qx.Class.ICON_METHOD_PROT_OVERRIDDEN_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_OVERRIDDEN, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of a protected static method. */ +qx.Class.ICON_METHOD_PROT_STATIC = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_STATIC ]; +/** {string[]} The icon URL of a protected static method with error. */ +qx.Class.ICON_METHOD_PROT_STATIC_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_STATIC, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an abstract protected method. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT ]; +/** {string[]} The icon URL of an abstract protected method with warning. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT_WARN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an abstract protected method with error. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_ERROR ]; + +/** {string[]} The icon URL of an inherited abstract protected method. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT_INHERITED = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED ]; +/** {string[]} The icon URL of an inherited abstract protected method with warning. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT_INHERITED_WARN = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_WARN ]; +/** {string[]} The icon URL of an inherited abstract protected method with error. */ +qx.Class.ICON_METHOD_PROT_ABSTRACT_INHERITED_ERROR = [ qx.Class.ICON_METHOD_PROT, qx.Class.OVERLAY_ABSTRACT, qx.Class.OVERLAY_INHERITED, qx.Class.OVERLAY_ERROR ]; + + +/** {string} The icon URL of a constant. */ +qx.Class.ICON_CONSTANT = "api/image/constant18.gif"; +/** {string[]} The icon URL of a constant with error. */ +qx.Class.ICON_CONSTANT_ERROR = [ qx.Class.ICON_CONSTANT, qx.Class.OVERLAY_ERROR ]; diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Viewer.js b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Viewer.js new file mode 100755 index 0000000000..b2f81d4859 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/class/apiviewer/Viewer.js @@ -0,0 +1,433 @@ +/* ************************************************************************ + + qooxdoo - the new era of web development + + http://qooxdoo.org + + Copyright: + 2004-2007 1&1 Internet AG, Germany, http://www.1and1.org + + License: + LGPL: http://www.gnu.org/licenses/lgpl.html + EPL: http://www.eclipse.org/org/documents/epl-v10.php + See the LICENSE file in the project's top-level directory for details. + + Authors: + * Til Schneider (til132) + * Sebastian Werner (wpbasti) + * Andreas Ecker (ecker) + * Fabian Jakobs (fjakobs) + +************************************************************************ */ + +/* ************************************************************************ + +#module(apiviewer) +#resource(css:css) +#resource(image:image) + +************************************************************************ */ + +/** + * The API viewer. Shows the API documentation. + */ +qx.OO.defineClass("apiviewer.Viewer", qx.ui.layout.DockLayout, +function () { + qx.ui.layout.DockLayout.call(this); + + this.setEdge(0); + + this._titlePrefix = this.getSetting("title") + " API Documentation"; + document.title = this._titlePrefix; + + // create header + var header = new qx.ui.embed.HtmlEmbed( + "<h1>" + + "<span>" + this.getSetting("title") + "</span>"+ + " API Documentation"+ + "</h1>" + + "<div id='qxversion'>qooxdoo " + qx.core.Version.toString() + "</div>" + ); + header.setHtmlProperty("id", "header"); + header.setStyleProperty("background", "#134275 url(" + qx.manager.object.AliasManager.getInstance().resolvePath("api/image/colorstrip.gif") + ") top left repeat-x"); + header.setHeight(70); + this.addTop(header); + + this._tree = new qx.ui.tree.Tree("API Documentation"); + this._tree.set({ + backgroundColor: "white", + overflow: "scroll", + width: "100%", + height: "100%", + border: qx.renderer.border.BorderPresets.getInstance().inset, + paddingLeft: 5, + paddingTop: 3 + }); + this._tree.getManager().addEventListener("changeSelection", this._onTreeSelectionChange, this); + + this._detailFrame = new qx.ui.layout.CanvasLayout; + this._detailFrame.set({ + width: "100%", + height: "100%", + backgroundColor: "white", + border: qx.renderer.border.BorderPresets.getInstance().inset + }); + this._detailFrame.setHtmlProperty("id", "DetailFrame"); + + // create vertival splitter + var mainSplitPane = new qx.ui.splitpane.HorizontalSplitPane(250, "1*"); + mainSplitPane.setLiveResize(true); + mainSplitPane.addLeft(this._tree); + mainSplitPane.addRight(this._detailFrame); + this.add(mainSplitPane); + + this._detailLoader = new qx.ui.embed.HtmlEmbed('<h1><div class="please">please wait</div>Loading data...</h1>'); + this._detailLoader.setHtmlProperty("id", "DetailLoader"); + this._detailLoader.setMarginLeft(20); + this._detailLoader.setMarginTop(20); + this._detailFrame.add(this._detailLoader); + + this._classViewer = new apiviewer.ClassViewer; + this._detailFrame.add(this._classViewer); + + this._infoViewer = new apiviewer.InfoViewer; + this._detailFrame.add(this._infoViewer); + + this._currentTreeType = apiviewer.Viewer.PACKAGE_TREE; + + // Workaround: Since navigating in qx.ui.tree.Tree doesn't work, we've to + // maintain a hash that keeps the tree nodes for class names + this._classTreeNodeHash = {}; + this._classTreeNodeHash[apiviewer.Viewer.PACKAGE_TREE] = {}; + this._classTreeNodeHash[apiviewer.Viewer.INHERITENCE_TREE] = {}; + + apiviewer.Viewer.instance = this; + + qx.client.History.getInstance().init(); + qx.client.History.getInstance().addEventListener("request", this._onHistoryRequest, this); +}); + + +/** The documentation tree to show. */ +qx.OO.addProperty({ name:"docTree", type:"object" }); + + +qx.Settings.setDefault("title", "qooxdoo"); +qx.Settings.setDefault("initialTreeDepth", 1); + + +// property checker +qx.Proto._modifyDocTree = function(propValue, propOldValue, propData) { + this._updateTree(propValue); + return true; +} + + +/** + * Loads the API doc tree from a URL. The URL must point to a JSON encoded + * doc tree. + * + * @param url {String} the URL. + */ +qx.Proto.load = function(url) +{ + var req = new qx.io.remote.Request(url); + + req.setTimeout(180000); + + req.addEventListener("completed", function(evt) + { + var content = evt.getData().getContent(); + this.setDocTree(eval("(" + content + ")")); + + qx.ui.core.Widget.flushGlobalQueues(); + + // Handle bookmarks + if (window.location.hash) { + var self = this; + window.setTimeout(function() { + self.selectItem(window.location.hash.substring(1)); + }, 0); + } + + this._detailLoader.setHtml('<h1><div class="please">' + this.getSetting("title") + + '</div>API Documentation</h1>'); + + }, this); + + req.addEventListener("failed", function(evt) + { + this.error("Couldn't load file: " + url); + }, this); + + req.send(); +} + + +/** + * Updates the tree on the left. + * + * @param docTree {Map} the documentation tree to use for updating. + */ +qx.Proto._updateTree = function(docTree) { + var inheritenceNode = new qx.ui.tree.TreeFolder("Inheritence hierarchy"); + var packagesNode = new qx.ui.tree.TreeFolder("Packages"); + + this._tree.removeAll(); + this._tree.add(inheritenceNode, packagesNode); + + // Fille the packages tree (and fill the _topLevelClassNodeArr) + this._topLevelClassNodeArr = []; + this._fillPackageNode(packagesNode, docTree, 0); + + // Sort the _topLevelClassNodeArr + this._topLevelClassNodeArr.sort(function (node1, node2) { + return (node1.attributes.fullName < node2.attributes.fullName) ? -1 : 1; + }); + + // Fill the inheritence tree + for (var i = 0; i < this._topLevelClassNodeArr.length; i++) { + this._createInheritanceNode(inheritenceNode, this._topLevelClassNodeArr[i], docTree); + } + + packagesNode.open(); + + if (this._wantedClassName) { + this.showClassByName(this._wantedClassName); + this._wantedClassName = null; + } +} + + +/** + * Fills a package tree node with tree nodes for the sub packages and classes. + * + * @param treeNode {qx.ui.tree.TreeFolder} the package tree node. + * @param docNode {Map} the documentation node of the package. + */ +qx.Proto._fillPackageNode = function(treeNode, docNode, depth) { + var ApiViewer = apiviewer.Viewer; + var TreeUtil = apiviewer.TreeUtil; + + var packagesDocNode = TreeUtil.getChild(docNode, "packages"); + if (packagesDocNode && packagesDocNode.children) { + for (var i = 0; i < packagesDocNode.children.length; i++) { + var packageDocNode = packagesDocNode.children[i]; + var iconUrl = TreeUtil.getIconUrl(packageDocNode); + var packageTreeNode = new qx.ui.tree.TreeFolder(packageDocNode.attributes.name, iconUrl); + packageTreeNode.docNode = packageDocNode; + treeNode.add(packageTreeNode); + + this._fillPackageNode(packageTreeNode, packageDocNode, depth+1); + + // Open the package node if it has child packages + if (depth < this.getSetting("initialTreeDepth") && TreeUtil.getChild(packageDocNode, "packages")) { + packageTreeNode.open(); + } + + // Register the tree node + this._classTreeNodeHash[ApiViewer.PACKAGE_TREE][packageDocNode.attributes.fullName] = packageTreeNode; + } + } + + var classesDocNode = TreeUtil.getChild(docNode, "classes"); + if (classesDocNode && classesDocNode.children) { + for (var i = 0; i < classesDocNode.children.length; i++) { + var classDocNode = classesDocNode.children[i]; + var iconUrl = TreeUtil.getIconUrl(classDocNode); + var classTreeNode = new qx.ui.tree.TreeFolder(classDocNode.attributes.name, iconUrl); + classTreeNode.docNode = classDocNode; + classTreeNode.treeType = ApiViewer.PACKAGE_TREE; + treeNode.add(classTreeNode); + + // Register the tree node + this._classTreeNodeHash[ApiViewer.PACKAGE_TREE][classDocNode.attributes.fullName] = classTreeNode; + + // Check whether this is a top-level-class + if (classDocNode.attributes.superClass == null) { + this._topLevelClassNodeArr.push(classDocNode); + } + } + } +} + + +/** + * Creates the tree node for a class containing class nodes for all its child + * classes. + * + * @param classDocNode {Map} the documentation node of the class. + * @param docTree {Map} the documentation tree. + */ +qx.Proto._createInheritanceNode = function(parentTreeNode, classDocNode, docTree) { + var ApiViewer = apiviewer.Viewer; + var TreeUtil = apiviewer.TreeUtil; + + // Create the tree node + var iconUrl = TreeUtil.getIconUrl(classDocNode); + var classTreeNode = new qx.ui.tree.TreeFolder(classDocNode.attributes.fullName, iconUrl); + classTreeNode.docNode = classDocNode; + classTreeNode.treeType = ApiViewer.INHERITENCE_TREE; + parentTreeNode.add(classTreeNode); + + // Register the tree node + this._classTreeNodeHash[ApiViewer.INHERITENCE_TREE][classDocNode.attributes.fullName] = classTreeNode; + + // Add all child classes + var childClassNameCsv = classDocNode.attributes.childClasses; + if (childClassNameCsv) { + var childClassNameArr = childClassNameCsv.split(","); + for (var i = 0; i < childClassNameArr.length; i++) { + var childClassDocNode = TreeUtil.getClassDocNode(docTree, childClassNameArr[i]); + this._createInheritanceNode(classTreeNode, childClassDocNode, docTree); + } + } +} + + +/** + * Event handler. Called when the tree selection has changed. + * + * @param evt {Map} the event. + */ +qx.Proto._onTreeSelectionChange = function(evt) +{ + var treeNode = evt.getData()[0]; + + if (treeNode && treeNode.docNode) + { + var newTitle = this._titlePrefix + " - class " + treeNode.docNode.attributes.fullName; + + qx.client.History.getInstance().addToHistory(treeNode.docNode.attributes.fullName, newTitle); + + this._currentTreeType = treeNode.treeType; + + this._selectTreeNode(treeNode); + + window.location.hash = "#" + treeNode.docNode.attributes.fullName; + } +} + + +qx.Proto._onHistoryRequest = function(evt) +{ + this.showClassByName(evt.getData()); +} + +qx.Proto._selectTreeNode = function(vTreeNode) +{ + if (!(vTreeNode && vTreeNode.docNode)) { + this.error("Invalid tree node: " + vTreeNode); + } + + var vDoc = vTreeNode.docNode; + + this._detailLoader.setVisibility(false); + + if (vDoc.type == "class") + { + this._infoViewer.setVisibility(false); + this._classViewer.showClass(vDoc); + this._classViewer.setVisibility(true); + } + else + { + this._classViewer.setVisibility(false); + this._infoViewer.showInfo(vDoc); + this._infoViewer.setVisibility(true); + } +} + + +/** + * Selects an item (class, property, method or constant). + * + * @param fullItemName {String} the full name of the item to select. + * (e.g. "qx.mypackage.MyClass" or "qx.mypackage.MyClass#myProperty") + */ +qx.Proto.selectItem = function(fullItemName) { + var className = fullItemName; + var itemName = null; + var hashPos = fullItemName.indexOf("#"); + if (hashPos != -1) { + className = fullItemName.substring(0, hashPos); + itemName = fullItemName.substring(hashPos + 1); + + var parenPos = itemName.indexOf("("); + if (parenPos != -1) { + itemName = qx.lang.String.trim(itemName.substring(0, parenPos)); + } + } + + this.showClassByName(className); + if (itemName) { + this._classViewer.showItem(itemName); + } +} + + +/** + * Shows a certain class. + * + * @param className {String} the name of the class to show. + */ +qx.Proto.showClassByName = function(className) { + var treeNode = this._classTreeNodeHash[this._currentTreeType][className]; + + if (treeNode) { + treeNode.setSelected(true); + } else if (this.getDocTree() == null) { + // The doc tree has not been loaded yet + // -> Remeber the wanted class and show when loading is done + this._wantedClassName = className; + } else { + this.error("Unknown class: " + className); + } +} + + +qx.Class.PACKAGE_TREE = 1; +qx.Class.INHERITENCE_TREE = 2; + + + +qx.Proto.dispose = function() +{ + if (this.getDisposed()) { + return; + } + + if (this._tree) + { + this._tree.dispose(); + this._tree = null; + } + + if (this._detailFrame) + { + this._detailFrame.dispose(); + this._detailFrame = null; + } + + if (this._detailLoader) + { + this._detailLoader.dispose(); + this._detailLoader = null; + } + + if (this._classViewer) + { + this._classViewer.dispose(); + this._classViewer = null; + } + + if (this._infoViewer) + { + this._infoViewer.dispose(); + this._infoViewer = null; + } + + this._classTreeNodeHash = null; + + return qx.ui.layout.HorizontalBoxLayout.prototype.dispose.call(this); +} diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/index.html b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/index.html new file mode 100755 index 0000000000..a40a79fb1b --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/index.html @@ -0,0 +1,15 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>API Documentation</title> + <script type="text/javascript" src="script/apiviewer.js"></script> + </head> + <body> + <script type="text/javascript"> + if (!qx.IS_SOURCE) { + qx.log.Logger.ROOT_LOGGER.setMinLevel(qx.log.Logger.LEVEL_ERROR); + } + qx.core.Init.getInstance().setApplication(apiviewer.Application); + </script> + </body> +</html> diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/css/apiviewer.css b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/css/apiviewer.css new file mode 100755 index 0000000000..834608fafc --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/css/apiviewer.css @@ -0,0 +1,320 @@ +#header { + margin: 0px; + padding: 0px; + background-color: #134275; + font-family: "Trebuchet MS", "Lucida Grande", Verdana, sans-serif; +} + +#header h1 { + font-size: 18px; + font-weight: bold; + color: #DEFF83; + position: absolute; + top: 30px; + left: 20px; + margin: 0; + padding: 0; +} + +#qxversion { + font-size: 11px; + text-transform: lowercase; + color: #F3FFD1; + margin-top: -14px; + letter-spacing: 1px; + word-spacing: 4px; + position: absolute; + bottom: 20px; + right: 20px; + margin: 0; + padding: 0; +} + +#DetailFrame, +#DetailFrame td, +#DetailFrame th{ + font-family: Verdana, "Lucida Grande", "Bitstream Vera Sans", Tahoma, "Lucida Sans Unicode", Arial, sans-serif; + font-size: 11px; + line-height: 150%; +} + +#DetailFrame h1, +#DetailFrame h2, +#DetailFrame h3, +#DetailFrame h4, +#DetailFrame h5, +#DetailFrame h6{ + font-family: "Trebuchet MS", "Lucida Grande", Verdana, sans-serif; + color: #134275; +} + +#DetailFrame *{ + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} + +#DetailFrame #ControlFrame{ + position: absolute; + top: 20px; + right: 20px; + font-size: 10px; + background: #FBFFEF; + padding: 4px 6px; + border: 1px solid #ECECEC; +} + +#DetailFrame h1 { + font-size: 24px; + margin-bottom: 20px; +} + +#DetailFrame h2 { + font-size: 18px; + margin-bottom: 4px; +} + +#DetailFrame h3 { + font-size: 14px; +} + +#DetailFrame img { + border: 0 none; + vertical-align: middle; +} + +#DetailFrame a:link, +#DetailFrame a:visited{ + color: #134275; +} + +#DetailFrame a:hover, +#DetailFrame a:active{ + color: #134275; + text-decoration: underline; +} + +#DetailFrame td{ + vertical-align: top; + padding: 2px; +} + + + + + +#DetailLoader div.please{ + font-size: 14px; + font-weight: normal; + margin-bottom: 4px; +} + + + + + + +#InfoViewer div.pkgtitle{ + font-size: 14px; + font-weight: normal; + margin-bottom: 4px; +} + + + + + + + + +#ClassViewer div.classDescription{ + font-size: 12px; + + background: #F3FFD1; + border: 1px solid #F3FFD1; + + -moz-border-radius: 5px; + padding: 12px; + padding-top: 4px; + padding-bottom: 4px; + + width: 650px; + overflow: auto; +} + +#ClassViewer div.classDescription p{ + margin-top: 5px; + margin-bottom: 5px; +} + +#ClassViewer div.packageName{ + font-size: 14px; + font-weight: normal; + margin-bottom: 4px; +} + +#ClassViewer span.typeInfo{ + color: #83B300; + font-weight: normal; +} + + + + + + +#ClassViewer div.infoPanel { + margin-top: 30px; +} + +#ClassViewer div.infoPanel h2{ + cursor: default; +} + + + + + + + + +#ClassViewer table.info { + table-layout: fixed; +} + +#ClassViewer table.info tr { + background: #FBFFEF; +} + +#ClassViewer table.info tr.marked { + background: #DEFF83; +} + +#ClassViewer table.info tr td, +#ClassViewer div.empty-info-body { + border-top: 1px solid #ECECEC; +} + +#ClassViewer table.info tr td{ + overflow: hidden; +} + +#ClassViewer table.info tr td td{ + border-top: 0 none; + padding: 0; +} + +#ClassViewer table.info td.icon{ + text-align: center; + width: 20px; +} + +#ClassViewer table.info td.type{ + width: 100px; + font-size: 12px; + color: #83B300; + font-weight: bold; +} + +#ClassViewer table.info td.toggle{ + text-align: center; + width: 16px; + padding: 1px; +} + +#ClassViewer table.info td.toggle img{ + cursor: default; +} + +#ClassViewer table.info td.text{ + padding-right: 10px; +} + +#ClassViewer table.info td.text h3{ + cursor: default; +} + +#ClassViewer table.info td.text table{ + padding: 0; +} + +#ClassViewer table.info td.text table td { + padding: 1px 3px; +} + +#ClassViewer table.info td.text table th { + text-align: left; + color: #134275; + font-weight: normal; + padding: 1px 3px; +} + +#ClassViewer span.methodSignature{ + font-size: 12px; + color: #83B300; +} + +#ClassViewer table.info td.type a, +#ClassViewer span.methodSignature a{ + color: #83B300 !important; +} + +#ClassViewer span.methodSignature span.parameterType{ + font-style: italic; +} + +#ClassViewer span.methodSignature span.separator{ + color: #134275; + font-weight: bold; +} + +#ClassViewer span.methodSignature span.parenthesis{ + color: #134275; + font-weight: bold; +} + + + + + +#ClassViewer div.item-detail-headline { + font-weight: bold; + color: #1D65B3; +} + +#ClassViewer div.item-detail-text { + padding-left: 12px; +} + +#ClassViewer div.item-detail-text p{ + display: inline; +} + +#ClassViewer div.item-detail-error { + font-weight: bold; + color: #D61F1C; +} + +#ClassViewer span.item-detail-optional { + font-style: italic; +} + +#ClassViewer code, +#ClassViewer pre, +#ClassViewer span.item-detail-param-name { + font-family: Consolas, "Bitstream Vera Sans Mono", "Courier New", monospace; + background: #FFF; + padding: 1px; +} + +#ClassViewer pre{ + overflow: auto; + padding: 4px 8px; + margin-top: 8px; + margin-bottom: 8px; +} + +#ClassViewer span.caps{ + color: #134275; +} diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class18.gif Binary files differnew file mode 100755 index 0000000000..df8c9291c7 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract18.gif Binary files differnew file mode 100755 index 0000000000..788abd7094 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract_warning18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract_warning18.gif Binary files differnew file mode 100755 index 0000000000..135f68cffd --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_abstract_warning18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static18.gif Binary files differnew file mode 100755 index 0000000000..5eb75aea09 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static_warning18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static_warning18.gif Binary files differnew file mode 100755 index 0000000000..75a6c72035 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_static_warning18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_warning18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_warning18.gif Binary files differnew file mode 100755 index 0000000000..95e7a327f9 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/class_warning18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/close.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/close.gif Binary files differnew file mode 100755 index 0000000000..3377fb65de --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/close.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/colorstrip.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/colorstrip.gif Binary files differnew file mode 100644 index 0000000000..e19d1b4dfd --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/colorstrip.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constant18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constant18.gif Binary files differnew file mode 100755 index 0000000000..c3a5d0cedf --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constant18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constructor18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constructor18.gif Binary files differnew file mode 100644 index 0000000000..b3645ac80a --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/constructor18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/event18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/event18.gif Binary files differnew file mode 100644 index 0000000000..d3555ff96d --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/event18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_protected18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_protected18.gif Binary files differnew file mode 100755 index 0000000000..be71bae519 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_protected18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_public18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_public18.gif Binary files differnew file mode 100755 index 0000000000..67b1785dba --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/method_public18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/nextlevel.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/nextlevel.gif Binary files differnew file mode 100755 index 0000000000..48b81c80a9 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/nextlevel.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/open.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/open.gif Binary files differnew file mode 100755 index 0000000000..30f815aa30 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/open.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_abstract18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_abstract18.gif Binary files differnew file mode 100755 index 0000000000..16122bf4d6 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_abstract18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_constructor18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_constructor18.gif Binary files differnew file mode 100755 index 0000000000..d408fe8e57 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_constructor18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_error18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_error18.gif Binary files differnew file mode 100755 index 0000000000..ffde061d69 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_error18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_inherited18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_inherited18.gif Binary files differnew file mode 100755 index 0000000000..81e4906fe7 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_inherited18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_overridden18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_overridden18.gif Binary files differnew file mode 100755 index 0000000000..bca3e80c48 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_overridden18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_static18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_static18.gif Binary files differnew file mode 100755 index 0000000000..4b1afa1a35 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_static18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_warning18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_warning18.gif Binary files differnew file mode 100755 index 0000000000..ce74a2a0f2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/overlay_warning18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package18.gif Binary files differnew file mode 100755 index 0000000000..907110110d --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package_warning18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package_warning18.gif Binary files differnew file mode 100755 index 0000000000..2cb875be2b --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/package_warning18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/property18.gif b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/property18.gif Binary files differnew file mode 100755 index 0000000000..ab4153d6d6 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/resource/image/property18.gif diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/C.po b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/C.po new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/C.po diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/de.po b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/de.po new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/de.po diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/en.po b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/en.po new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/en.po diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/es.po b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/es.po new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/es.po diff --git a/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/fr.po b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/fr.po new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/webapps/qooxdoo-0.6.5-sdk/frontend/application/apiviewer/source/translation/fr.po |
