X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fjson%2Froodata.json;h=eebfd7509622d85351fdc4fbc6aba1de61bf6a0b;hb=2e9c2dcf4c629c1b7de7d4923e209cde90c9b746;hp=c6e18c868ffde229e4893c798680eb4eedb706af;hpb=dd3d448312a6623433b5b24d48afec70c27bc497;p=roojs1 diff --git a/docs/json/roodata.json b/docs/json/roodata.json index c6e18c868f..eebfd75096 100644 --- a/docs/json/roodata.json +++ b/docs/json/roodata.json @@ -18350,7 +18350,7 @@ { "name": "panel", "type": "String", - "desc": "render as a panel.", + "desc": "render as panel - type - primary/success.....", "memberOf": "", "optvals": [ "primary", @@ -47934,6 +47934,12 @@ "type": "function", "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "Returns true if any fields in this form have changed since their original load. (New version)" + }, { "name": "hasListener", "sig": "(String eventName)", @@ -47944,7 +47950,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if any fields in this form have changed since their original load." + "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load." }, { "name": "isValid", @@ -48012,6 +48018,12 @@ "type": "function", "desc": "Resets this form." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose" + }, { "name": "setValues", "sig": "(Array/Object values)", @@ -48456,6 +48468,12 @@ "type": "function", "desc": "Returns the checked state of the checkbox." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -48472,7 +48490,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -48540,6 +48558,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -49674,6 +49698,12 @@ "type": "function", "desc": "Returns the currently selected field value or empty string if no value is set." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -49690,7 +49720,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isExpanded", @@ -49770,6 +49800,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "select", "sig": "(Number index, Boolean scrollIntoView)", @@ -50406,6 +50442,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -50422,7 +50464,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -50490,6 +50532,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -51666,6 +51714,12 @@ "type": "function", "desc": "Returns the currently selected field value or empty string if no value is set." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -51682,7 +51736,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isExpanded", @@ -51762,6 +51816,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "select", "sig": "(Number index, Boolean scrollIntoView)", @@ -52434,6 +52494,12 @@ "type": "function", "desc": "Returns the current date value of the date field." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -52450,7 +52516,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -52524,6 +52590,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -52998,6 +53070,12 @@ "type": "function", "desc": "Returns the checked state of the checkbox." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -53014,7 +53092,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -53082,6 +53160,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -53566,6 +53650,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -53582,7 +53672,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -53650,6 +53740,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -54244,6 +54340,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -54260,7 +54362,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -54328,6 +54430,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -54802,6 +54910,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -54818,7 +54932,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -54886,6 +55000,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -55506,6 +55626,12 @@ "type": "function", "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "Returns true if any fields in this form have changed since their original load. (New version)" + }, { "name": "hasListener", "sig": "(String eventName)", @@ -55516,7 +55642,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if any fields in this form have changed since their original load." + "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load." }, { "name": "isValid", @@ -55584,6 +55710,12 @@ "type": "function", "desc": "Resets this form." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose" + }, { "name": "setValues", "sig": "(Array/Object values)", @@ -56028,6 +56160,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -56044,7 +56182,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -56112,6 +56250,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -56688,6 +56832,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -56704,7 +56854,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -56772,6 +56922,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -57288,6 +57444,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -57304,7 +57466,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -57372,6 +57534,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -58370,6 +58538,12 @@ "type": "function", "desc": "Returns the current date value of the date field." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -58386,7 +58560,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -58460,6 +58634,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -59102,6 +59282,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -59118,7 +59304,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -59186,6 +59372,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -59696,6 +59888,12 @@ "type": "function", "desc": "Returns the checked state of the checkbox." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -59712,7 +59910,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -59780,6 +59978,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -60884,6 +61088,12 @@ "type": "function", "desc": "Returns the currently selected field value or empty string if no value is set." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -60900,7 +61110,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isExpanded", @@ -60980,6 +61190,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "select", "sig": "(Number index, Boolean scrollIntoView)", @@ -61532,6 +61748,12 @@ "type": "function", "desc": "" }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -61548,7 +61770,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -61616,6 +61838,12 @@ "type": "function", "desc": "Resets the current field value to the originally loaded value and clears any validation messages" }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "setDisabled", "sig": "(Boolean disabled)", @@ -62198,6 +62426,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -62214,7 +62448,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -62282,6 +62516,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -62870,6 +63110,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -62886,7 +63132,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -62954,6 +63200,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -63530,6 +63782,12 @@ "type": "function", "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}." }, + { + "name": "hasChanged", + "sig": "()", + "type": "function", + "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first." + }, { "name": "hasListener", "sig": "(String eventName)", @@ -63546,7 +63804,7 @@ "name": "isDirty", "sig": "()", "type": "function", - "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled." + "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged." }, { "name": "isValid", @@ -63620,6 +63878,12 @@ "type": "function", "desc": "Resets the current field value to the originally-loaded value and clears any validation messages." }, + { + "name": "resetHasChanged", + "sig": "()", + "type": "function", + "desc": "stores the current value in loadedValue" + }, { "name": "selectText", "sig": "(Number start, Number end)", @@ -67126,6 +67390,312 @@ } ] }, + "Roo.mailer.Body": { + "props": [ + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "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" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "name", + "type": "string", + "desc": "Specifies name attribute", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "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" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "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" + } + ], + "events": [ + { + "name": "beforedestroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is destroyed. Return false to stop the destroy." + }, + { + "name": "beforehide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is hidden. Return false to stop the hide." + }, + { + "name": "beforerender", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is rendered. Return false to stop the render." + }, + { + "name": "beforeshow", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is shown. Return false to stop the show." + }, + { + "name": "childrenrendered", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires when the children have been rendered.." + }, + { + "name": "destroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is destroyed." + }, + { + "name": "disable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is disabled." + }, + { + "name": "enable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is enabled." + }, + { + "name": "hide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is hidden." + }, + { + "name": "render", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is rendered." + }, + { + "name": "show", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is shown." + } + ], + "methods": [ + { + "name": "addEvents", + "sig": "(Object object)", + "type": "function", + "desc": "Used to define events on this Observable" + }, + { + "name": "addListener", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this component" + }, + { + "name": "capture", + "sig": "(Observable o, Function fn, Object scope)", + "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." + }, + { + "name": "destroy", + "sig": "()", + "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}." + }, + { + "name": "disable", + "sig": "()", + "type": "function", + "desc": "Disable this component." + }, + { + "name": "enable", + "sig": "()", + "type": "function", + "desc": "Enable this component." + }, + { + "name": "fireEvent", + "sig": "(String eventName, Object... args)", + "type": "function", + "desc": "Fires the specified event with the passed parameters (minus the event name)." + }, + { + "name": "focus", + "sig": "(Boolean selectText)", + "type": "function", + "desc": "Try to focus this component." + }, + { + "name": "getChildContainer", + "sig": "()", + "type": "function", + "desc": "Fetch the element to add children to" + }, + { + "name": "getEl", + "sig": "()", + "type": "function", + "desc": "Returns the underlying {@link Roo.Element}." + }, + { + "name": "getId", + "sig": "()", + "type": "function", + "desc": "Returns the id of this component." + }, + { + "name": "hasListener", + "sig": "(String eventName)", + "type": "function", + "desc": "Checks to see if this object has any listeners for a specified event" + }, + { + "name": "hide", + "sig": "()", + "type": "function", + "desc": "Hide a component - adds 'hidden' class" + }, + { + "name": "initEvents", + "sig": "()", + "type": "function", + "desc": "Initialize Events for the element" + }, + { + "name": "isVisible", + "sig": "()", + "type": "function", + "desc": "Returns true if this component is visible." + }, + { + "name": "on", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this element (shorthand for addListener)" + }, + { + "name": "purgeListeners", + "sig": "()", + "type": "function", + "desc": "Removes all listeners for this object" + }, + { + "name": "releaseCapture", + "sig": "(Observable o)", + "type": "function", + "desc": "Removes all added captures from the Observable." + }, + { + "name": "removeListener", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener" + }, + { + "name": "render", + "sig": "(String/HTMLElement/Element container)", + "type": "function", + "desc": "If this is a lazy rendering component, render it to its container element." + }, + { + "name": "setDisabled", + "sig": "(Boolean disabled)", + "type": "function", + "desc": "Convenience function for setting disabled/enabled by boolean." + }, + { + "name": "setVisible", + "sig": "(Boolean visible)", + "type": "function", + "desc": "Convenience function to hide or show this component by boolean." + }, + { + "name": "show", + "sig": "()", + "type": "function", + "desc": "Show a component - removes 'hidden' class" + }, + { + "name": "tooltipEl", + "sig": "()", + "type": "function", + "desc": "Fetch the element to display the tooltip on." + }, + { + "name": "un", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener (shorthand for removeListener)" + } + ] + }, "Roo.mailer.BodyContainer": { "props": [ { @@ -67766,6 +68336,1311 @@ } ] }, + "Roo.mailer.Example": { + "props": [ + { + "name": "lang", + "type": "String", + "desc": "section type.", + "memberOf": "", + "optvals": [ + "phpcode", + "programlisting" + ] + }, + { + "name": "code", + "type": "String", + "desc": "", + "memberOf": "" + } + ], + "events": [], + "methods": [] + }, + "Roo.mailer.Para": { + "props": [ + { + "name": "html", + "type": "String", + "desc": "", + "memberOf": "" + }, + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "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" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "name", + "type": "string", + "desc": "Specifies name attribute", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "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" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "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" + } + ], + "events": [ + { + "name": "beforedestroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is destroyed. Return false to stop the destroy." + }, + { + "name": "beforehide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is hidden. Return false to stop the hide." + }, + { + "name": "beforerender", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is rendered. Return false to stop the render." + }, + { + "name": "beforeshow", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is shown. Return false to stop the show." + }, + { + "name": "childrenrendered", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires when the children have been rendered.." + }, + { + "name": "destroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is destroyed." + }, + { + "name": "disable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is disabled." + }, + { + "name": "enable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is enabled." + }, + { + "name": "hide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is hidden." + }, + { + "name": "render", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is rendered." + }, + { + "name": "show", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is shown." + } + ], + "methods": [ + { + "name": "addEvents", + "sig": "(Object object)", + "type": "function", + "desc": "Used to define events on this Observable" + }, + { + "name": "addListener", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this component" + }, + { + "name": "capture", + "sig": "(Observable o, Function fn, Object scope)", + "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." + }, + { + "name": "destroy", + "sig": "()", + "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}." + }, + { + "name": "disable", + "sig": "()", + "type": "function", + "desc": "Disable this component." + }, + { + "name": "enable", + "sig": "()", + "type": "function", + "desc": "Enable this component." + }, + { + "name": "fireEvent", + "sig": "(String eventName, Object... args)", + "type": "function", + "desc": "Fires the specified event with the passed parameters (minus the event name)." + }, + { + "name": "focus", + "sig": "(Boolean selectText)", + "type": "function", + "desc": "Try to focus this component." + }, + { + "name": "getChildContainer", + "sig": "()", + "type": "function", + "desc": "Fetch the element to add children to" + }, + { + "name": "getEl", + "sig": "()", + "type": "function", + "desc": "Returns the underlying {@link Roo.Element}." + }, + { + "name": "getId", + "sig": "()", + "type": "function", + "desc": "Returns the id of this component." + }, + { + "name": "hasListener", + "sig": "(String eventName)", + "type": "function", + "desc": "Checks to see if this object has any listeners for a specified event" + }, + { + "name": "hide", + "sig": "()", + "type": "function", + "desc": "Hide a component - adds 'hidden' class" + }, + { + "name": "initEvents", + "sig": "()", + "type": "function", + "desc": "Initialize Events for the element" + }, + { + "name": "isVisible", + "sig": "()", + "type": "function", + "desc": "Returns true if this component is visible." + }, + { + "name": "on", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this element (shorthand for addListener)" + }, + { + "name": "purgeListeners", + "sig": "()", + "type": "function", + "desc": "Removes all listeners for this object" + }, + { + "name": "releaseCapture", + "sig": "(Observable o)", + "type": "function", + "desc": "Removes all added captures from the Observable." + }, + { + "name": "removeListener", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener" + }, + { + "name": "render", + "sig": "(String/HTMLElement/Element container)", + "type": "function", + "desc": "If this is a lazy rendering component, render it to its container element." + }, + { + "name": "setDisabled", + "sig": "(Boolean disabled)", + "type": "function", + "desc": "Convenience function for setting disabled/enabled by boolean." + }, + { + "name": "setVisible", + "sig": "(Boolean visible)", + "type": "function", + "desc": "Convenience function to hide or show this component by boolean." + }, + { + "name": "show", + "sig": "()", + "type": "function", + "desc": "Show a component - removes 'hidden' class" + }, + { + "name": "tooltipEl", + "sig": "()", + "type": "function", + "desc": "Fetch the element to display the tooltip on." + }, + { + "name": "un", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener (shorthand for removeListener)" + } + ] + }, + "Roo.mailer.Param": { + "props": [ + { + "name": "is_optional", + "type": "bool", + "desc": "", + "memberOf": "" + }, + { + "name": "type", + "type": "String", + "desc": "argument type", + "memberOf": "" + }, + { + "name": "name", + "type": "String", + "desc": "", + "memberOf": "" + }, + { + "name": "desc", + "type": "String", + "desc": "short description", + "memberOf": "" + }, + { + "name": "defaultvalue", + "type": "String", + "desc": "default value", + "memberOf": "" + }, + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "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" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "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" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "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" + } + ], + "events": [ + { + "name": "beforedestroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is destroyed. Return false to stop the destroy." + }, + { + "name": "beforehide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is hidden. Return false to stop the hide." + }, + { + "name": "beforerender", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is rendered. Return false to stop the render." + }, + { + "name": "beforeshow", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is shown. Return false to stop the show." + }, + { + "name": "childrenrendered", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires when the children have been rendered.." + }, + { + "name": "destroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is destroyed." + }, + { + "name": "disable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is disabled." + }, + { + "name": "enable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is enabled." + }, + { + "name": "hide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is hidden." + }, + { + "name": "render", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is rendered." + }, + { + "name": "show", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is shown." + } + ], + "methods": [ + { + "name": "addEvents", + "sig": "(Object object)", + "type": "function", + "desc": "Used to define events on this Observable" + }, + { + "name": "addListener", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this component" + }, + { + "name": "capture", + "sig": "(Observable o, Function fn, Object scope)", + "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." + }, + { + "name": "destroy", + "sig": "()", + "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}." + }, + { + "name": "disable", + "sig": "()", + "type": "function", + "desc": "Disable this component." + }, + { + "name": "enable", + "sig": "()", + "type": "function", + "desc": "Enable this component." + }, + { + "name": "fireEvent", + "sig": "(String eventName, Object... args)", + "type": "function", + "desc": "Fires the specified event with the passed parameters (minus the event name)." + }, + { + "name": "focus", + "sig": "(Boolean selectText)", + "type": "function", + "desc": "Try to focus this component." + }, + { + "name": "getChildContainer", + "sig": "()", + "type": "function", + "desc": "Fetch the element to add children to" + }, + { + "name": "getEl", + "sig": "()", + "type": "function", + "desc": "Returns the underlying {@link Roo.Element}." + }, + { + "name": "getId", + "sig": "()", + "type": "function", + "desc": "Returns the id of this component." + }, + { + "name": "hasListener", + "sig": "(String eventName)", + "type": "function", + "desc": "Checks to see if this object has any listeners for a specified event" + }, + { + "name": "hide", + "sig": "()", + "type": "function", + "desc": "Hide a component - adds 'hidden' class" + }, + { + "name": "initEvents", + "sig": "()", + "type": "function", + "desc": "Initialize Events for the element" + }, + { + "name": "isVisible", + "sig": "()", + "type": "function", + "desc": "Returns true if this component is visible." + }, + { + "name": "on", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this element (shorthand for addListener)" + }, + { + "name": "purgeListeners", + "sig": "()", + "type": "function", + "desc": "Removes all listeners for this object" + }, + { + "name": "releaseCapture", + "sig": "(Observable o)", + "type": "function", + "desc": "Removes all added captures from the Observable." + }, + { + "name": "removeListener", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener" + }, + { + "name": "render", + "sig": "(String/HTMLElement/Element container)", + "type": "function", + "desc": "If this is a lazy rendering component, render it to its container element." + }, + { + "name": "setDisabled", + "sig": "(Boolean disabled)", + "type": "function", + "desc": "Convenience function for setting disabled/enabled by boolean." + }, + { + "name": "setVisible", + "sig": "(Boolean visible)", + "type": "function", + "desc": "Convenience function to hide or show this component by boolean." + }, + { + "name": "show", + "sig": "()", + "type": "function", + "desc": "Show a component - removes 'hidden' class" + }, + { + "name": "tooltipEl", + "sig": "()", + "type": "function", + "desc": "Fetch the element to display the tooltip on." + }, + { + "name": "un", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener (shorthand for removeListener)" + } + ] + }, + "Roo.mailer.Section": { + "props": [ + { + "name": "stype", + "type": "String", + "desc": "section type.", + "memberOf": "", + "optvals": [ + "desc", + "parameter", + "return", + "note", + "example" + ] + }, + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "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" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "name", + "type": "string", + "desc": "Specifies name attribute", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "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" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "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" + } + ], + "events": [ + { + "name": "beforedestroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is destroyed. Return false to stop the destroy." + }, + { + "name": "beforehide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is hidden. Return false to stop the hide." + }, + { + "name": "beforerender", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is rendered. Return false to stop the render." + }, + { + "name": "beforeshow", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is shown. Return false to stop the show." + }, + { + "name": "childrenrendered", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires when the children have been rendered.." + }, + { + "name": "destroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is destroyed." + }, + { + "name": "disable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is disabled." + }, + { + "name": "enable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is enabled." + }, + { + "name": "hide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is hidden." + }, + { + "name": "render", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is rendered." + }, + { + "name": "show", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is shown." + } + ], + "methods": [ + { + "name": "addEvents", + "sig": "(Object object)", + "type": "function", + "desc": "Used to define events on this Observable" + }, + { + "name": "addListener", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this component" + }, + { + "name": "capture", + "sig": "(Observable o, Function fn, Object scope)", + "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." + }, + { + "name": "destroy", + "sig": "()", + "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}." + }, + { + "name": "disable", + "sig": "()", + "type": "function", + "desc": "Disable this component." + }, + { + "name": "enable", + "sig": "()", + "type": "function", + "desc": "Enable this component." + }, + { + "name": "fireEvent", + "sig": "(String eventName, Object... args)", + "type": "function", + "desc": "Fires the specified event with the passed parameters (minus the event name)." + }, + { + "name": "focus", + "sig": "(Boolean selectText)", + "type": "function", + "desc": "Try to focus this component." + }, + { + "name": "getChildContainer", + "sig": "()", + "type": "function", + "desc": "Fetch the element to add children to" + }, + { + "name": "getEl", + "sig": "()", + "type": "function", + "desc": "Returns the underlying {@link Roo.Element}." + }, + { + "name": "getId", + "sig": "()", + "type": "function", + "desc": "Returns the id of this component." + }, + { + "name": "hasListener", + "sig": "(String eventName)", + "type": "function", + "desc": "Checks to see if this object has any listeners for a specified event" + }, + { + "name": "hide", + "sig": "()", + "type": "function", + "desc": "Hide a component - adds 'hidden' class" + }, + { + "name": "initEvents", + "sig": "()", + "type": "function", + "desc": "Initialize Events for the element" + }, + { + "name": "isVisible", + "sig": "()", + "type": "function", + "desc": "Returns true if this component is visible." + }, + { + "name": "on", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this element (shorthand for addListener)" + }, + { + "name": "purgeListeners", + "sig": "()", + "type": "function", + "desc": "Removes all listeners for this object" + }, + { + "name": "releaseCapture", + "sig": "(Observable o)", + "type": "function", + "desc": "Removes all added captures from the Observable." + }, + { + "name": "removeListener", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener" + }, + { + "name": "render", + "sig": "(String/HTMLElement/Element container)", + "type": "function", + "desc": "If this is a lazy rendering component, render it to its container element." + }, + { + "name": "setDisabled", + "sig": "(Boolean disabled)", + "type": "function", + "desc": "Convenience function for setting disabled/enabled by boolean." + }, + { + "name": "setVisible", + "sig": "(Boolean visible)", + "type": "function", + "desc": "Convenience function to hide or show this component by boolean." + }, + { + "name": "show", + "sig": "()", + "type": "function", + "desc": "Show a component - removes 'hidden' class" + }, + { + "name": "tooltipEl", + "sig": "()", + "type": "function", + "desc": "Fetch the element to display the tooltip on." + }, + { + "name": "un", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener (shorthand for removeListener)" + } + ] + }, + "Roo.mailer.Synopsis": { + "props": [ + { + "name": "returntype", + "type": "String", + "desc": "return value", + "memberOf": "" + }, + { + "name": "name", + "type": "String", + "desc": "title really..", + "memberOf": "" + }, + { + "name": "stype", + "type": "String", + "desc": "", + "memberOf": "", + "optvals": [ + "function", + "constant" + ] + }, + { + "name": "cls", + "type": "String", + "desc": "css class", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "style", + "type": "String", + "desc": "any extra css", + "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" + }, + { + "name": "can_build_overlaid", + "type": "Boolean", + "desc": "True if element can be rebuild from a HTML page", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "dataId", + "type": "string", + "desc": "cutomer id", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "tooltip", + "type": "string", + "desc": "Text for the tooltip", + "memberOf": "Roo.bootstrap.Component" + }, + { + "name": "container_method", + "type": "string", + "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "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" + }, + { + "name": "allowDomMove", + "type": "Boolean", + "desc": "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf": "Roo.Component" + }, + { + "name": "hideMode", + "type": "String", + "desc": "How 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" + ] + }, + { + "name": "actionMode", + "type": "String", + "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "memberOf": "Roo.Component" + }, + { + "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" + } + ], + "events": [ + { + "name": "beforedestroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is destroyed. Return false to stop the destroy." + }, + { + "name": "beforehide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is hidden. Return false to stop the hide." + }, + { + "name": "beforerender", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is rendered. Return false to stop the render." + }, + { + "name": "beforeshow", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires before the component is shown. Return false to stop the show." + }, + { + "name": "childrenrendered", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires when the children have been rendered.." + }, + { + "name": "destroy", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is destroyed." + }, + { + "name": "disable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is disabled." + }, + { + "name": "enable", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is enabled." + }, + { + "name": "hide", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is hidden." + }, + { + "name": "render", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is rendered." + }, + { + "name": "show", + "sig": "function (_self)\n{\n\n}", + "type": "function", + "desc": "Fires after the component is shown." + } + ], + "methods": [ + { + "name": "addEvents", + "sig": "(Object object)", + "type": "function", + "desc": "Used to define events on this Observable" + }, + { + "name": "addListener", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this component" + }, + { + "name": "capture", + "sig": "(Observable o, Function fn, Object scope)", + "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." + }, + { + "name": "destroy", + "sig": "()", + "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}." + }, + { + "name": "disable", + "sig": "()", + "type": "function", + "desc": "Disable this component." + }, + { + "name": "enable", + "sig": "()", + "type": "function", + "desc": "Enable this component." + }, + { + "name": "fireEvent", + "sig": "(String eventName, Object... args)", + "type": "function", + "desc": "Fires the specified event with the passed parameters (minus the event name)." + }, + { + "name": "focus", + "sig": "(Boolean selectText)", + "type": "function", + "desc": "Try to focus this component." + }, + { + "name": "getChildContainer", + "sig": "()", + "type": "function", + "desc": "Fetch the element to add children to" + }, + { + "name": "getEl", + "sig": "()", + "type": "function", + "desc": "Returns the underlying {@link Roo.Element}." + }, + { + "name": "getId", + "sig": "()", + "type": "function", + "desc": "Returns the id of this component." + }, + { + "name": "hasListener", + "sig": "(String eventName)", + "type": "function", + "desc": "Checks to see if this object has any listeners for a specified event" + }, + { + "name": "hide", + "sig": "()", + "type": "function", + "desc": "Hide a component - adds 'hidden' class" + }, + { + "name": "initEvents", + "sig": "()", + "type": "function", + "desc": "Initialize Events for the element" + }, + { + "name": "isVisible", + "sig": "()", + "type": "function", + "desc": "Returns true if this component is visible." + }, + { + "name": "on", + "sig": "(String eventName, Function handler, Object scope, Object options)", + "type": "function", + "desc": "Appends an event handler to this element (shorthand for addListener)" + }, + { + "name": "purgeListeners", + "sig": "()", + "type": "function", + "desc": "Removes all listeners for this object" + }, + { + "name": "releaseCapture", + "sig": "(Observable o)", + "type": "function", + "desc": "Removes all added captures from the Observable." + }, + { + "name": "removeListener", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener" + }, + { + "name": "render", + "sig": "(String/HTMLElement/Element container)", + "type": "function", + "desc": "If this is a lazy rendering component, render it to its container element." + }, + { + "name": "setDisabled", + "sig": "(Boolean disabled)", + "type": "function", + "desc": "Convenience function for setting disabled/enabled by boolean." + }, + { + "name": "setVisible", + "sig": "(Boolean visible)", + "type": "function", + "desc": "Convenience function to hide or show this component by boolean." + }, + { + "name": "show", + "sig": "()", + "type": "function", + "desc": "Show a component - removes 'hidden' class" + }, + { + "name": "tooltipEl", + "sig": "()", + "type": "function", + "desc": "Fetch the element to display the tooltip on." + }, + { + "name": "un", + "sig": "(String eventName, Function handler, Object scope)", + "type": "function", + "desc": "Removes a listener (shorthand for removeListener)" + } + ] + }, "Roo.menu": { "props": [], "events": [],