|
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component |
| anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered
by a Container which has been configured to use an AnchorLayout
based layout manager, for example:
@@ -21,7 +24,7 @@ element's parent node will automatically be used as the component's container.
| Component |
| autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component |
| cancelText : String The text to display on the cancel button (defaults to 'Cancel') | DatePicker |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+them on render (defaults to false). | Component |
| cancelText : String The text to display on the cancel button (defaults to 'Cancel' ) | DatePicker |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide field clearing (defaults to
'x-form-clear-left').
@@ -31,7 +34,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also. | Component |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component |
| ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component |
| contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this comp... Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this component.
+
+- Description :
+
This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+
The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items .
+Add either the x-hidden or the x-hide-display CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.
+ | Component |
| ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for
adding customized styles to the container or any of its children using standard CSS rules. See
Ext.layout.ContainerLayout.extraCls also.
@@ -42,22 +59,23 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox): ctCls: 'x-box-layout-ct custom-class'
- | Component |
| dayNames : Array An array of textual day names which can be overriden for localization support (defaults to Date.dayNames) | DatePicker |
| disabled : Boolean Render this component disabled (default is false). | Component |
| disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component |
| disabledDates : ArrayAn array of 'dates' to disable, as strings. These strings will be used to build a dynamic regular
-expression so they... An array of 'dates' to disable, as strings. These strings will be used to build a dynamic regular
-expression so they are very powerful. Some examples:
-
-- ['03/08/2003', '09/16/2003'] would disable those exact dates
-- ['03/08', '09/16'] would disable those days for every year
-- ['^03/08'] would only match the beginning (useful if you are using short years)
-- ['03/../2006'] would disable every day in March 2006
-- ['^03'] would disable every day in every March
-
-Note that the format of the dates included in the array should exactly match the format config.
-In order to support regular expressions, if you are using a date format that has '.' in it, you will have to
-escape the dot when restricting dates. For example: ['03\\.08\\.03']. | DatePicker |
| disabledDatesRE : RegExpJavaScript regular expression used to disable a pattern of dates (defaults to null). The disabledDates
-config will ... JavaScript regular expression used to disable a pattern of dates (defaults to null). The disabledDates
-config will generate this regex internally, but if you specify disabledDatesRE it will take precedence over the
-disabledDates value. | DatePicker |
| disabledDatesText : String The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') | DatePicker |
| disabledDays : Array An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null). | DatePicker |
| disabledDaysText : String The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') | DatePicker |
| fieldLabel : StringThe label text to display next to this Component (defaults to '').
+ | Component |
| data : MixedThe initial set of data to apply to the tpl to
+update the content area of the Component. | Component |
| dayNames : Array An array of textual day names which can be overriden for localization support (defaults to Date.dayNames) | DatePicker |
| disabled : Boolean Render this component disabled (default is false). | Component |
| disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component |
| disabledDates : ArrayAn array of 'dates' to disable, as strings. These strings will be used to build a dynamic regular
+expression so they ... An array of 'dates' to disable, as strings. These strings will be used to build a dynamic regular
+expression so they are very powerful. Some examples:
+
+- ['03/08/2003', '09/16/2003'] would disable those exact dates
+- ['03/08', '09/16'] would disable those days for every year
+- ['^03/08'] would only match the beginning (useful if you are using short years)
+- ['03/../2006'] would disable every day in March 2006
+- ['^03'] would disable every day in every March
+
+Note that the format of the dates included in the array should exactly match the format config.
+In order to support regular expressions, if you are using a date format that has '.' in it, you will have to
+escape the dot when restricting dates. For example: ['03\\.08\\.03']. | DatePicker |
| disabledDatesRE : RegExpJavaScript regular expression used to disable a pattern of dates (defaults to null). The disabledDates
+config will g... JavaScript regular expression used to disable a pattern of dates (defaults to null). The disabledDates
+config will generate this regex internally, but if you specify disabledDatesRE it will take precedence over the
+disabledDates value. | DatePicker |
| disabledDatesText : String The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled' ) | DatePicker |
| disabledDays : Array An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null). | DatePicker |
| disabledDaysText : String The tooltip to display when the date falls on a disabled day (defaults to 'Disabled' ) | DatePicker |
| fieldLabel : StringThe label text to display next to this Component (defaults to '').
Note: this config is only used when this Component... The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component is rendered by a Container which
has been configured to use the FormLayout layout manager (e.g.
@@ -71,13 +89,13 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component |
| format : StringThe default date format string which can be overriden for localization support. The format must be
-valid according ... The default date format string which can be overriden for localization support. The format must be
-valid according to Date.parseDate (defaults to 'm/d/y'). | DatePicker |
| handler : FunctionOptional. A function that will handle the select event of this picker.
-The handler is passed the following parameter... Optional. A function that will handle the select event of this picker.
-The handler is passed the following parameters:
-picker : DatePickerThe Ext.DatePicker.
-date : DateThe selected date.
+}); | Component |
| format : StringThe default date format string which can be overriden for localization support. The format must be
+valid according t... The default date format string which can be overriden for localization support. The format must be
+valid according to Date.parseDate (defaults to 'm/d/y' ). | DatePicker |
| handler : FunctionOptional. A function that will handle the select event of this picker.
+The handler is passed the following parameters... Optional. A function that will handle the select event of this picker.
+The handler is passed the following parameters:
+picker : DatePickerThis DatePicker.
+date : DateThe selected date.
| DatePicker |
| hidden : BooleanRender this component hidden (default is false). If true, the
hide method will be called internally. | Component |
| hideLabel : Booleantrue to completely hide the label element
(label and separator). Defaults to false.
@@ -103,7 +121,11 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). | Component |
| hideParent : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component |
| id : StringThe unique id of this component (defaults to an auto-assigned id).
+button on a window by setting hide:true on the button when adding it to its parent container. | Component |
| html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component |
| id : StringThe unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to access the component later and you do
not have an object reference available (e.g., using Ext.getCmp).
@@ -270,7 +292,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable |
| maxDate : Date Maximum allowable date (JavaScript date object, defaults to null) | DatePicker |
| maxText : String The error text to display if the maxDate validation fails (defaults to 'This date is after the maximum date') | DatePicker |
| minDate : Date Minimum allowable date (JavaScript date object, defaults to null) | DatePicker |
| minText : String The error text to display if the minDate validation fails (defaults to 'This date is before the minimum date') | DatePicker |
| monthNames : Array An array of textual month names which can be overriden for localization support (defaults to Date.monthNames) | DatePicker |
| monthYearText : String The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)') | DatePicker |
| nextText : String The next month navigation button tooltip (defaults to 'Next Month (Control+Right)') | DatePicker |
| okText : String The text to display on the ok button (defaults to ' OK ' to give the user extra clicking room) | DatePicker |
| overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+}); | Observable |
| maxDate : Date Maximum allowable date (JavaScript date object, defaults to null) | DatePicker |
| maxText : String The error text to display if the maxDate validation fails (defaults to 'This date is after the maximum date' ) | DatePicker |
| minDate : Date Minimum allowable date (JavaScript date object, defaults to null) | DatePicker |
| minText : String The error text to display if the minDate validation fails (defaults to 'This date is before the minimum date' ) | DatePicker |
| monthNames : Array An array of textual month names which can be overriden for localization support (defaults to Date.monthNames) | DatePicker |
| monthYearText : String The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)' ) | DatePicker |
| nextText : String The next month navigation button tooltip (defaults to 'Next Month (Control+Right)' ) | DatePicker |
| okText : String The text to display on the ok button (defaults to ' OK ' to give the user extra clicking room) | DatePicker |
| overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component |
| plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
@@ -278,7 +300,7 @@ requirement for a ... An object or array of objects that
requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
When a component is created, if any plugins are available, the component will call the init method on each
plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component |
| prevText : String The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)') | DatePicker |
| ptype : StringThe registered ptype to create. This config option is not used when passing
+component as needed to provide its functionality. | Component |
| prevText : String The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)' ) | DatePicker |
| ptype : StringThe registered ptype to create. This config option is not used when passing
a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
a config object into a constructor. This config option is used only when
lazy instantiation is being used, and a Plugin is being
@@ -287,9 +309,9 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create.
If you create your own Plugins, you may register them using
Ext.ComponentMgr.registerPlugin in order to be able to
-take advantage of lazy instantiation and rendering. | Component |
| ref : StringA path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering. | Component |
| ref : StringA path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
The ancestor axis can be traversed by using '/' characters in the path.
For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar: var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -308,9 +330,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
- In the code above, if the ref had been 'saveButton' the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt. | Component |
| renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component |
| renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
will be rendered into.
Notes ... Specify the id of the element, a DOM element or an existing Element that this component
will be rendered into.
@@ -322,10 +345,10 @@ to render and manage its child items.
When using this config, a call to render() is not required.
- See render also. | Component |
| scope : ObjectThe scope ( this reference) in which the handler
-function will be called. Defaults to this DatePicker instance. | DatePicker |
| showToday : BooleanFalse to hide the footer area containing the Today button and disable the keyboard handler for spacebar
-that selects... False to hide the footer area containing the Today button and disable the keyboard handler for spacebar
-that selects the current date (defaults to true). | DatePicker |
| startDay : Number Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) | DatePicker |
| stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+ See render also. | Component |
| scope : ObjectThe scope ( this reference) in which the handler
+function will be called. Defaults to this DatePicker instance. | DatePicker |
| showToday : BooleanFalse to hide the footer area containing the Today button and disable the keyboard handler for spacebar
+that selects ... False to hide the footer area containing the Today button and disable the keyboard handler for spacebar
+that selects the current date (defaults to true ). | DatePicker |
| startDay : Number Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) | DatePicker |
| stateEvents : ArrayAn array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents may be any type
of event supported by this component, including browser or custom events
@@ -395,7 +418,19 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component |
| todayText : String The text to display on the button that selects the current date (defaults to 'Today') | DatePicker |
| todayTip : String The tooltip to display for the button that selects the current date (defaults to '{current date} (Spacebar)') | DatePicker |
| xtype : StringThe registered xtype to create. This config option is not used when passing
+}); | Component |
| todayText : String The text to display on the button that selects the current date (defaults to 'Today' ) | DatePicker |
| todayTip : StringA string used to format the message for displaying in a tooltip over the button that
+selects the current date. Defaul... A string used to format the message for displaying in a tooltip over the button that
+selects the current date. Defaults to '{0} (Spacebar)' where
+the {0} token is replaced by today's date. | DatePicker |
| tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and... | Component |
| tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X... The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite ). | Component |
| xtype : StringThe registered xtype to create. This config option is not used when passing
a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
a config object into a constructor. This config option is used only when
lazy instantiation is being used, and a child item of a Container is being
@@ -426,8 +461,10 @@ config for a suggestion, or use a render listener directly: new
See also getEl
| Component |
| hidden : Boolean True if this component is hidden. Read-only. | Component |
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component |
| ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a Container). Read-only.
- Note: to access items within the Container see itemId. | Component |
| rendered : Boolean True if this component has been rendered. Read-only. | Component |