X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6a7e4474cba9d8be4b2ec445e10f1691f7277c50..f5240829880f87e0cf581c6a296e436fdef0ef80:/docs/output/Ext.CycleButton.html diff --git a/docs/output/Ext.CycleButton.html b/docs/output/Ext.CycleButton.html index 9443f925..bd8baf5f 100644 --- a/docs/output/Ext.CycleButton.html +++ b/docs/output/Ext.CycleButton.html @@ -1,4 +1,4 @@ -
Properties Methods Events Config Options Direct Link
Observable
  Component
    BoxComponent
      Button
        SplitButton
          CycleButton

Class Ext.CycleButton

Package:Ext
Defined In:CycleButton.js
Class:CycleButton
Extends:SplitButton
A specialized SplitButton that contains a menu of Ext.menu.CheckItem elements. The button automatically +
Observable
  Component
    BoxComponent
      Button
        SplitButton
          CycleButton

Class Ext.CycleButton

Package:Ext
Defined In:CycleButton.js
Class:CycleButton
Extends:SplitButton
A specialized SplitButton that contains a menu of Ext.menu.CheckItem elements. The button automatically cycles through each menu item on click, raising the button's change event (or calling the button's changeHandler function, if supplied) for the active menu item. Clicking on the arrow section of the button displays the dropdown menu just like a normal SplitButton. Example usage: @@ -80,37 +80,11 @@ result in elements needing to be synchronized with the new height. Example:

< 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 -them on render (defaults to false).
Component autoWidth : Boolean
True to use width:'auto', false to use fixed width (or allow it to be managed by its parent -Container's layout manage...

True to use width:'auto', false to use fixed width (or allow it to be managed by its parent -Container's layout manager. Defaults to false.

-

Note: Although many components inherit this config option, not all will -function as expected with a width of 'auto'. Setting autoWidth:true means that the -browser will manage width based on the element's contents, and that Ext will not manage it at all.

-

If the browser is managing the width, be aware that resizes performed by the browser in response -to changes within the structure of the Component cannot be detected. Therefore changes to the width might -result in elements needing to be synchronized with the new width. For example, where the target element is:

<div id='grid-container' style='margin-left:25%;width:50%'></div>
-A Panel rendered into that target element must listen for browser window resize in order to relay its -child items when the browser changes its width:
var myPanel = new Ext.Panel({
-    renderTo: 'grid-container',
-    monitorResize: true, // relay on browser resize
-    title: 'Panel',
-    height: 400,
-    autoWidth: true,
-    layout: 'hbox',
-    layoutConfig: {
-        align: 'stretch'
-    },
-    defaults: {
-        flex: 1
-    },
-    items: [{
-        title: 'Box 1',
-    }, {
-        title: 'Box 2'
-    }, {
-        title: 'Box 3'
-    }],
-});
BoxComponent boxMaxHeight : Number
The maximum value in pixels which this BoxComponent will set its height to. +them on render (defaults to false).
Component autoWidth : Boolean
By default, if a width is not specified the button will attempt to stretch horizontally to fit its content. +If the bu...
By default, if a width is not specified the button will attempt to stretch horizontally to fit its content. +If the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent +the button from doing this automatic sizing. +Defaults to undefined.
Button boxMaxHeight : Number
The maximum value in pixels which this BoxComponent will set its height to. Warning: This will override any size mana...

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

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

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

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

@@ -660,7 +634,12 @@ Or a shorthand syntax:
scope: this });
Returns:
  • void
Observable applyToMarkupString/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 cloneConfigObject overrides ) + 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 bubbleFunction 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 cloneConfigObject 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 : Object
    A 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() @@ -711,9 +690,11 @@ access the required target more quickly.

: 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 findParentByTypeString/Class xtype ) +true, the container will be returned.
Parameters:Returns:
Component findParentByTypeString/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 fireEventString eventNameObject... 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 fireEventString eventNameObject... 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).

@@ -821,7 +802,7 @@ the component is configured to be
Hide this button's menu (if it has one)
Hide this button's menu (if it has one)
Parameters:
  • None.
Returns:
  • void
Button 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 isXTypeString 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 isXTypeString/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 @@ -833,7 +814,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 monObservable|Element itemObject|String enameFunction fnObject scopeObject opt ) : void
Adds listeners to any Observable object (or Elements) which are automatically removed when this Component