X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.bootstrap.Header.json;fp=docs%2Fsymbols%2FRoo.bootstrap.Header.json;h=5ec8d61fbeafa51a9b136d957984a4f1c7654bf3;hp=8e37c8c3e14d2c46b21d8dbbebc317932559cbf9;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.bootstrap.Header.json b/docs/symbols/Roo.bootstrap.Header.json index 8e37c8c3e1..5ec8d61fbe 100644 --- a/docs/symbols/Roo.bootstrap.Header.json +++ b/docs/symbols/Roo.bootstrap.Header.json @@ -5,10 +5,83 @@ "Roo.Component", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [ + "Roo.bootstrap.Alert", + "Roo.bootstrap.BezierSignature", + "Roo.bootstrap.Brick", + "Roo.bootstrap.Button", + "Roo.bootstrap.ButtonGroup", + "Roo.bootstrap.ButtonUploader", + "Roo.bootstrap.Calendar", + "Roo.bootstrap.Card", + "Roo.bootstrap.Column", + "Roo.bootstrap.Container", + "Roo.bootstrap.DocumentManager", + "Roo.bootstrap.DocumentSlider", + "Roo.bootstrap.DocumentViewer", + "Roo.bootstrap.DropTarget", + "Roo.bootstrap.Element", + "Roo.bootstrap.Graph", + "Roo.bootstrap.Header", + "Roo.bootstrap.Img", + "Roo.bootstrap.LayoutMasonry", + "Roo.bootstrap.LayoutMasonryAuto", + "Roo.bootstrap.Link", + "Roo.bootstrap.LocationPicker", + "Roo.bootstrap.MasonryBrick", + "Roo.bootstrap.MessageBar", + "Roo.bootstrap.Pagination", + "Roo.bootstrap.PaginationItem", + "Roo.bootstrap.PagingToolbar", + "Roo.bootstrap.Progress", + "Roo.bootstrap.ProgressBar", + "Roo.bootstrap.Row", + "Roo.bootstrap.Slider", + "Roo.bootstrap.TabGroup", + "Roo.bootstrap.TabPanel", + "Roo.bootstrap.Table", + "Roo.bootstrap.UploadCropbox", + "Roo.bootstrap.breadcrumb.Nav", + "Roo.bootstrap.dash.NumberBox", + "Roo.bootstrap.dash.TabBox", + "Roo.bootstrap.dash.TabPane", + "Roo.bootstrap.form.CardUploader", + "Roo.bootstrap.form.CheckBox", + "Roo.bootstrap.form.ComboBox", + "Roo.bootstrap.form.DateField", + "Roo.bootstrap.form.DateSplitField", + "Roo.bootstrap.form.FieldLabel", + "Roo.bootstrap.form.Form", + "Roo.bootstrap.form.HtmlEditor", + "Roo.bootstrap.form.Input", + "Roo.bootstrap.form.Markdown", + "Roo.bootstrap.form.MoneyField", + "Roo.bootstrap.form.MonthField", + "Roo.bootstrap.form.NumberField", + "Roo.bootstrap.form.PhoneInput", + "Roo.bootstrap.form.Radio", + "Roo.bootstrap.form.RadioSet", + "Roo.bootstrap.form.SecurePass", + "Roo.bootstrap.form.TextArea", + "Roo.bootstrap.form.TimeField", + "Roo.bootstrap.form.TriggerField", + "Roo.bootstrap.layout.Border", + "Roo.bootstrap.nav.Group", + "Roo.bootstrap.nav.Headerbar", + "Roo.bootstrap.nav.ProgressBar", + "Roo.bootstrap.nav.ProgressBarItem", + "Roo.bootstrap.nav.Sidebar", + "Roo.bootstrap.nav.SidebarItem", + "Roo.bootstrap.nav.Simplebar" + ], + "tree_parent" : [], "desc" : "Bootstrap Header class", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "Header", "example" : "", "deprecated" : "", @@ -23,145 +96,123 @@ } ], "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" : "level", "type" : "Number", "desc" : "6) default 1", - "memberOf" : "Roo.bootstrap.Header", - "optvals" : [ - "1", - "2", - "3", - "4", - "5", - "6" - ] + "memberOf" : "Roo.bootstrap.Header" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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" : "html", "type" : "String", "desc" : "content of header", - "memberOf" : "Roo.bootstrap.Header", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Header" }, { "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" : "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" : [ { @@ -173,85 +224,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" : [ { @@ -263,15 +344,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" : [ { @@ -283,15 +369,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", @@ -304,43 +395,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", @@ -353,15 +459,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", @@ -380,15 +491,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" : [ { @@ -400,15 +516,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", @@ -427,15 +548,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" : [ { @@ -447,15 +573,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" : [ { @@ -467,29 +598,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", @@ -520,15 +661,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", @@ -553,15 +699,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", @@ -574,15 +725,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", @@ -595,15 +751,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", @@ -628,15 +789,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", @@ -661,15 +827,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", @@ -688,15 +859,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", @@ -721,15 +897,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", @@ -762,7 +943,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -780,7 +963,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" : "", @@ -798,7 +983,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -816,7 +1003,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -834,7 +1023,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -852,7 +1043,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +1063,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" : "", @@ -888,7 +1083,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -906,7 +1103,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" : "", @@ -924,7 +1123,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -942,7 +1143,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" : "",