X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.form.CheckboxGroup.html?ds=inline diff --git a/docs/output/Ext.form.CheckboxGroup.html b/docs/output/Ext.form.CheckboxGroup.html index 25bcbd22..04a59846 100644 --- a/docs/output/Ext.form.CheckboxGroup.html +++ b/docs/output/Ext.form.CheckboxGroup.html @@ -1,4 +1,8 @@ -
Observable
  Component
    BoxComponent
      Field
        CheckboxGroup

Class Ext.form.CheckboxGroup

Package:Ext.form
Defined In:CheckboxGroup.js
Class:CheckboxGroup
Subclasses:RadioGroup
Extends:Field

A grouping container for Ext.form.Checkbox controls.

+
Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Field
+        CheckboxGroup

Class Ext.form.CheckboxGroup

Package:Ext.form
Defined In:CheckboxGroup.js
Class:CheckboxGroup
Subclasses:RadioGroup
Extends:Field

A grouping container for Ext.form.Checkbox controls.

Sample usage:

var myCheckboxGroup = new Ext.form.CheckboxGroup({
     id:'myGroup',
@@ -144,7 +148,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').

@@ -439,9 +446,9 @@ 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 msgFx : String
    Experimental The effect used when displaying a validation message under the field -(defaults to 'normal').
    Field msgTarget<p>The : String
    location where the message text set through markInvalid should display. +(defaults to 'normal').
    Field msgTarget : String
    The 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. +<div...

    The 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. @@ -450,7 +457,7 @@ Must be one of the following values:

    • 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 overCls : String
    An optional extra CSS class that will be added to this component's Element when the mouse moves +
    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 @@ -712,7 +719,12 @@ Or a shorthand syntax:
    scope: this });
    Returns:
    Observable applyToMarkup( String/HTMLElement el ) : - void
    Apply this component to existing markup that is valid. With this function, no call to render() is required.
    Apply this component to existing markup that is valid. With this function, no call to render() is required.
    Parameters:
    • el : String/HTMLElement
    Returns:
    • void
    Component clearInvalid() + void
    Apply this component to existing markup that is valid. With this function, no call to render() is required.
    Apply this component to existing markup that is valid. With this function, no call to render() is required.
    Parameters:
    • el : String/HTMLElement
    Returns:
    • void
    Component 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 clearInvalid() : void
    Clear any invalid styles/messages for this field
    Clear any invalid styles/messages for this field
    Parameters:
    • None.
    Returns:
    • void
    Field cloneConfig( Object overrides ) : @@ -729,45 +741,47 @@ should usually not need to be called directly.
    Enable this component and fire the 'enable' event.
    Enable this component and fire the 'enable' event.
    Parameters:
    • None.
    Returns:
    • Ext.Component
      this
    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 findParentBy( Function fn )
     :
                                         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.
    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).

    @@ -798,7 +812,11 @@ 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 CheckboxGroup's validations and returns an array of any errors. The only error by default +is if allowBlank is se...
    Runs CheckboxGroup's validations and returns an array of any errors. The only error by default +is if allowBlank is set to true and no items are checked.
    Parameters:
    • None.
    Returns:
    • Array
      Array of all validation errors
    CheckboxGroup 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() : @@ -874,7 +892,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 @@ -886,7 +904,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 markInvalid( [String msg] ) : void
    Display an error message associated with this field, using msgTarget to determine how to @@ -969,14 +991,19 @@ 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 ) + : + 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 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 setDisabled( Boolean disabled ) : - Ext.Component
    Convenience function for setting disabled/enabled by boolean.
    Convenience function for setting disabled/enabled by boolean.
    Parameters:
    • disabled : Boolean
    Returns:
    • Ext.Component
      this
    Component setHeight( Number height ) + Ext.Component
    Convenience function for setting disabled/enabled by boolean.
    Convenience function for setting disabled/enabled by boolean.
    Parameters:
    • disabled : Boolean
    Returns:
    • Ext.Component
      this
    Component 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 : 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 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 ) @@ -1022,10 +1049,10 @@ myCheckboxGroup.setValue({ myCheckboxGroup.setValue('cb-col-1,cb-col-3'); See Ext.form.Checkbox.setValue for additional information.
        Parameters:
        • id : Mixed
          The checkbox to check, or as described by example shown.
        • value : Boolean
          (optional) The value to set the item.
        Returns:
        • Ext.form.CheckboxGroup
          this
      CheckboxGroup 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:
        BoxComponent 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. @@ -1048,7 +1079,13 @@ content area will be updated via Ext.Element update
        • loadScri : 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 : Object
            An object in the format {x, y, width, height}
          Returns:
          • Ext.BoxComponent
            this
          BoxComponent validate() : - Boolean
          Validates the field value
          Validates the field value
          Parameters:
          • None.
          Returns:
          • Boolean
            True if the value is valid, else false
          Field

          Public Events

          EventDefined By

          Public Events

          EventDefined By