X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.DatePicker.json;fp=docs%2Fsymbols%2FRoo.DatePicker.json;h=b59dbe1e09d825245505ffc1ad04c7e69f978006;hp=d92804bdfeff185050106d9e7c23edc6fdea15a6;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.DatePicker.json b/docs/symbols/Roo.DatePicker.json index d92804bdfe..b59dbe1e09 100644 --- a/docs/symbols/Roo.DatePicker.json +++ b/docs/symbols/Roo.DatePicker.json @@ -4,10 +4,15 @@ "Roo.Component", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "Simple date picker class.", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "DatePicker", "example" : "", "deprecated" : "", @@ -22,205 +27,183 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "startDay", "type" : "Number", "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "monthYearText", "type" : "String", "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "monthNames", "type" : "Array", "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "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" : "format", "type" : "String", "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "nextText", "type" : "String", "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "maxText", "type" : "String", "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "constrainToViewport", "type" : "Boolean", "desc" : "True to constrain the date picker to the viewport (defaults to true)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "minText", "type" : "String", "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "disabledDatesText", "type" : "String", "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "todayTip", "type" : "String", "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "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" : "todayText", "type" : "String", "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "cancelText", "type" : "String", "desc" : "The text to display on the cancel button", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "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" : "showClear", "type" : "Bool", "desc" : "Show a clear button (usefull for date form elements that can be blank.)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "prevText", "type" : "String", "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "dayNames", "type" : "Array", "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "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" : "disabledDaysText", "type" : "String", "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "disabledDatesRE", "type" : "RegExp", "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "minDate", "type" : "Date", "desc" : "Minimum allowable date (JavaScript date object, defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "disabledDays", "type" : "Array", "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "okText", "type" : "String", "desc" : "The text to display on the ok button", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "name" : "maxDate", "type" : "Date", "desc" : "Maximum allowable date (JavaScript date object, defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "Roo.DatePicker" }, { "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" : "getValue", + "type" : "function", "desc" : "Gets the current selected value of the date field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DatePicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -232,15 +215,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the value of the date field", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DatePicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -253,15 +241,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" : [ { @@ -273,15 +266,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", @@ -294,43 +292,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", @@ -343,15 +356,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" : [ { @@ -363,15 +381,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", @@ -390,15 +413,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" : [ { @@ -410,15 +438,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" : [ { @@ -430,15 +463,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", @@ -457,15 +495,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" : [ { @@ -477,15 +520,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" : [ { @@ -497,29 +545,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", @@ -550,15 +608,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", @@ -583,15 +646,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", @@ -604,15 +672,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", @@ -625,15 +698,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", @@ -658,15 +736,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", @@ -691,15 +774,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", @@ -718,15 +806,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", @@ -751,15 +844,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", @@ -792,8 +890,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.DatePicker", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -816,8 +916,10 @@ }, { "name" : "monthchange", + "type" : "function", "desc" : "Fires when the displayed month changes", - "memberOf" : "Roo.DatePicker", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -840,7 +942,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" : "", @@ -858,7 +962,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -876,7 +982,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -894,7 +1002,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -912,7 +1022,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -930,7 +1042,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" : "", @@ -948,7 +1062,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -966,7 +1082,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" : "", @@ -984,7 +1102,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1002,7 +1122,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" : "",