X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.Button.json;fp=docs%2Fsymbols%2FRoo.Button.json;h=7845af6b9d92ef82519dc1e700da3b7c220905ee;hp=0e333be7f1670af5cca08e04a71d49fe357793bc;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f
diff --git a/docs/symbols/Roo.Button.json b/docs/symbols/Roo.Button.json
index 0e333be7f1..7845af6b9d 100644
--- a/docs/symbols/Roo.Button.json
+++ b/docs/symbols/Roo.Button.json
@@ -3,10 +3,23 @@
"augments" : [
"Roo.util.Observable"
],
+ "childClasses" : {
+ "Roo.Button" : [
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button"
+ ],
+ "Roo.SplitButton" : [
+ "Roo.Toolbar.SplitButton"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "Simple Button class",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "Button",
"example" : "",
"deprecated" : "",
@@ -21,216 +34,209 @@
}
],
"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" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "menu",
- "type" : "Mixed",
+ "type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "template",
"type" : "Roo.Template",
"desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "iconCls",
"type" : "String",
"desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "menuAlign",
"type" : "String",
"desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "repeat",
"type" : "Boolean/Object",
"desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button",
- "optvals" : []
+ "memberOf" : "Roo.Button"
}
],
"methods" : [
{
"name" : "show",
+ "type" : "function",
"desc" : "Show this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "focus",
+ "type" : "function",
"desc" : "Focus the button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "setHandler",
+ "type" : "function",
"desc" : "Assigns this button's click handler",
+ "sig" : "(handler, scope)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "handler",
@@ -249,43 +255,58 @@
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Disable this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Enable this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns the button's underlying element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -297,15 +318,20 @@
},
{
"name" : "setDisabled",
+ "type" : "function",
"desc" : "Convenience function for boolean enable/disable",
+ "sig" : "(enabled)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "enabled",
@@ -318,15 +344,20 @@
},
{
"name" : "setVisible",
+ "type" : "function",
"desc" : "Convenience function for boolean show/hide",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "visible",
@@ -339,29 +370,39 @@
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Destroys this Button and removes any listeners.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getText",
+ "type" : "function",
"desc" : "Gets the text for this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -373,15 +414,20 @@
},
{
"name" : "setText",
+ "type" : "function",
"desc" : "Sets this button's text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "text",
@@ -394,15 +440,20 @@
},
{
"name" : "toggle",
+ "type" : "function",
"desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "state",
@@ -415,43 +466,58 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Hide this button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"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",
@@ -482,15 +548,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",
@@ -515,15 +586,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",
@@ -536,15 +612,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",
@@ -557,15 +638,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",
@@ -590,15 +676,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",
@@ -623,15 +714,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",
@@ -650,15 +746,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",
@@ -683,15 +784,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",
@@ -724,8 +830,10 @@
"events" : [
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires when the button is rendered",
- "memberOf" : "Roo.Button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -742,8 +850,10 @@
},
{
"name" : "click",
+ "type" : "function",
"desc" : "Fires when this button is clicked",
- "memberOf" : "Roo.Button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -766,8 +876,10 @@
},
{
"name" : "mouseover",
+ "type" : "function",
"desc" : "Fires when the mouse hovers over the button",
- "memberOf" : "Roo.Button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -790,8 +902,10 @@
},
{
"name" : "toggle",
+ "type" : "function",
"desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
- "memberOf" : "Roo.Button",
+ "sig" : "function (_self, pressed)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -814,8 +928,10 @@
},
{
"name" : "mouseout",
+ "type" : "function",
"desc" : "Fires when the mouse exits the button",
- "memberOf" : "Roo.Button",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",