X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.bootstrap.panel.Content.json;fp=docs%2Fsymbols%2FRoo.bootstrap.panel.Content.json;h=8b795d17d77212186901520c988d640dd98406dd;hp=36c0b7876391932f9e245f0ebec2050b557192d9;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.bootstrap.panel.Content.json b/docs/symbols/Roo.bootstrap.panel.Content.json index 36c0b78763..8b795d17d7 100644 --- a/docs/symbols/Roo.bootstrap.panel.Content.json +++ b/docs/symbols/Roo.bootstrap.panel.Content.json @@ -3,209 +3,256 @@ "augments" : [ "Roo.util.Observable" ], - "desc" : "A basic ContentPanel element.", + "childClasses" : { + "Roo.bootstrap.panel.Content" : [ + "Roo.bootstrap.panel.Grid", + "Roo.bootstrap.panel.Nest" + ] + }, + "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" : "A basic ContentPanel element. - a panel that contain any content (eg. forms etc.)", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : true, "memberOf" : "Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", "params" : [ - { - "name" : "el", - "type" : "String/HTMLElement/Roo.Element", - "desc" : "The container element for this panel", - "isOptional" : false - }, { "name" : "config", "type" : "String/Object", "desc" : "A string to set only the title or a config object", "isOptional" : false - }, - { - "name" : "content", - "type" : "String", - "desc" : "(optional) Set the HTML content for this panel", - "isOptional" : false - }, - { - "name" : "region", - "type" : "String", - "desc" : "(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)", - "isOptional" : false } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "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" : "badges", "type" : "Boolean", "desc" : "render the badges", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "toolbar", "type" : "Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "iframe", "type" : "Boolean", "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "cls", "type" : "String", "desc" : "extra classes to use", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "params", "type" : "String/Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "resizeEl", "type" : "String/HTMLElement/Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" } ], "methods" : [ { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +264,20 @@ }, { "name" : "getChildContainer", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -238,15 +290,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -258,15 +315,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -279,15 +341,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -318,15 +385,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -338,29 +410,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -397,15 +479,20 @@ }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -417,15 +504,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -437,15 +529,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -457,15 +554,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element (not for iframe)", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -484,29 +586,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", @@ -537,15 +649,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", @@ -570,15 +687,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", @@ -591,15 +713,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", @@ -612,15 +739,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", @@ -645,15 +777,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", @@ -678,15 +815,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", @@ -705,15 +847,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", @@ -738,15 +885,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", @@ -779,8 +931,10 @@ "events" : [ { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -797,8 +951,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -827,8 +983,10 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -845,8 +1003,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -863,8 +1023,10 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Fires when this content is scrolled", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self, scrollEvent)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "",