X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.ColorPalette.json;fp=docs%2Fsymbols%2FRoo.ColorPalette.json;h=912f1313bb4e6d355e4d030181d37e003cb15f4b;hp=e0a352deb49aa8ab8816716f304af55239836a49;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f
diff --git a/docs/symbols/Roo.ColorPalette.json b/docs/symbols/Roo.ColorPalette.json
index e0a352deb4..912f1313bb 100644
--- a/docs/symbols/Roo.ColorPalette.json
+++ b/docs/symbols/Roo.ColorPalette.json
@@ -4,10 +4,15 @@
"Roo.Component",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "Simple color palette class for choosing colors. The palette can be rendered to any container.
\nHere's an example of typical usage:\n\nvar cp = new Roo.ColorPalette({value:'993300'}); // initial selected color\ncp.render('my-div');\n\ncp.on('select', function(palette, selColor){\n // do something with selColor\n});\n
",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "ColorPalette",
"example" : "",
"deprecated" : "",
@@ -22,79 +27,75 @@
}
],
"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" : "allowReselect",
"type" : "Boolean",
"desc" : "If set to true then reselecting a color that is already selected fires the selection event",
- "memberOf" : "Roo.ColorPalette",
- "optvals" : []
+ "memberOf" : "Roo.ColorPalette"
},
{
"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" : "value",
"type" : "String",
"desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.",
- "memberOf" : "Roo.ColorPalette",
- "optvals" : []
+ "memberOf" : "Roo.ColorPalette"
},
{
"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" : "itemCls",
"type" : "String",
"desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")",
- "memberOf" : "Roo.ColorPalette",
- "optvals" : []
+ "memberOf" : "Roo.ColorPalette"
},
{
"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" : "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" : "select",
+ "type" : "function",
"desc" : "Selects the specified color in the palette (fires the select event)",
+ "sig" : "(color)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ColorPalette",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "color",
@@ -107,15 +108,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" : [
{
@@ -127,15 +133,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",
@@ -148,43 +159,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",
@@ -197,15 +223,20 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Hide 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" : [
{
@@ -217,15 +248,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",
@@ -244,15 +280,20 @@
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Show 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" : [
{
@@ -264,15 +305,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" : [
{
@@ -284,15 +330,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",
@@ -311,15 +362,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" : [
{
@@ -331,15 +387,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" : [
{
@@ -351,29 +412,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",
@@ -404,15 +475,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",
@@ -437,15 +513,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",
@@ -458,15 +539,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",
@@ -479,15 +565,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",
@@ -512,15 +603,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",
@@ -545,15 +641,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",
@@ -572,15 +673,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",
@@ -605,15 +711,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",
@@ -646,8 +757,10 @@
"events" : [
{
"name" : "select",
+ "type" : "function",
"desc" : "Fires when a color is selected",
- "memberOf" : "Roo.ColorPalette",
+ "sig" : "function (_self, color)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -670,7 +783,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" : "",
@@ -688,7 +803,9 @@
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -706,7 +823,9 @@
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -724,7 +843,9 @@
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -742,7 +863,9 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -760,7 +883,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" : "",
@@ -778,7 +903,9 @@
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -796,7 +923,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" : "",
@@ -814,7 +943,9 @@
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -832,7 +963,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" : "",