X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..05ce1c11e98b33f14ddee184493bd5a60dc947e2:/docs/output/Ext.form.HtmlEditor.html diff --git a/docs/output/Ext.form.HtmlEditor.html b/docs/output/Ext.form.HtmlEditor.html index d5bc28a9..08312a56 100644 --- a/docs/output/Ext.form.HtmlEditor.html +++ b/docs/output/Ext.form.HtmlEditor.html @@ -1,317 +1,158 @@ -
Observable - Component - BoxComponent - Field - HtmlEditor
Package: | Ext.form |
Defined In: | HtmlEditor.js |
Class: | HtmlEditor |
Extends: | Field |
// Simple example rendered with default options:
-Ext.QuickTips.init(); // enable tooltips
-new Ext.form.HtmlEditor({
- renderTo: Ext.getBody(),
- width: 800,
- height: 300
-});
-
-// Passed via xtype into a container and with custom options:
-Ext.QuickTips.init(); // enable tooltips
-new Ext.Panel({
- title: 'HTML Editor',
- renderTo: Ext.getBody(),
- width: 600,
- height: 300,
- frame: true,
- layout: 'fit',
+Observable
Component
BoxComponent
Field
HtmlEditor
Class Ext.form.HtmlEditor
Package: Ext.form Defined In: HtmlEditor.js Class: HtmlEditor Extends: Field xtype: htmleditor
Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be
+automatically hidden when needed. These are noted in the config options where appropriate.
+
The editor's toolbar buttons have tooltips defined in the buttonTips property, but they are not
+enabled by default unless the global Ext.QuickTips singleton is initialized.
+
Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT
+supported by this editor.
+
An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within
+any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.
+
Example usage:
+// Simple example rendered with default options:
+Ext.QuickTips.init(); // enable tooltips
+new Ext.form.HtmlEditor({
+ renderTo: Ext.getBody(),
+ width: 800,
+ height: 300
+});
+
+// Passed via xtype into a container and with custom options:
+Ext.QuickTips.init(); // enable tooltips
+new Ext.Panel({
+ title: 'HTML Editor',
+ renderTo: Ext.getBody(),
+ width: 600,
+ height: 300,
+ frame: true,
+ layout: 'fit',
+ items: {
+ xtype: 'htmleditor',
+ enableColors: false,
+ enableAlignments: false
+ }
+});
Config Options
Config Options Defined By 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:
+- Ext.form.FormPanel
+- specifying
layout: 'anchor' // or 'form', or 'absolute'
+
+See Ext.layout.AnchorLayout.anchor also.
Component autoEl : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne...A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
+and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex
+DOM structure created by their own onRender methods.
+This is intended to allow the developer to create application-specific utility Components encapsulated by
+different DOM elements. Example usage:
{
+ xtype: 'box',
+ autoEl: {
+ tag: 'img',
+ src: 'http://www.example.com/example.jpg'
+ }
+}, {
+ xtype: 'box',
+ autoEl: {
+ tag: 'blockquote',
+ html: 'autoEl is cool!'
+ }
+}, {
+ xtype: 'container',
+ autoEl: 'ul',
+ cls: 'ux-unordered-list',
items: {
- xtype: 'htmleditor',
- enableColors: false,
- enableAlignments: false
+ xtype: 'box',
+ autoEl: 'li',
+ html: 'First list item'
}
-});
-
-
-
- Config Options
-
-
- Config Options
- Defined By
-
-
-
-
-
- autoEl : String/Object
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...
-
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage: {xtype:'box', autoEl: 'div', cls:'my-class'}
-{xtype:'box', autoEl: {tag:'blockquote', html:'autoEl is cool!'}} // with DomHelper
-
-
- Component
-
-
-
-
-
- autoShow : Boolean
- True 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
-
-
-
-
-
- clearCls : String
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...
-
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
-
-
- Component
-
-
-
-
-
- createLinkText : String
- The default text for the create link prompt
-
- HtmlEditor
-
-
-
-
-
- ctCls : String
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
-
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
-
-
- Component
-
-
-
-
-
- defaultLinkValue : String
- The default value for the create link prompt (defaults to http:/ /)
-
- HtmlEditor
-
-
-
-
-
- enableAlignments : Boolean
- Enable the left, center, right alignment buttons (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableColors : Boolean
- Enable the fore/highlight color buttons (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableFont : Boolean
- Enable font selection. Not available in Safari. (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableFontSize : Boolean
- Enable the increase/decrease font size buttons (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableFormat : Boolean
- Enable the bold, italic and underline buttons (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableLinks : Boolean
- Enable the create link button. Not available in Safari. (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableLists : Boolean
- Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- enableSourceEdit : Boolean
- Enable the switch to source edit button. Not available in Safari. (defaults to true)
-
- HtmlEditor
-
-
-
-
-
- fieldLabel : String
- The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...
-
- The label text to display next to this Component (defaults to '') This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
Example use:new Ext.FormPanel({
+}
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 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').
+
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. Ext.form.FormPanel or specifying layout:'form') and either a
+fieldLabel is specified or isFormField=true is specified.
+See Ext.layout.FormLayout.fieldTpl also.
Component createLinkText : StringThe default text for the create link prompt HtmlEditor 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.
+Note: ctCls defaults to '' except for the following class
+which assigns a value by default:
+
+- Box Layout : 'x-box-layout-ct'
+
+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 defaultLinkValue : StringThe default value for the create link prompt (defaults to http:/ /) HtmlEditor defaultValue : StringA default value to be put into the editor to resolve focus issues (defaults to ​ (Zero-width space), (No...A default value to be put into the editor to resolve focus issues (defaults to (Zero-width space), (Non-breaking space) in Opera and IE6). HtmlEditor enableAlignments : BooleanEnable the left, center, right alignment buttons (defaults to true) HtmlEditor enableColors : BooleanEnable the fore/highlight color buttons (defaults to true) HtmlEditor enableFont : BooleanEnable font selection. Not available in Safari. (defaults to true) HtmlEditor enableFontSize : BooleanEnable the increase/decrease font size buttons (defaults to true) HtmlEditor enableFormat : BooleanEnable the bold, italic and underline buttons (defaults to true) HtmlEditor enableLinks : BooleanEnable the create link button. Not available in Safari. (defaults to true) HtmlEditor enableLists : BooleanEnable the bullet and numbered list buttons. Not available in Safari. (defaults to true) HtmlEditor enableSourceEdit : BooleanEnable the switch to source edit button. Not available in Safari. (defaults to true) HtmlEditor 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.
+Ext.form.FormPanel or specifying layout:'form').
+Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
-
-
- Component
-
-
-
-
-
- fontFamilies : Array
- An array of available font families
-
- HtmlEditor
-
-
-
-
-
- height : Number
- The height of this component in pixels (defaults to auto).
-
- BoxComponent
-
-
-
-
-
- Render this component hidden (default is false).
-
-
- hidden : Boolean Component
-
-
-
-
-
- hideLabel : Boolean
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...
-
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
Example use:new Ext.FormPanel({
+});
Component fontFamilies : ArrayAn array of available font families HtmlEditor height : NumberThe height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset s...The height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset see Ext.Component.anchor. BoxComponent 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.
+By default, even if you do not sp...true to completely hide the label element
+(label and separator). Defaults to false.
+By default, even if you do not specify a fieldLabel the space will still be
+reserved so that the field will line up with other fields that do have labels.
+Setting this to true will cause the field to not reserve that space.
+
Note: see the note for clearCls.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: 'textfield'
hideLabel: true
}]
-});
-
-
- Component
-
-
-
-
-
- hideMode : String
- How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...
-
- How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.
-
-
- Component
-
-
-
-
-
- hideParent : Boolean
- True 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 : String
- The 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.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.
-
-
- Component
-
-
-
-
-
- itemCls : String
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...
-
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
Example use:// Apply a style to the field's label:
+});
Component hideMode : StringHow this component should be hidden. Supported values are 'visibility'
+(css visibility), 'offsets' (negative offset p...How this component should be hidden. Supported values are 'visibility'
+(css visibility), 'offsets' (negative offset position) and 'display'
+(css display).
+
Note: the default of 'display' is generally preferred
+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).
+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).
+Note that this id will also be used as the element id for the containing HTML element
+that is rendered to the page for this component. This allows you to write id-based CSS
+rules to style the specific instance of this component uniquely, and also to select
+sub-elements using this component's id as the parent.
+Note: to avoid complications imposed by a unique id also see
+itemId
and ref
.
+Note: to access the container of an item see ownerCt
.
Component itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...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.
+Ext.form.FormPanel or specifying layout:'form').
+An additional CSS class to apply to the div wrapping the form item
+element of this field. If supplied, itemCls at the field level will override
+the default itemCls supplied at the container level. The value specified for
+itemCls will be added to the default class ('x-form-item').
+Since it is applied to the item wrapper (see
+Ext.layout.FormLayout.fieldTpl), it allows
+you to write standard CSS rules that can apply to the field, the label (if specified), or
+any other element within the markup for the field.
+
Note: see the note for fieldLabel.
+Example use:// Apply a style to the field's label:
<style>
- .required .x-form-item-label {font-weight:bold;color:red;}
+ .required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
@@ -320,44 +161,77 @@ Ext.QuickTips.init(); // enable tooltips
items: [{
xtype: 'textfield',
fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
+ itemCls: 'required' //this label will be styled
},{
xtype: 'textfield',
fieldLabel: 'Favorite Color'
}]
-});
-
-
- Component
-
-
-
-
-
- labelSeparator : String
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
Example use:new Ext.FormPanel({
+});
Component itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. ...An itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. Instead of using an id
with
+Ext.getCmp, use itemId
with
+Ext.Container.getComponent which will retrieve
+itemId
's or id's. Since itemId
's are an index to the
+container's internal MixedCollection, the itemId
is scoped locally to the container --
+avoiding potential conflicts with Ext.ComponentMgr which requires a unique
+id
.
+var c = new Ext.Panel({ //
+ height: 300,
+ renderTo: document.body,
+ layout: 'auto',
+ items: [
+ {
+ itemId: 'p1',
+ title: 'Panel 1',
+ height: 150
+ },
+ {
+ itemId: 'p2',
+ title: 'Panel 2',
+ height: 150
+ }
+ ]
+})
+p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
+p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
+
+Note: to access the container of an item see ownerCt.
Component labelSeparator : StringThe separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The o...The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The order of precedence is:
+
+- field / component level
+- container level
+- layout level (defaults to colon ':')
+
+To display no separator for this field's label specify empty string ''.
+
Note: see the note for clearCls.
+Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
+ layoutConfig: {
+ labelSeparator: '~' // layout config has lowest priority (defaults to ':')
+ },
+ labelSeparator: '>>', // config at container level
items: [{
xtype: 'textfield',
- fieldLabel: 'Name',
- labelSeparator: '...'
+ fieldLabel: 'Field 1',
+ labelSeparator: '...' // field/component level config supersedes others
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
-
-
- Component
-
-
-
-
-
- labelStyle : String
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').
. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.
Example use:new Ext.FormPanel({
+});
Component labelStyle : StringA CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle val...A CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle value if set (e.g.,
+Ext.layout.FormLayout.labelStyle , or '').
+
Note: see the note for clearCls
.
+Also see hideLabel
and
+Ext.layout.FormLayout.fieldTpl.
+Example use:new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
@@ -365,1937 +239,694 @@ Ext.QuickTips.init(); // enable tooltips
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
-
-
- Component
-
-
-
-
-
- listeners : Object
- (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
-
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
-
-
- Observable
-
-
-
-
-
- name : String
- The field's HTML name attribute (defaults to "").
-
- Field
-
-
-
-
-
- overCls : String
- An 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
-
-
-
-
-
- pageX : Number
- The page level x coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
-
-
- pageY : Number
- The page level y coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
-
-
- plugins : Object/Array
- An object or array of objects that will provide custom functionality for this component. The only requirement for a v...
-
- An object or array of objects that will provide custom functionality for this component. The only 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
-
-
-
-
-
- renderTo : Mixed
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
-
-
- Component
-
-
-
-
-
- stateEvents : Array
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
-
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). See stateful for an explanation of saving and restoring Component state.
-
-
- Component
-
-
-
-
-
- stateId : String
- The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...
-
- The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). See stateful for an explanation of saving and restoring Component state.
-
-
- Component
-
-
-
-
-
- stateful : Boolean
- A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...
-
- A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.
For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available.
To set the state provider for the current page:
Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
Components attempt to save state when one of the events listed in the stateEvents configuration fires.
You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events
-
-
- Component
-
-
-
-
-
- value : Mixed
- A value to initialize this field with (defaults to undefined).
-
- Field
-
-
-
-
-
- width : Number
- The width of this component in pixels (defaults to auto).
-
- BoxComponent
-
-
-
-
-
- x : Number
- The local x (left) coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
-
-
- xtype : String
- The 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 specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create.
The predefined xtypes are listed here.
If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering.
-
-
- Component
-
-
-
-
-
- y : Number
- The local y (top) coordinate for this component if contained within a positioning container.
-
- BoxComponent
-
-
-
- Public Properties
-
-
- Property
- Defined By
-
-
-
-
-
- buttonTips : Object
- Object collection of toolbar tooltips for the buttons in the editor. The key
-is the command id associated with that b...
-
- Object collection of toolbar tooltips for the buttons in the editor. The key
-is the command id associated with that button and the value is a valid QuickTips object.
-For example:
-{
- bold : {
- title: 'Bold (Ctrl+B)',
- text: 'Make the selected text bold.',
- cls: 'x-html-editor-tip'
+});
Component listeners : ObjectA config object containing one or more event handlers to be added to this
+object during initialization. This should ...A config object containing one or more event handlers to be added to this
+object during initialization. This should be a valid listeners config object as specified in the
+addListener example for attaching multiple handlers at once.
+
DOM events from ExtJs Components
+
While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the DataView's
+click
event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the Element after the Component
+has been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.
+// The Component is appended to the argument list of all handler functions.
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: function(config) {
+ this.listeners = config.listeners ? config.listeners : config;
},
- italic : {
- title: 'Italic (Ctrl+I)',
- text: 'Make the selected text italic.',
- cls: 'x-html-editor-tip'
+
+ // Component passes itself into plugin's init method
+ init: function(c) {
+ var p, l = this.listeners;
+ for (p in l) {
+ if (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } else {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ // Add the listeners to the Element immediately following the render call
+ c.render = c.render.createSequence(function() {
+ var e = c.getEl();
+ if (e) {
+ e.on(l);
+ }
+ });
},
- ...
-
-
- HtmlEditor
-
-
-
-
-
-
-True if this component is hidden. Read-only.
-
-
- hidden : Boolean Component
-
-
-
-
-
- initialConfig : Object
- This Component's initial configuration specification. Read-only.
-
- Component
-
-
-
-
-
- ownerCt : Ext.Container
- The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a...
-
- The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
-
-
- Component
-
-
-
-
-
- rendered : Boolean
- True if this component has been rendered. Read-only.
-
- Component
-
-
-
- Public Methods
-
-
- Method
- Defined By
-
-
-
-
-
- HtmlEditor( Object config
)
- Create a new HtmlEditor
-
- Create a new HtmlEditor
- Parameters:
- config
: Object
- Returns:
-
-
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- addClass( string cls
) : void
- Adds a CSS class to the component's underlying element.
-
- Adds a CSS class to the component's underlying element.
- Parameters:
- cls
: stringThe CSS class name to add
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- addEvents( Object object
) : void
- Used to define events on this Observable
-
- Used to define events on this Observable
- Parameters:
- object
: ObjectThe object with the events defined
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- addListener( String eventName
, Function handler
, [Object scope
], [Object options
] ) : void
- Appends an event handler to this component
-
- Appends an event handler to this component
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context.options
: Object(optional) An object containing handler configuration
+
+ createHandler: function(fn, c) {
+ return function(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+var combo = new Ext.form.ComboBox({
+
+ // Collapse combo when its element is clicked on
+ plugins: [ new Ext.DomObserver({
+ click: function(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: 'local',
+ triggerAction: 'all'
+});
Observable margins : ObjectNote: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the...Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the BorderLayout
+or one of the two BoxLayout subclasses.
+An object containing margins to apply to this BoxComponent in the
+format:
{
+ top: (top margin),
+ right: (right margin),
+ bottom: (bottom margin),
+ left: (left margin)
+}
+May also be a string containing space-separated, numeric margin values. The order of the
+sides associated with each value matches the way CSS processes margin values:
+
+- If there is only one value, it applies to all sides.
+- If there are two values, the top and bottom borders are set to the first value and the
+right and left are set to the second.
+- If there are three values, the top is set to the first value, the left and right are set
+to the second, and the bottom is set to the third.
+- If there are four values, they apply to the top, right, bottom, and left, respectively.
+
+Defaults to:
{top:0, right:0, bottom:0, left:0}
BoxComponent name : StringThe field's HTML name attribute (defaults to '').
+Note: this property must be set if this field is to be automaticall...The field's HTML name attribute (defaults to '').
+Note: this property must be set if this field is to be automatically included with
+form submit(). Field 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 pageX : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe page level y coordinate for this component if contained within a positioning container. BoxComponent plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+requirement for a ...An object or array of objects that will provide custom functionality for this component. The only
+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 preventMark : Booleantrue to disable marking the field invalid.
+Defaults to false. Field 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
+specified not as a fully instantiated Component, but as a Component config
+object. The ptype will be looked up at render time up to determine what
+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.
+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',
+ store: myStore,
+ colModel: myColModel,
+ tbar: [{
+ text: 'Save',
+ handler: saveChanges,
+ disabled: true,
+ ref: '../saveButton'
+ }],
+ listeners: {
+ afteredit: function() {
+// The button reference is in the GridPanel
+ myGrid.saveButton.enable();
+ }
+ }
+});
+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 region : StringNote: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the...Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the BorderLayout
+layout manager (e.g. specifying layout:'border').
+See Ext.layout.BorderLayout also.
BoxComponent 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.
+- Notes :
+Do not use this option if the Component is to be a child item of
+a Container. It is the responsibility of the
+Container's layout manager
+to render and manage its child items.
+When using this config, a call to render() is not required.
+
+
+See render also.
Component 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
+(e.g., ['click', 'customerchange']).
+See stateful
for an explanation of saving and
+restoring Component state.
Component stateId : StringThe unique id for this component to use for state management purposes
+(defaults to the component id if one was set, o...The unique id for this component to use for state management purposes
+(defaults to the component id if one was set, otherwise null if the
+component is using a generated id).
+See stateful
for an explanation of saving and
+restoring Component state.
Component stateful : BooleanA flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startu...A flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startup. The component must have
+either a stateId
or id
assigned
+for state to be managed. Auto-generated ids are not guaranteed to be stable
+across page loads and cannot be relied upon to save and restore the same
+state for a component.
+
For state saving to work, the state manager's provider must have been
+set to an implementation of Ext.state.Provider which overrides the
+set and get
+methods to save and recall name/value pairs. A built-in implementation,
+Ext.state.CookieProvider is available.
+To set the state provider for the current page:
+Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
+ expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
+}));
+A stateful Component attempts to save state when one of the events
+listed in the stateEvents
configuration fires.
+To save state, a stateful Component first serializes its state by
+calling getState
. By default, this function does
+nothing. The developer must provide an implementation which returns an
+object hash which represents the Component's restorable state.
+The value yielded by getState is passed to Ext.state.Manager.set
+which uses the configured Ext.state.Provider to save the object
+keyed by the Component's stateId
, or, if that is not
+specified, its id
.
+During construction, a stateful Component attempts to restore
+its state by calling Ext.state.Manager.get passing the
+stateId
, or, if that is not specified, the
+id
.
+The resulting object is passed to applyState
.
+The default implementation of applyState
simply copies
+properties into the object, but a developer may override this to support
+more behaviour.
+You can perform extra processing on state save and restore by attaching
+handlers to the beforestaterestore, staterestore,
+beforestatesave and statesave events.
Component tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML...Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. Ext.QuickTips.init()
+must be called in order for the tips to render. BoxComponent value : MixedA value to initialize this field with (defaults to undefined). Field width : NumberThe width of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset se...The width of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset see Ext.Component.anchor. BoxComponent x : NumberThe local x (left) coordinate for this component if contained within a positioning container. BoxComponent 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
+specified not as a fully instantiated Component, but as a Component config
+object. The xtype will be looked up at render time up to determine what
+type of child Component to create.
+The predefined xtypes are listed here.
+
+If you subclass Components to create your own Components, you may register
+them using Ext.ComponentMgr.registerType in order to be able to
+take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By buttonTips : ObjectObject collection of toolbar tooltips for the buttons in the editor. The key
+is the command id associated with that ...Object collection of toolbar tooltips for the buttons in the editor. The key
+is the command id associated with that button and the value is a valid QuickTips object.
+For example:
+{
+ bold : {
+ title: 'Bold (Ctrl+B)',
+ text: 'Make the selected text bold.',
+ cls: 'x-html-editor-tip'
+ },
+ italic : {
+ title: 'Italic (Ctrl+I)',
+ text: 'Make the selected text italic.',
+ cls: 'x-html-editor-tip'
+ },
+ ...
HtmlEditor el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+This will usually be a <DIV> element created by the ...The Ext.Element which encapsulates this Component. Read-only.
+This will usually be a <DIV> element created by the class's onRender method, but
+that may be overridden using the autoEl
config.
+
Note: this element will not be available until this Component has been rendered.
+To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners
+config for a suggestion, or use a render listener directly:
new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
+See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component originalValue : mixedThe original value of the field as configured in the value configuration, or
+as loaded by the last form load operatio...The original value of the field as configured in the value configuration, or
+as loaded by the last form load operation if the form's trackResetOnLoad
+setting is true
. Field ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... Component rendered : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By HtmlEditor( Object config
)
+ Create a new HtmlEditorCreate a new HtmlEditorParameters:config
: Object
Returns:- void
xtype: htmleditor
HtmlEditor addClass( string cls
)
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object|String o
, string Optional.
)
+ :
+ voidAdds the specified events to the list of events which this Observable may fire.Adds the specified events to the list of events which this Observable may fire.Parameters:o
: Object|StringEither an object with event names as properties with a value of true
+or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
Observable addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object.Appends an event handler to this object.Parameters:eventName
: StringThe name of the event to listen for.handler
: FunctionThe method the event invokes.scope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
-- scope : Object
The scope in which to execute the handler function. The handler function's "this" context.
-- delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
-- single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
-- buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
+
- scope : ObjectThe scope (
this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
+- delay : NumberThe number of milliseconds to delay the invocation of the handler after the event fires.
+- single : BooleanTrue to add a handler to handle just the next firing of the event, and then remove itself.
+- buffer : NumberCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is not invoked, but the new handler is scheduled in its place.
+handler is not invoked, but the new handler is scheduled in its place.
+- target : ObservableOnly call the handler if the event was fired on the target Observable, not
+if the event was bubbled up from a child Observable.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-
el.on('click', this.onClick, this, {
- single: true,
- delay: 100,
- forumId: 4
+A delayed, one-time listener.
+myDataView.on('click', this.onClick, this, {
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
-
foo.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+myGridPanel.on({
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
-
foo.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- cleanHtml( String html
) : String
- Protected method that will not generally be called directly. If you need/want
-custom HTML cleanup, this is the method...
-
- Protected method that will not generally be called directly. If you need/want
-custom HTML cleanup, this is the method you should override.
- Parameters:
- html
: StringThe HTML to be cleaned
- Returns:
-
- String
The cleaned HTML
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- cloneConfig( Object overrides
) : Ext.Component
- Clone the current component using the original config values passed into this instance by default.
-
- Clone the current component using the original config values passed into this instance by default.
- Parameters:
- overrides
: ObjectA new config containing any properties to override in the cloned version.
-An id property can be passed on this object, otherwise one will be generated to avoid duplicates.
- Returns:
-
- Ext.Component
clone The cloned copy of this component
-
-
-
-
-
- Component
-
-
-
-
-
- destroy() : void
- Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c...
-
- Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its Ext.Container (if applicable) and unregistering it from
-Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- execCmd( String cmd
, [String/Boolean value
] ) : void
- Executes a Midas editor command directly on the editor document.
-For visual commands, you should use relayCmd instead...
-
- Executes a Midas editor command directly on the editor document.
-For visual commands, you should use relayCmd instead.
-This should only be called after the editor is initialized.
- Parameters:
- cmd
: StringThe Midas commandvalue
: String/Boolean(optional) The value to pass to the command (defaults to null)
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- findParentBy( Function fcn
, [Object scope
] ) : Ext.Container
- Find a container above this component at any level by a custom function. If the passed function returns
-true, the con...
-
- Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. The passed function is called with the arguments (container, this component).
- Parameters:
- fcn
: Functionscope
: Object(optional)
- Returns:
-
- Ext.Container
The first Container for which the custom function returns true
-
-
-
-
-
- Component
-
-
-
-
-
- findParentByType( String/Class xtype
) : Ext.Container
- Find a container above this component at any level by xtype or class
-
- Find a container above this component at any level by xtype or class
- Parameters:
- xtype
: String/ClassThe xtype string for a component, or the class of the component directly
- Returns:
-
- Ext.Container
The first Container which matches the given xtype or class
-
-
-
-
-
- Component
-
-
-
-
-
- fireEvent( String eventName
, Object... args
) : Boolean
- Fires the specified event with the passed parameters (minus the event name).
-
- Fires the specified event with the passed parameters (minus the event name).
- Parameters:
- eventName
: Stringargs
: Object...Variable number of parameters are passed to handlers
- Returns:
-
- Boolean
returns false if any of the handlers return false otherwise it returns true
-
-
-
-
-
- Observable
-
-
-
-
-
- focus( [Boolean selectText
], [Boolean/Number delay
] ) : Ext.Component
- Try to focus this component.
-
- Try to focus this component.
- Parameters:
- selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- getBox( [Boolean local
] ) : Object
- Gets the current box measurements of the component's underlying element.
-
- Gets the current box measurements of the component's underlying element.
- Parameters:
- local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
- Returns:
-
- Object
box An object in the format {x, y, width, height}
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- getDocMarkup() : void
- Protected method that will not generally be called directly. It
-is called when the editor initializes the iframe with...
-
- Protected method that will not generally be called directly. It
-is called when the editor initializes the iframe with HTML contents. Override this method if you
-want to change the initialization markup of the iframe (e.g. to add stylesheets).
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- getEl() : Ext.Element
- Returns the underlying Ext.Element.
-
- Returns the underlying Ext.Element.
- Parameters:
- - None.
- Returns:
-
- Ext.Element
The element
-
-
-
-
-
- Component
-
-
-
-
-
- getId() : String
- Returns the id of this component.
-
- Returns the id of this component.
- Parameters:
- - None.
- Returns:
-
- String
-
-
-
-
-
- Component
-
-
-
-
-
- getItemId() : String
- Returns the item id of this component.
-
- Returns the item id of this component.
- Parameters:
- - None.
- Returns:
-
- String
-
-
-
-
-
- Component
-
-
-
-
-
- getName() : String
- Returns the name attribute of the field if available
-
- Returns the name attribute of the field if available
- Parameters:
- - None.
- Returns:
-
- String
name The field name
-
-
-
-
-
- Field
-
-
-
-
-
- getPosition( [Boolean local
] ) : Array
- Gets the current XY position of the component's underlying element.
-
- Gets the current XY position of the component's underlying element.
- Parameters:
- local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
- Returns:
-
- Array
The XY position of the element (e.g., [100, 200])
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- getRawValue() : Mixed
- Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.
-
- Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.
- Parameters:
- - None.
- Returns:
-
- Mixed
value The field value
-
-
-
-
-
- Field
-
-
-
-
-
- getSize() : Object
- Gets the current size of the component's underlying element.
-
- Gets the current size of the component's underlying element.
- Parameters:
- - None.
- Returns:
-
- Object
An object containing the element's size {width: (element width), height: (element height)}
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- getToolbar() : Ext.Toolbar
- Returns the editor's toolbar. This is only available after the editor has been rendered.
-
- Returns the editor's toolbar. This is only available after the editor has been rendered.
- Parameters:
- - None.
- Returns:
-
- Ext.Toolbar
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- getValue() : Mixed
- Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa...
-
- Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRawValue.
- Parameters:
- - None.
- Returns:
-
- Mixed
value The field value
-
-
-
-
-
- Field
-
-
-
-
-
- getXType() : String
- Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex...
-
- Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ext.Component header. Example usage:
-var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
- Parameters:
- - None.
- Returns:
-
- String
The xtype
-
-
-
-
-
- Component
-
-
-
-
-
- getXTypes() : String
- Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext...
-
- Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext.Component header.
+myGridPanel.on({
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+});
Returns:- void
Observable cleanHtml( String html
)
+ :
+ StringProtected method that will not generally be called directly. If you need/want
+custom HTML cleanup, this is the metho...Protected method that will not generally be called directly. If you need/want
+custom HTML cleanup, this is the method you should override.Parameters:html
: StringThe HTML to be cleaned
Returns:String
The cleaned HTML
HtmlEditor cloneConfig( Object overrides
)
+ :
+ Ext.ComponentClone the current component using the original config values passed into this instance by default.Clone the current component using the original config values passed into this instance by default.Parameters:overrides
: ObjectA new config containing any properties to override in the cloned version.
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates.
Returns:Ext.Component
clone The cloned copy of this component
Component destroy()
+ :
+ voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
+removing the c...Destroys this component by purging any event listeners, removing the component's element from the DOM,
+removing the component from its Ext.Container (if applicable) and unregistering it from
+Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
+should usually not need to be called directly.Parameters:- None.
Returns:- void
Component enableBubble( Object events
)
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present...Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+// Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent: Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+// We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget: function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+// Title goes red if form has been modified.
+ myForm.header.setStyle("color", "red");
+ }
+ }
+});
Parameters:events
: ObjectThe event name to bubble, or an Array of event names.
Returns:- void
Observable execCmd( String cmd
, [String/Boolean value
] )
+ :
+ voidExecutes a Midas editor command directly on the editor document.
+For visual commands, you should use relayCmd instea...Executes a Midas editor command directly on the editor document.
+For visual commands, you should use relayCmd instead.
+This should only be called after the editor is initialized.Parameters:cmd
: StringThe Midas commandvalue
: String/Boolean(optional) The value to pass to the command (defaults to null)
Returns:- void
HtmlEditor findParentBy( Function fn
)
+ :
+ Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+true, the con...Find a container above this component at any level by a custom function. If the passed function returns
+true, the container will be returned.Parameters:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Class xtype
)
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directly
Returns:Ext.Container
The first Container which matches the given xtype or class
Component fireEvent( String eventName
, Object... args
)
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse...Fires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)
+by calling enableBubble.
Parameters:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus( [Boolean selectText
], [Boolean/Number delay
] )
+ :
+ Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component getBox( [Boolean local
] )
+ :
+ ObjectGets the current box measurements of the component's underlying element.Gets the current box measurements of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
+ :
+ Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy.Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.Parameters:- None.
Returns:Ext.Container
the Container which owns this Component.
Component getDocMarkup()
+ :
+ voidProtected method that will not generally be called directly. It
+is called when the editor initializes the iframe wit...Protected method that will not generally be called directly. It
+is called when the editor initializes the iframe with HTML contents. Override this method if you
+want to change the initialization markup of the iframe (e.g. to add stylesheets).Parameters:- None.
Returns:- void
HtmlEditor getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
+This will usually be a <DIV> element created by the cla...Returns the Ext.Element which encapsulates this Component.
+This will usually be a <DIV> element created by the class's onRender method, but
+that may be overridden using the autoEl config.
+
Note: this element will not be available until this Component has been rendered.
+To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners config for a suggestion,
+or use a render listener directly:
new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getHeight()
+ :
+ NumberGets the current height of the component's underlying element.Gets the current height of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getId()
+ :
+ StringReturns the id of this component or automatically generates and
+returns an id if an id is not defined yet:'ext-comp-'...Returns the id
of this component or automatically generates and
+returns an id
if an id
is not defined yet:'ext-comp-' + (++Ext.Component.AUTO_ID)
Parameters:- None.
Returns:String
id
Component getItemId()
+ :
+ String Component getName()
+ :
+ StringReturns the name or hiddenName
+attribute of the field if available.Returns the name or hiddenName
+attribute of the field if available.Parameters:- None.
Returns:String
name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
Field getOuterSize()
+ :
+ ObjectGets the current size of the component's underlying element, including space taken by its margins.Gets the current size of the component's underlying element, including space taken by its margins.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
BoxComponent getPosition( [Boolean local
] )
+ :
+ ArrayGets the current XY position of the component's underlying element.Gets the current XY position of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Array
The XY position of the element (e.g., [100, 200])
BoxComponent getRawValue()
+ :
+ MixedReturns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue...Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.Parameters:- None.
Returns:Mixed
value The field value
Field getResizeEl()
+ :
+ voidReturns the outermost Element of this Component which defines the Components overall size.
+Usually this will return t...Returns the outermost Element of this Component which defines the Components overall size.
+Usually this will return the same Element as getEl
,
+but in some cases, a Component may have some more wrapping Elements around its main
+active Element.
+An example is a ComboBox. It is encased in a wrapping Element which
+contains both the <input>
Element (which is what would be returned
+by its getEl
method, and the trigger button Element.
+This Element is returned as the resizeEl
.
Parameters:- None.
Returns:- void
BoxComponent getSize()
+ :
+ ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getToolbar()
+ :
+ Ext.ToolbarReturns the editor's toolbar. This is only available after the editor has been rendered.Returns the editor's toolbar. This is only available after the editor has been rendered.Parameters:- None.
Returns:Ext.Toolbar
HtmlEditor getValue()
+ :
+ MixedReturns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa...Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRawValue.Parameters:- None.
Returns:Mixed
value The field value
Field getWidth()
+ :
+ NumberGets the current width of the component's underlying element.Gets the current width of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getXType()
+ :
+ StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+available xtypes, see the Ex...Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+available xtypes, see the Ext.Component header. Example usage:
+var t = new Ext.form.TextField();
+alert(t.getXType()); // alerts 'textfield'
Parameters:- None.
Returns:String
The xtype
Component getXTypes()
+ :
+ StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+available xtypes, see the Ext...Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+available xtypes, see the Ext.Component header.
If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.
Example usage:
-
-var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
- Parameters:
- - None.
- Returns:
-
- String
The xtype hierarchy string
-
-
-
-
-
- Component
-
-
-
-
-
- hasListener( String eventName
) : Boolean
- Checks to see if this object has any listeners for a specified event
-
- Checks to see if this object has any listeners for a specified event
- Parameters:
- eventName
: StringThe name of the event to check for
- Returns:
-
- Boolean
True if the event is being listened for, else false
-
-
-
-
-
- Observable
-
-
-
-
-
- hide() : Ext.Component
- Hide this component.
-
- Hide this component.
- Parameters:
- - None.
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- insertAtCursor( String text
) : void
- Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
-to insert ...
-
- Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
-to insert text.
- Parameters:
- text
: String
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- isDirty() : void
- Returns true if this field has been changed since it was originally loaded and is not disabled.
-
- Returns true if this field has been changed since it was originally loaded and is not disabled.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Field
-
-
-
-
-
- isValid( Boolean preventMark
) : Boolean
- Returns whether or not the field value is currently valid
-
- Returns whether or not the field value is currently valid
- Parameters:
- preventMark
: BooleanTrue to disable marking the field invalid
- Returns:
-
- Boolean
True if the value is valid, else false
-
-
-
-
-
- Field
-
-
-
-
-
- isVisible() : void
- Returns true if this component is visible.
-
- Returns true if this component is visible.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- isXType( String xtype
, [Boolean shallow
] ) : void
- Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th...
-
- Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+
var t = new Ext.form.TextField();
+alert(t.getXTypes()); // alerts 'component/box/field/textfield'
Parameters:- None.
Returns:String
The xtype hierarchy string
Component hasListener( String eventName
)
+ :
+ BooleanChecks to see if this object has any listeners for a specified eventChecks to see if this object has any listeners for a specified eventParameters:eventName
: StringThe name of the event to check for
Returns:Boolean
True if the event is being listened for, else false
Observable hide()
+ :
+ Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'h...Hide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'hide'
+event after hiding the component. Note this method is called internally if
+the component is configured to be hidden
.Parameters:- None.
Returns:Ext.Component
this
Component insertAtCursor( String text
)
+ :
+ voidInserts the passed text at the current cursor position. Note: the editor must be initialized and activated
+to insert...Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
+to insert text.Parameters:text
: String
Returns:- void
HtmlEditor isDirty()
+ :
+ BooleanReturns true if the value of this Field has been changed from its original value.
+Will return false if the field is d...Returns true if the value of this Field has been changed from its original value.
+Will return false if the field is disabled or has not been rendered yet.
+Note that if the owning form was configured with
+Ext.form.BasicForm.trackResetOnLoad
+then the original value is updated when the values are loaded by
+Ext.form.BasicForm.setValues.
Parameters:- None.
Returns:Boolean
True if this field has been changed from its original value (and
+is not disabled), false otherwise.
Field isValid( Boolean preventMark
)
+ :
+ BooleanReturns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disab...Returns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disabled fields are ignored.Parameters:preventMark
: BooleanTrue to disable marking the field invalid
Returns:Boolean
True if the value is valid, else false
Field isVisible()
+ :
+ BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String xtype
, [Boolean shallow
] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+from th...Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).
If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.
-For a list of all available xtypes, see the Ext.Component header.
+For a list of all available xtypes, see the Ext.Component header.
Example usage:
-var t = new Ext.form.TextField();
+var t = new Ext.form.TextField();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
- Parameters:
- xtype
: StringThe xtype to check for this Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
-the default), or true to check whether this Component is directly of the specified xtype.
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- on( String eventName
, Function handler
, [Object scope
], [Object options
] ) : void
- Appends an event handler to this element (shorthand for addListener)
-
- Appends an event handler to this element (shorthand for addListener)
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context.options
: Object(optional)
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- purgeListeners() : void
- Removes all listeners for this object
-
- Removes all listeners for this object
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- pushValue() : void
- Protected method that will not generally be called directly. Pushes the value of the textarea
-into the iframe editor.
-
- Protected method that will not generally be called directly. Pushes the value of the textarea
-into the iframe editor.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- relayCmd( String cmd
, [String/Boolean value
] ) : void
- Executes a Midas editor command on the editor document and performs necessary focus and
-toolbar updates. This should ...
-
- Executes a Midas editor command on the editor document and performs necessary focus and
-toolbar updates. This should only be called after the editor is initialized.
- Parameters:
- cmd
: StringThe Midas commandvalue
: String/Boolean(optional) The value to pass to the command (defaults to null)
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- relayEvents( Object o
, Array events
) : void
- Relays selected events from the specified Observable as if the events were fired by this.
-
- Relays selected events from the specified Observable as if the events were fired by this.
- Parameters:
- o
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- removeClass( string cls
) : void
- Removes a CSS class from the component's underlying element.
-
- Removes a CSS class from the component's underlying element.
- Parameters:
- cls
: stringThe CSS class name to remove
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- removeListener( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener
-
- Removes a listener
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: Object(optional) The scope (this object) for the handler
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- render( [Element/HTMLElement/String container
], [String/Number position
] ) : void
- Render this Component into the passed HTML element.
-If you are using a Container object to house this Component, then...
-
- Render this Component into the passed HTML element.
-If you are using a Container object to house this Component, then
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype
: StringThe xtype to check for this Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype.
Returns:Boolean
True if this component descends from the specified xtype, false otherwise.
Component nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
+ :
+ voidAppends an event handler to this object (shorthand for addListener.)Appends an event handler to this object (shorthand for addListener.)Parameters:eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
Returns:- void
Observable previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component processValue( Mixed value
)
+ :
+ voidThis method should only be overridden if necessary to prepare raw values
+for validation (see validate and isValid). ... Field purgeListeners()
+ :
+ voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
Observable pushValue()
+ :
+ voidProtected method that will not generally be called directly. Pushes the value of the textarea
+into the iframe editor...Protected method that will not generally be called directly. Pushes the value of the textarea
+into the iframe editor.Parameters:- None.
Returns:- void
HtmlEditor relayCmd( String cmd
, [String/Boolean value
] )
+ :
+ voidExecutes a Midas editor command on the editor document and performs necessary focus and
+toolbar updates. This should...Executes a Midas editor command on the editor document and performs necessary focus and
+toolbar updates. This should only be called after the editor is initialized.Parameters:cmd
: StringThe Midas commandvalue
: String/Boolean(optional) The value to pass to the command (defaults to null)
Returns:- void
HtmlEditor relayEvents( Object o
, Array events
)
+ :
+ voidRelays selected events from the specified Observable as if the events were fired by this.Relays selected events from the specified Observable as if the events were fired by this.Parameters:o
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
Returns:- void
Observable removeClass( string cls
)
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element.Removes a CSS class from the component's underlying element.Parameters:cls
: stringThe CSS class name to remove
Returns:Ext.Component
this
Component removeListener( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler.Removes an event handler.Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable render( [Element/HTMLElement/String container
], [String/Number position
] )
+ :
+ voidRender this Component into the passed HTML element.
+If you are using a Container object to house this Component, then...Render this Component into the passed HTML element.
+If you are using a Container object to house this Component, then
do not use the render method.
A Container's child Components are rendered by that Container's
-layout manager when the Container is first rendered.
+layout manager when the Container is first rendered.
Certain layout managers allow dynamic addition of child components. Those that do
-include Ext.layout.CardLayout, Ext.layout.AnchorLayout,
-Ext.layout.FormLayout, Ext.layout.TableLayout.
+include Ext.layout.CardLayout, Ext.layout.AnchorLayout,
+Ext.layout.FormLayout, Ext.layout.TableLayout.
If the Container is already rendered when a new child Component is added, you may need to call
-the Container's doLayout to refresh the view which causes any
+the Container's doLayout to refresh the view which causes any
unrendered child Components to be rendered. This is required so that you can add multiple
child components if needed while only refreshing the layout once.
When creating complex UIs, it is important to remember that sizing and positioning
-of child items is the responsibility of the Container's layout manager.
+of child items is the responsibility of the Container's layout manager.
If you expect child items to be sized in response to user interactions, you must
configure the Container with a layout manager which creates and manages the type of layout you
have in mind.
-Omitting the Container's layout config means that a basic
+
Omitting the Container's layout config means that a basic
layout manager is used which does nothing but render child components sequentially into the
-Container. No sizing or positioning will be performed in this situation.
- Parameters:
- container
: Element/HTMLElement/String(optional) The element this Component should be
+Container. No sizing or positioning will be performed in this situation.Parameters:container
: Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted.position
: String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container)
- Returns:
-
- void
-
-
-
-
-
- Component
-
-
-
-
-
- reset() : void
- Resets the current field value to the originally loaded value and clears any validation messages
-
- Resets the current field value to the originally loaded value and clears any validation messages
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Field
-
-
-
-
-
- resumeEvents() : void
- Resume firing events. (see suspendEvents)
-
- Resume firing events. (see suspendEvents)
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- setHeight( Number height
) : Ext.BoxComponent
-
- BoxComponent
-
-
-
-
-
- setPagePosition( Number x
, Number y
) : Ext.BoxComponent
- Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ...
-
- Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event.
- Parameters:
- x
: NumberThe new x positiony
: NumberThe new y position
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- setPosition( Number left
, Number top
) : Ext.BoxComponent
- Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ...
-
- Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event.
- Parameters:
- left
: NumberThe new lefttop
: NumberThe new top
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- setRawValue( Mixed value
) : Mixed
- Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.
-
- Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.
- Parameters:
- value
: MixedThe value to set
- Returns:
-
- Mixed
value The field value that is set
-
-
-
-
-
- Field
-
-
-
-
-
- setSize( Number/Object width
, Number height
) : Ext.BoxComponent
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width...
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
- Parameters:
- width
: Number/ObjectThe new width to set, or a size object in the format {width, height}height
: NumberThe new height to set (not required if a size object is passed as the first arg)
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- setValue( Mixed value
) : void
- Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
-
- Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
- Parameters:
- value
: MixedThe value to set
- Returns:
-
- void
-
-
-
-
-
- Field
-
-
-
-
-
- setVisible( Boolean visible
) : Ext.Component
- Convenience function to hide or show this component by boolean.
-
- Convenience function to hide or show this component by boolean.
- Parameters:
- visible
: BooleanTrue to show, false to hide
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- setWidth( Number width
) : Ext.BoxComponent
-
- BoxComponent
-
-
-
-
-
- show() : Ext.Component
- Show this component.
-
- Show this component.
- Parameters:
- - None.
- Returns:
-
- Ext.Component
this
-
-
-
-
-
- Component
-
-
-
-
-
- suspendEvents() : void
- Suspend the firing of all events. (see resumeEvents)
-
- Suspend the firing of all events. (see resumeEvents)
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- syncSize() : Ext.BoxComponent
- Force the component's size to recalculate based on the underlying element's current height and width.
-
- Force the component's size to recalculate based on the underlying element's current height and width.
- Parameters:
- - None.
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- syncValue() : void
- Protected method that will not generally be called directly. Syncs the contents
-of the editor iframe with the textarea.
-
- Protected method that will not generally be called directly. Syncs the contents
-of the editor iframe with the textarea.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- toggleSourceEdit( [Boolean sourceEdit
] ) : void
- Toggles the editor between standard and source edit mode.
-
- Toggles the editor between standard and source edit mode.
- Parameters:
- sourceEdit
: Boolean(optional) True for source edit, false for standard
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
-
-
- un( String eventName
, Function handler
, [Object scope
] ) : void
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
- Parameters:
- eventName
: StringThe type of event to listen forhandler
: FunctionThe handler to removescope
: Object(optional) The scope (this object) for the handler
- Returns:
-
- void
-
-
-
-
-
- Observable
-
-
-
-
-
- updateBox( Object box
) : Ext.BoxComponent
- Sets the current box measurements of the component's underlying element.
-
- Sets the current box measurements of the component's underlying element.
- Parameters:
- box
: ObjectAn object in the format {x, y, width, height}
- Returns:
-
- Ext.BoxComponent
this
-
-
-
-
-
- BoxComponent
-
-
-
-
-
- updateToolbar() : void
- Protected method that will not generally be called directly. It triggers
-a toolbar update by reading the markup state...
-
- Protected method that will not generally be called directly. It triggers
-a toolbar update by reading the markup state of the current selection in the editor.
- Parameters:
- - None.
- Returns:
-
- void
-
-
-
-
-
- HtmlEditor
-
-
-
- Public Events
-
-
- Event
- Defined By
-
-
-
-
-
- activate : ( HtmlEditor this
)
- Fires when the editor is first receives the focus. Any insertion must wait
-until after this event.
-
- Fires when the editor is first receives the focus. Any insertion must wait
-until after this event.
- Listeners will be called with the following arguments:
- this
: HtmlEditor
-
-
-
-
- HtmlEditor
-
-
-
-
-
- beforedestroy : ( Ext.Component this
)
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Fires before the component is destroyed. Return false to stop the destroy.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- beforehide : ( Ext.Component this
)
- Fires before the component is hidden. Return false to stop the hide.
-
- Fires before the component is hidden. Return false to stop the hide.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- beforepush : ( HtmlEditor this
, String html
)
- Fires before the iframe editor is updated with content from the textarea. Return false
-to cancel the push.
-
- Fires before the iframe editor is updated with content from the textarea. Return false
-to cancel the push.
- Listeners will be called with the following arguments:
- this
: HtmlEditorhtml
: String
-
-
-
-
- HtmlEditor
-
-
-
-
-
- beforerender : ( Ext.Component this
)
- Fires before the component is rendered. Return false to stop the render.
-
- Fires before the component is rendered. Return false to stop the render.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- beforeshow : ( Ext.Component this
)
- Fires before the component is shown. Return false to stop the show.
-
- Fires before the component is shown. Return false to stop the show.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- beforestaterestore : ( Ext.Component this
, Object state
)
- Fires before the state of the component is restored. Return false to stop the restore.
-
- Fires before the state of the component is restored. Return false to stop the restore.
- Listeners will be called with the following arguments:
- this
: Ext.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
-
- beforestatesave : ( Ext.Component this
, Object state
)
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
-
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
- Listeners will be called with the following arguments:
- this
: Ext.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
-
- beforesync : ( HtmlEditor this
, String html
)
- Fires before the textarea is updated with content from the editor iframe. Return false
-to cancel the sync.
-
- Fires before the textarea is updated with content from the editor iframe. Return false
-to cancel the sync.
- Listeners will be called with the following arguments:
- this
: HtmlEditorhtml
: String
-
-
-
-
- HtmlEditor
-
-
-
-
-
- destroy : ( Ext.Component this
)
- Fires after the component is destroyed.
-
- Fires after the component is destroyed.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- disable : ( Ext.Component this
)
- Fires after the component is disabled.
-
- Fires after the component is disabled.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- editmodechange : ( HtmlEditor this
, Boolean sourceEdit
)
- Fires when the editor switches edit modes
-
- Fires when the editor switches edit modes
- Listeners will be called with the following arguments:
- this
: HtmlEditorsourceEdit
: BooleanTrue if source edit, false if standard editing.
-
-
-
-
- HtmlEditor
-
-
-
-
-
- enable : ( Ext.Component this
)
- Fires after the component is enabled.
-
- Fires after the component is enabled.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- hide : ( Ext.Component this
)
- Fires after the component is hidden.
-
- Fires after the component is hidden.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- initialize : ( HtmlEditor this
)
- Fires when the editor is fully initialized (including the iframe)
-
- Fires when the editor is fully initialized (including the iframe)
- Listeners will be called with the following arguments:
- this
: HtmlEditor
-
-
-
-
- HtmlEditor
-
-
-
-
-
- invalid : ( Ext.form.Field this
, String msg
)
- Fires after the field has been marked as invalid.
-
- Fires after the field has been marked as invalid.
- Listeners will be called with the following arguments:
- this
: Ext.form.Fieldmsg
: StringThe validation message
-
-
-
-
- Field
-
-
-
-
-
- move : ( Ext.Component this
, Number x
, Number y
)
- Fires after the component is moved.
-
- Fires after the component is moved.
- Listeners will be called with the following arguments:
- this
: Ext.Componentx
: NumberThe new x positiony
: NumberThe new y position
-
-
-
-
- BoxComponent
-
-
-
-
-
- push : ( HtmlEditor this
, String html
)
- Fires when the iframe editor is updated with content from the textarea.
-
- Fires when the iframe editor is updated with content from the textarea.
- Listeners will be called with the following arguments:
- this
: HtmlEditorhtml
: String
-
-
-
-
- HtmlEditor
-
-
-
-
-
- render : ( Ext.Component this
)
- Fires after the component is rendered.
-
- Fires after the component is rendered.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- resize : ( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)
- Fires after the component is resized.
-
- Fires after the component is resized.
- Listeners will be called with the following arguments:
- this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
-
-
-
-
- BoxComponent
-
-
-
-
-
- show : ( Ext.Component this
)
- Fires after the component is shown.
-
- Fires after the component is shown.
- Listeners will be called with the following arguments:
- this
: Ext.Component
-
-
-
-
- Component
-
-
-
-
-
- staterestore : ( Ext.Component this
, Object state
)
- Fires after the state of the component is restored.
-
- Fires after the state of the component is restored.
- Listeners will be called with the following arguments:
- this
: Ext.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
-
- statesave : ( Ext.Component this
, Object state
)
- Fires after the state of the component is saved to the configured state provider.
-
- Fires after the state of the component is saved to the configured state provider.
- Listeners will be called with the following arguments:
- this
: Ext.Componentstate
: ObjectThe hash of state values
-
-
-
-
- Component
-
-
-
-
-
- sync : ( HtmlEditor this
, String html
)
- Fires when the textarea is updated with content from the editor iframe.
-
- Fires when the textarea is updated with content from the editor iframe.
- Listeners will be called with the following arguments:
- this
: HtmlEditorhtml
: String
-
-
-
-
- HtmlEditor
-
-
-
-
\ No newline at end of file
+which this component will be inserted (defaults to appending to the end of the container)Returns:- void
Component reset()
+ :
+ voidResets the current field value to the originally loaded value and clears any validation messages.
+See Ext.form.BasicF...Resets the current field value to the originally loaded value and clears any validation messages.
+See Ext.form.BasicForm.trackResetOnLoadParameters:- None.
Returns:- void
Field resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event...Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable setHeight( Number height
)
+ :
+ Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: NumberThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS height style.
+- undefined to leave the height unchanged.
+
Returns:Ext.BoxComponent
this
BoxComponent setPagePosition( Number x
, Number y
)
+ :
+ Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+This method fires the ...Sets the page XY position of the component. To set the left and top instead, use setPosition.
+This method fires the move event.Parameters:x
: NumberThe new x positiony
: NumberThe new y position
Returns:Ext.BoxComponent
this
BoxComponent setPosition( Number left
, Number top
)
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires ...Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event.Parameters:left
: NumberThe new lefttop
: NumberThe new top
Returns:Ext.BoxComponent
this
BoxComponent setRawValue( Mixed value
)
+ :
+ MixedSets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.Parameters:value
: MixedThe value to set
Returns:Mixed
value The field value that is set
Field setSize( Mixed width
, Mixed height
)
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either wid...Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either width and height as separate arguments, or you can pass a size object like {width:10, height:20}
.Parameters:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS width style.
+- A size object in the format
{width: widthValue, height: heightValue}
.
+undefined
to leave the width unchanged.
+
height
: MixedThe new height to set (not required if a size object is passed as the first arg).
+This may be one of:
+- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS height style. Animation may not be used.
+undefined
to leave the height unchanged.
+
Returns:Ext.BoxComponent
this
BoxComponent setValue( Mixed value
)
+ :
+ Ext.form.FieldSets a data value into the field and validates it. To set the value directly without validation see setRawValue.Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.Parameters:value
: MixedThe value to set
Returns:Ext.form.Field
this
Field setVisible( Boolean visible
)
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Number width
)
+ :
+ Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: NumberThe new width to setThis may be one of:
+- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+- A String used to set the CSS width style.
+
Returns:Ext.BoxComponent
this
BoxComponent show()
+ :
+ Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the '...Show this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the 'show'
+event after showing the component.Parameters:- None.
Returns:Ext.Component
this
Component suspendEvents( Boolean queueSuspended
)
+ :
+ voidSuspend the firing of all events. (see resumeEvents)Suspend the firing of all events. (see resumeEvents)Parameters:queueSuspended
: BooleanPass as true to queue up suspended events to be fired
+after the resumeEvents call instead of discarding all suspended events;
Returns:- void
Observable syncSize()
+ :
+ Ext.BoxComponentForce the component's size to recalculate based on the underlying element's current height and width.Force the component's size to recalculate based on the underlying element's current height and width.Parameters:- None.
Returns:Ext.BoxComponent
this
BoxComponent syncValue()
+ :
+ voidProtected method that will not generally be called directly. Syncs the contents
+of the editor iframe with the textar...Protected method that will not generally be called directly. Syncs the contents
+of the editor iframe with the textarea.Parameters:- None.
Returns:- void
HtmlEditor toggleSourceEdit( [Boolean sourceEdit
] )
+ :
+ voidToggles the editor between standard and source edit mode.Toggles the editor between standard and source edit mode.Parameters:sourceEdit
: Boolean(optional) True for source edit, false for standard
Returns:- void
HtmlEditor un( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable updateBox( Object box
)
+ :
+ Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent updateToolbar()
+ :
+ voidProtected method that will not generally be called directly. It triggers
+a toolbar update by reading the markup stat...Protected method that will not generally be called directly. It triggers
+a toolbar update by reading the markup state of the current selection in the editor.Parameters:- None.
Returns:- void
HtmlEditor
Public Events
Event Defined By activate :
+ ( HtmlEditor this
)
+ Fires when the editor is first receives the focus. Any insertion must wait
+until after this event.Fires when the editor is first receives the focus. Any insertion must wait
+until after this event.Listeners will be called with the following arguments:this
: HtmlEditor
HtmlEditor afterrender :
+ ( Ext.Component this
)
+ Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendere...Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendered, been postprocesed
+by any afterRender method defined for the Component, and, if stateful, after state
+has been restored.
Listeners will be called with the following arguments:this
: Ext.Component
Component beforedestroy :
+ ( Ext.Component this
)
+ Component beforehide :
+ ( Ext.Component this
)
+ Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide.Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide.Listeners will be called with the following arguments:this
: Ext.Component
Component beforepush :
+ ( HtmlEditor this
, String html
)
+ Fires before the iframe editor is updated with content from the textarea. Return false
+to cancel the push.Fires before the iframe editor is updated with content from the textarea. Return false
+to cancel the push.Listeners will be called with the following arguments:this
: HtmlEditorhtml
: String
HtmlEditor beforerender :
+ ( Ext.Component this
)
+ Component beforeshow :
+ ( Ext.Component this
)
+ Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show.Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show.Listeners will be called with the following arguments:this
: Ext.Component
Component beforestaterestore :
+ ( Ext.Component this
, Object state
)
+ Fires before the state of the component is restored. Return false from an event handler to stop the restore.Fires before the state of the component is restored. Return false from an event handler to stop the restore.Listeners will be called with the following arguments:this
: Ext.Componentstate
: ObjectThe hash of state values returned from the StateProvider. If this
+event is not vetoed, then the state object is passed to applyState. By default,
+that simply copies property values into this Component. The method maybe overriden to
+provide custom state restoration.
Component beforestatesave :
+ ( Ext.Component this
, Object state
)
+ Fires before the state of the component is saved to the configured state provider. Return false to stop the save.Fires before the state of the component is saved to the configured state provider. Return false to stop the save.Listeners will be called with the following arguments:this
: Ext.Componentstate
: ObjectThe hash of state values. This is determined by calling
+getState() on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.
Component beforesync :
+ ( HtmlEditor this
, String html
)
+ Fires before the textarea is updated with content from the editor iframe. Return false
+to cancel the sync.Fires before the textarea is updated with content from the editor iframe. Return false
+to cancel the sync.Listeners will be called with the following arguments:this
: HtmlEditorhtml
: String
HtmlEditor destroy :
+ ( Ext.Component this
)
+ Fires after the component is destroyed.Fires after the component is destroyed.Listeners will be called with the following arguments:this
: Ext.Component
Component disable :
+ ( Ext.Component this
)
+ Fires after the component is disabled.Fires after the component is disabled.Listeners will be called with the following arguments:this
: Ext.Component
Component editmodechange :
+ ( HtmlEditor this
, Boolean sourceEdit
)
+ Fires when the editor switches edit modesFires when the editor switches edit modesListeners will be called with the following arguments:this
: HtmlEditorsourceEdit
: BooleanTrue if source edit, false if standard editing.
HtmlEditor enable :
+ ( Ext.Component this
)
+ Fires after the component is enabled.Fires after the component is enabled.Listeners will be called with the following arguments:this
: Ext.Component
Component hide :
+ ( Ext.Component this
)
+ Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method.Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method.Listeners will be called with the following arguments:this
: Ext.Component
Component initialize :
+ ( HtmlEditor this
)
+ Fires when the editor is fully initialized (including the iframe)Fires when the editor is fully initialized (including the iframe)Listeners will be called with the following arguments:this
: HtmlEditor
HtmlEditor invalid :
+ ( Ext.form.Field this
, String msg
)
+ Fires after the field has been marked as invalid.Fires after the field has been marked as invalid.Listeners will be called with the following arguments:this
: Ext.form.Fieldmsg
: StringThe validation message
Field move :
+ ( Ext.Component this
, Number x
, Number y
)
+ Fires after the component is moved.Fires after the component is moved.Listeners will be called with the following arguments:this
: Ext.Componentx
: NumberThe new x positiony
: NumberThe new y position
BoxComponent push :
+ ( HtmlEditor this
, String html
)
+ Fires when the iframe editor is updated with content from the textarea.Fires when the iframe editor is updated with content from the textarea.Listeners will be called with the following arguments:this
: HtmlEditorhtml
: String
HtmlEditor render :
+ ( Ext.Component this
)
+ Fires after the component markup is rendered.Fires after the component markup is rendered.Listeners will be called with the following arguments:this
: Ext.Component
Component resize :
+ ( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)
+ Fires after the component is resized.Fires after the component is resized.Listeners will be called with the following arguments:this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
BoxComponent show :
+ ( Ext.Component this
)
+ Fires after the component is shown when calling the show method.Fires after the component is shown when calling the show method.Listeners will be called with the following arguments:this
: Ext.Component
Component staterestore :
+ ( Ext.Component this
, Object state
)
+ Fires after the state of the component is restored.Fires after the state of the component is restored.Listeners will be called with the following arguments:this
: Ext.Componentstate
: ObjectThe hash of state values returned from the StateProvider. This is passed
+to applyState. By default, that simply copies property values into this
+Component. The method maybe overriden to provide custom state restoration.
Component statesave :
+ ( Ext.Component this
, Object state
)
+ Fires after the state of the component is saved to the configured state provider.Fires after the state of the component is saved to the configured state provider.Listeners will be called with the following arguments:this
: Ext.Componentstate
: ObjectThe hash of state values. This is determined by calling
+getState() on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.
Component sync :
+ ( HtmlEditor this
, String html
)
+ Fires when the textarea is updated with content from the editor iframe.Fires when the textarea is updated with content from the editor iframe.Listeners will be called with the following arguments:this
: HtmlEditorhtml
: String
HtmlEditor
\ No newline at end of file