X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.form.HtmlEditor.html diff --git a/docs/output/Ext.form.HtmlEditor.html b/docs/output/Ext.form.HtmlEditor.html index a035cc3c..de1d6a6b 100644 --- a/docs/output/Ext.form.HtmlEditor.html +++ b/docs/output/Ext.form.HtmlEditor.html @@ -1,4 +1,8 @@ -
Observable
  Component
    BoxComponent
      Field
        HtmlEditor

Class Ext.form.HtmlEditor

Package:Ext.form
Defined In:HtmlEditor.js
Class:HtmlEditor
Extends:Field
Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be +
Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Field
+        HtmlEditor

Class Ext.form.HtmlEditor

Package:Ext.form
Defined In:HtmlEditor.js
Class:HtmlEditor
Extends:Field
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. @@ -36,7 +40,36 @@ based layout manager, for example:

-

See Ext.layout.AnchorLayout.anchor also.

BoxComponent autoScroll : Boolean
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +

See Ext.layout.AnchorLayout.anchor also.

BoxComponent autoEl : Mixed
A 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: 'box',
+        autoEl: 'li',
+        html: 'First list item'
+    }
+}
Component autoScroll : Boolean
true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false...
true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false).
BoxComponent 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 @@ -48,7 +81,10 @@ Warning: This will override any size manag...

The maxi Warning: This will override any size mana...

The minimum value in pixels which this BoxComponent will set its height to.

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinWidth : Number
The minimum value in pixels which this BoxComponent will set its width to. Warning: This will override any size manag...

The minimum value in pixels which this BoxComponent will set its width to.

-

Warning: This will override any size management applied by layout managers.

BoxComponent clearCls : String
The CSS class used to to apply to the special clearing div rendered +

Warning: This will override any size management applied by layout managers.

BoxComponent bubbleEvents : Array
An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble....

An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to [].

Component clearCls : String
The 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').

@@ -321,18 +357,7 @@ right and left are set to the second. 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 msgTarget<p>The : String
    location where the message text set through markInvalid should display. -Must be one of the following values: -<div cla...
    location where the message text set through markInvalid should display. -Must be one of the following values:

    -
      -
    • qtip Display a quick tip containing the message when the user hovers over the field. This is the default. -
      Ext.QuickTips.init must have been called for this setting to work. -
    • title Display the message in a default browser title attribute popup.
      • -
    • under Add a block div beneath the field containing the error message.
      • -
    • side Add an error icon to the right of the field, displaying the message in a popup on hover.
      • -
    • [element id] Add the error message directly to the innerHTML of the specified element.
      • -
    Field name : String
    The field's HTML name attribute (defaults to ''). +

    Defaults to:

    {top:0, right:0, bottom:0, left:0}
    BoxComponent name : String
    The 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 : String
    An optional extra CSS class that will be added to this component's Element when the mouse moves @@ -570,7 +595,12 @@ Or a shorthand syntax:
    'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this -});
    Returns:
    Observable cleanHtml( String html ) +});Returns:Observable bubble( Function fn, [Object scope], [Array args] ) + : + Ext.Component
    Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...
    Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of +function call will be the scope provided or the current component. The arguments to the function +will be the args provided or the current component. If the function returns false at any point, +the bubble is stopped.
    Parameters:
    • fn : Function
      The function to call
    • scope : Object
      (optional) The scope of the function (defaults to current node)
    • args : Array
      (optional) The args to call the function with (default to passing the current component)
    Returns:
    • Ext.Component
      this
    Component 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 @@ -585,38 +615,38 @@ removing the component from its 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( String/Array events ) : - void
    Enables 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');
-        }
-    }
+                                        void
    Enables 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 : String/Array
      The event name to bubble, or an Array of event names.
    Returns:
    • void
    Observable execCmd( String cmd, [String/Boolean value] )
     :
                                         void
    Executes a Midas editor command directly on the editor document.
@@ -626,9 +656,11 @@ For visual commands, you should use 
    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.
    Parameters:
    • fn : Function
      The 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 )
+true, the container will be returned.
    Parameters:
    • fn : Function
      The 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/Ext.Component/Class xtype, [Boolean shallow] ) : - 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/Class
      The 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 ) + 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/Ext.Component/Class
      The xtype to check for this Component. Note that the the component can either be an instance +or a component class:
    • shallow : 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:
    • 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). An event may be set to bubble up an Obse...

    Fires the specified event with the passed parameters (minus the event name).

    @@ -665,7 +697,12 @@ or use a render listener directly:

    new Ext.Panel({
         },
         single: true  // Remove the listener after first invocation
     }
-});
    Parameters:
    • None.
    Returns:
    • Ext.Element
      The Element which encapsulates this Component.
    Component getHeight() +});
    Parameters:Returns:
    Component getErrors() + : + Array
    Runs this field's validators and returns an array of error messages for any validation failures. +This is called inter...
    Runs this field's validators and returns an array of error messages for any validation failures. +This is called internally during validation and would not usually need to be used manually. +Each subclass should override or augment the return value to provide their own errors
    Parameters:
    • None.
    Returns:
    • Array
      All error messages for this field
    Field getHeight() : Number
    Gets 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() : @@ -749,7 +786,7 @@ of the field. Note: disab...
    Returns whether or not the f validating the processed value of the field. Note: disabled fields are ignored.
    Parameters:Returns:
    Field isVisible() : - Boolean
    Returns 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] ) + Boolean
    Returns 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/Ext.Component/Class xtype, [Boolean shallow] ) : Boolean
    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 @@ -761,7 +798,11 @@ to participate in determination of inherited xtypes.

    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 : String
      The xtype to check for this Component
    • shallow : Boolean
      (optional) False to check whether this Component is descended from the xtype (this is +var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
      Parameters:
      • xtype : String/Ext.Component/Class
        The xtype to check for this Component. Note that the the component can either be an instance +or a component class: +
        var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.Component));
      • shallow : 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 mon( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt ) : void
    Adds listeners to any Observable object (or Elements) which are automatically removed when this Component @@ -844,12 +885,17 @@ See Ext.fo 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 setAutoScroll( Boolean scroll ) +events fired during event suspension will be sent to any listeners now.
    Parameters:
    • None.
    Returns:
    • void
    Observable setActiveError( String msg, Boolean suppressEvent ) : - Ext.BoxComponent
    Sets the overflow on the content element of the component.
    Sets the overflow on the content element of the component.
    Parameters:
    • scroll : Boolean
      True to allow the Component to auto scroll.
    Returns:
    • Ext.BoxComponent
      this
    BoxComponent setHeight( Number height ) + void
    Sets the current activeError to the given string. Fires the 'invalid' event. +This does not set up the error icon, onl...
    Sets the current activeError to the given string. Fires the 'invalid' event. +This does not set up the error icon, only sets the message and fires the event. To show the error icon, +use markInvalid instead, which calls this method internally
    Parameters:
    • msg : String
      The error message
    • suppressEvent : Boolean
      True to suppress the 'invalid' event from being fired
    Returns:
    • void
    Field setAutoScroll( Boolean scroll ) : - Ext.BoxComponent
    Sets 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 : Number
      The 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).
        • + Ext.BoxComponent
        Sets the overflow on the content element of the component.
        Sets the overflow on the content element of the component.
        Parameters:
        • scroll : Boolean
          True to allow the Component to auto scroll.
        Returns:
        • Ext.BoxComponent
          this
        BoxComponent setHeight( Mixed height ) + : + Ext.BoxComponent
        Sets 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 : Mixed
          The new height to set. This may be one of:
            +
          • A Number specifying the new height in the Element's 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 ) @@ -882,10 +928,10 @@ This may be one of:
          : Ext.form.Field
          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 : Mixed
            The value to set
          Returns:
          • Ext.form.Field
            this
          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 : Boolean
            True to show, false to hide
          Returns:
          • Ext.Component
            this
          Component setWidth( Number width ) + Ext.Component
          Convenience function to hide or show this component by boolean.
          Convenience function to hide or show this component by boolean.
          Parameters:
          • visible : Boolean
            True to show, false to hide
          Returns:
          • Ext.Component
            this
          Component setWidth( Mixed width ) : - Ext.BoxComponent
          Sets 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 : Number
            The new width to setThis may be one of:
              -
            • A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
              • + Ext.BoxComponent
              Sets 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 : Mixed
                The new width to set. This may be one of:
                  +
                • A Number specifying the new width in the Element's defaultUnits (by default, pixels).
                • A String used to set the CSS width style.
              Returns:
              • Ext.BoxComponent
                this
              BoxComponent show() : @@ -905,7 +951,11 @@ of the editor iframe with the textarea.
              Param : 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 an event handler (shorthand for removeListener.)
              Removes an event handler (shorthand for removeListener.)
              Parameters:
              • eventName : String
                The type of event the handler was associated with.
              • handler : Function
                The 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 update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] ) + void
              Removes an event handler (shorthand for removeListener.)
              Removes an event handler (shorthand for removeListener.)
              Parameters:
              • eventName : String
                The type of event the handler was associated with.
              • handler : Function
                The 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 unsetActiveError( Boolean suppressEvent ) + : + void
              Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not +usually n...
              Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not +usually need to be called manually
              Parameters:
              • suppressEvent : Boolean
                True to suppress the 'invalid' event from being fired
              Returns:
              • void
              Field update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] ) : void
              Update the content area of a component.
              Update the content area of a component.
              Parameters:
              • htmlOrData : Mixed
                If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. @@ -916,7 +966,13 @@ content area will be updated via Ext.Element update
              • loadScri : 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

                EventDefined By

                Public Events

                EventDefined By