X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.bootstrap.nav.ProgressBar.json;fp=docs%2Fsymbols%2FRoo.bootstrap.NavProgressBar.json;h=eb73988786d1b61a623adfa27d82f5b94593c5f2;hp=0a1b75c6cc9d541cf8f9304600afae5a85d865f0;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.bootstrap.NavProgressBar.json b/docs/symbols/Roo.bootstrap.nav.ProgressBar.json similarity index 82% rename from docs/symbols/Roo.bootstrap.NavProgressBar.json rename to docs/symbols/Roo.bootstrap.nav.ProgressBar.json index 0a1b75c6cc..eb73988786 100644 --- a/docs/symbols/Roo.bootstrap.NavProgressBar.json +++ b/docs/symbols/Roo.bootstrap.nav.ProgressBar.json @@ -1,15 +1,22 @@ { - "name" : "Roo.bootstrap.NavProgressBar", + "name" : "Roo.bootstrap.nav.ProgressBar", "augments" : [ "Roo.bootstrap.Component", "Roo.Component", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [ + "Roo.bootstrap.nav.ProgressBarItem" + ], + "tree_parent" : [], "desc" : "Bootstrap NavProgressBar class", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, - "memberOf" : "NavProgressBar", + "isAbstract" : false, + "isBuilderTop" : false, + "memberOf" : "ProgressBar", "example" : "", "deprecated" : "", "since" : "", @@ -23,124 +30,117 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "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" : [] + "memberOf" : "Roo.util.Observable" }, { - "name" : "container_method", + "name" : "tooltip", "type" : "string", - "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" }, { - "name" : "tooltip", + "name" : "container_method", "type" : "string", - "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "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" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "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" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "NavProgressBar:bullets[]", + "type" : "Roo.bootstrap.nav.ProgressItem", + "desc" : "Bullets for the Nav Progress bar for the toolbar", + "memberOf" : "Roo.bootstrap.nav.ProgressBar" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "tooltipEl", + "type" : "function", "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +152,115 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisibilityEl", + "type" : "function", "desc" : "Set the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getVisibilityEl", + "type" : "function", "desc" : "Get the element that will be used to show or hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "initEvents", + "type" : "function", "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getChildContainer", + "type" : "function", "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +272,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +297,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +323,58 @@ }, { "name" : "destroy", + "type" : "function", "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}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +387,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +419,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +444,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +476,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +501,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +526,39 @@ }, { "name" : "purgeListeners", + "type" : "function", "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +589,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +627,20 @@ }, { "name" : "addEvents", + "type" : "function", "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +653,20 @@ }, { "name" : "releaseCapture", + "type" : "function", "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +679,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +717,20 @@ }, { "name" : "fireEvent", + "type" : "function", "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +755,20 @@ }, { "name" : "hasListener", + "type" : "function", "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +787,20 @@ }, { "name" : "capture", + "type" : "function", "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.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +825,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,8 +871,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item changes", - "memberOf" : "Roo.bootstrap.NavProgressBar", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -750,19 +882,19 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.NavProgressBar", + "type" : "Roo.bootstrap.nav.ProgressBar", "desc" : "", "isOptional" : false }, { "name" : "selected", - "type" : "Roo.bootstrap.NavProgressItem", + "type" : "Roo.bootstrap.nav.ProgressItem", "desc" : "The item selected", "isOptional" : false }, { "name" : "prev", - "type" : "Roo.bootstrap.NavProgressItem", + "type" : "Roo.bootstrap.nav.ProgressItem", "desc" : "The previously selected item", "isOptional" : false } @@ -771,7 +903,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -789,7 +923,9 @@ }, { "name" : "beforerender", + "type" : "function", "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -807,7 +943,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -825,7 +963,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -843,7 +983,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +1003,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +1023,9 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1043,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1063,9 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -933,7 +1083,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1103,9 @@ }, { "name" : "beforedestroy", + "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "",