X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.bootstrap.NavSidebar.json;fp=docs%2Fsymbols%2FRoo.bootstrap.NavSidebar.json;h=0000000000000000000000000000000000000000;hp=713d1cb901bc1edfb3b11b5b62709e623a6dcb39;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.bootstrap.NavSidebar.json b/docs/symbols/Roo.bootstrap.NavSidebar.json deleted file mode 100644 index 713d1cb901..0000000000 --- a/docs/symbols/Roo.bootstrap.NavSidebar.json +++ /dev/null @@ -1,988 +0,0 @@ -{ - "name" : "Roo.bootstrap.NavSidebar", - "augments" : [ - "Roo.bootstrap.Navbar", - "Roo.bootstrap.Component", - "Roo.Component", - "Roo.util.Observable" - ], - "desc" : "Bootstrap Sidebar class", - "isSingleton" : false, - "isStatic" : false, - "isBuiltin" : false, - "memberOf" : "NavSidebar", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "config", - "type" : "Object", - "desc" : "The config object", - "isOptional" : false - } - ], - "returns" : [], - "config" : [ - { - "name" : "listeners", - "type" : "Object", - "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] - }, - { - "name" : "container_method", - "type" : "string", - "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "tooltip", - "type" : "string", - "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "visibilityEl", - "type" : "string|object", - "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] - }, - { - "name" : "can_build_overlaid", - "type" : "Boolean", - "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "hideMode", - "type" : "String", - "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", - "memberOf" : "Roo.Component", - "optvals" : [ - "display", - "visibility" - ] - }, - { - "name" : "style", - "type" : "String", - "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "allowDomMove", - "type" : "Boolean", - "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] - }, - { - "name" : "cls", - "type" : "String", - "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "xattr", - "type" : "Object", - "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "actionMode", - "type" : "String", - "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", - "memberOf" : "Roo.Component", - "optvals" : [] - }, - { - "name" : "dataId", - "type" : "string", - "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "name", - "type" : "string", - "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] - }, - { - "name" : "disableClass", - "type" : "String", - "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] - } - ], - "methods" : [ - { - "name" : "collapse", - "desc" : "Collapse the navbar pulldown", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "expand", - "desc" : "Expand the navbar pulldown", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "tooltipEl", - "desc" : "Fetch the element to display the tooltip on.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "name" : "hide", - "desc" : "Hide a component - adds 'hidden' class", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "show", - "desc" : "Show a component - removes 'hidden' class", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "setVisibilityEl", - "desc" : "Set the element that will be used to show or hide", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "getVisibilityEl", - "desc" : "Get the element that will be used to show or hide", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "initEvents", - "desc" : "Initialize Events for the element", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "getChildContainer", - "desc" : "Fetch the element to add children to", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "name" : "getId", - "desc" : "Returns the id of this component.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "String", - "desc" : "" - } - ] - }, - { - "name" : "render", - "desc" : "If this is a lazy rendering component, render it to its container element.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "container", - "type" : "String/HTMLElement/Element", - "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "destroy", - "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "isVisible", - "desc" : "Returns true if this component is visible.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "setDisabled", - "desc" : "Convenience function for setting disabled/enabled by boolean.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "disabled", - "type" : "Boolean", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "focus", - "desc" : "Try to focus this component.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "selectText", - "type" : "Boolean", - "desc" : "True to also select the text in this component (if applicable)", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "enable", - "desc" : "Enable this component.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "setVisible", - "desc" : "Convenience function to hide or show this component by boolean.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "visible", - "type" : "Boolean", - "desc" : "True to show, false to hide", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "disable", - "desc" : "Disable this component.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "getEl", - "desc" : "Returns the underlying {@link Roo.Element}.", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "The element" - } - ] - }, - { - "name" : "purgeListeners", - "desc" : "Removes all listeners for this object", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "on", - "desc" : "Appends an event handler to this element (shorthand for addListener)", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "The type of event to listen for", - "isOptional" : false - }, - { - "name" : "handler", - "type" : "Function", - "desc" : "The method the event invokes", - "isOptional" : false - }, - { - "name" : "scope", - "type" : "Object", - "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", - "isOptional" : false - }, - { - "name" : "options", - "type" : "Object", - "desc" : "(optional)", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "un", - "desc" : "Removes a listener (shorthand for removeListener)", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "The type of event to listen for", - "isOptional" : false - }, - { - "name" : "handler", - "type" : "Function", - "desc" : "The handler to remove", - "isOptional" : false - }, - { - "name" : "scope", - "type" : "Object", - "desc" : "(optional) The scope (this object) for the handler", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "addEvents", - "desc" : "Used to define events on this Observable", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "object", - "type" : "Object", - "desc" : "The object with the events defined", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "releaseCapture", - "desc" : "Removes all added captures from the Observable.", - "isStatic" : true, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "o", - "type" : "Observable", - "desc" : "The Observable to release", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "removeListener", - "desc" : "Removes a listener", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "The type of event to listen for", - "isOptional" : false - }, - { - "name" : "handler", - "type" : "Function", - "desc" : "The handler to remove", - "isOptional" : false - }, - { - "name" : "scope", - "type" : "Object", - "desc" : "(optional) The scope (this object) for the handler", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "fireEvent", - "desc" : "Fires the specified event with the passed parameters (minus the event name).", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "", - "isOptional" : false - }, - { - "name" : "args", - "type" : "Object...", - "desc" : "Variable number of parameters are passed to handlers", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Boolean", - "desc" : "returns false if any of the handlers return false otherwise it returns true" - } - ] - }, - { - "name" : "hasListener", - "desc" : "Checks to see if this object has any listeners for a specified event", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "The name of the event to check for", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Boolean", - "desc" : "True if the event is being listened for, else false" - } - ] - }, - { - "name" : "capture", - "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", - "isStatic" : true, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "o", - "type" : "Observable", - "desc" : "The Observable to capture", - "isOptional" : false - }, - { - "name" : "fn", - "type" : "Function", - "desc" : "The function to call", - "isOptional" : false - }, - { - "name" : "scope", - "type" : "Object", - "desc" : "(optional) The scope (this object) for the fn", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "addListener", - "desc" : "Appends an event handler to this component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "memberOf" : "Roo.util.Observable", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "eventName", - "type" : "String", - "desc" : "The type of event to listen for", - "isOptional" : false - }, - { - "name" : "handler", - "type" : "Function", - "desc" : "The method the event invokes", - "isOptional" : false - }, - { - "name" : "scope", - "type" : "Object", - "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", - "isOptional" : false - }, - { - "name" : "options", - "type" : "Object", - "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", - "isOptional" : false - } - ], - "returns" : [] - } - ], - "events" : [ - { - "name" : "beforetoggle", - "desc" : "Fire before toggle the menu", - "memberOf" : "Roo.bootstrap.Navbar", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "e", - "type" : "Roo.EventObject", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "childrenrendered", - "desc" : "Fires when the children have been rendered..", - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.bootstrap.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforerender", - "desc" : "Fires before the component is rendered. Return false to stop the render.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "disable", - "desc" : "Fires after the component is disabled.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "render", - "desc" : "Fires after the component is rendered.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "destroy", - "desc" : "Fires after the component is destroyed.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "hide", - "desc" : "Fires after the component is hidden.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforehide", - "desc" : "Fires before the component is hidden. Return false to stop the hide.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "show", - "desc" : "Fires after the component is shown.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforeshow", - "desc" : "Fires before the component is shown. Return false to stop the show.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "enable", - "desc" : "Fires after the component is enabled.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforedestroy", - "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - } - ] -} \ No newline at end of file