X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6a7e4474cba9d8be4b2ec445e10f1691f7277c50..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.SplitButton.html?ds=sidebyside diff --git a/docs/output/Ext.SplitButton.html b/docs/output/Ext.SplitButton.html index e84ea7d4..d706face 100644 --- a/docs/output/Ext.SplitButton.html +++ b/docs/output/Ext.SplitButton.html @@ -1,4 +1,8 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Button
        SplitButton

Class Ext.SplitButton

Package:Ext
Defined In:SplitButton.js
Class:SplitButton
Subclasses:CycleButton
Extends:Button
A split button that provides a built-in dropdown arrow that can fire an event separately from the default +
Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Button
+        SplitButton

Class Ext.SplitButton

Package:Ext
Defined In:SplitButton.js
Class:SplitButton
Subclasses:CycleButton
Extends:Button
A split button that provides a built-in dropdown arrow that can fire an event separately from the default click event of the button. Typically this would be used to display a dropdown menu that provides additional options to the primary button action, but any custom handler can provide the arrowclick implementation. Example usage: 
// display a dropdown menu:
@@ -50,7 +54,36 @@ Two values are allowed:

 
  • 'right'
    • 
 
  • 'bottom'
    • 
 
-
    Defaults to 'right'.
    Button arrowHandler : Function
    A function called when the arrow button is clicked (can be used instead of click event)
    SplitButton arrowTooltip : String
    The title attribute of the arrow
    SplitButton autoHeight : Boolean
    True to use height:'auto', false to use fixed height (or allow it to be managed by its parent +

    Defaults to 'right'.

    Button arrowHandler : Function
    A function called when the arrow button is clicked (can be used instead of click event)
    SplitButton arrowTooltip : String
    The title attribute of the arrow
    SplitButton 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 autoHeight : Boolean
    True to use height:'auto', false to use fixed height (or allow it to be managed by its parent Container's layout mana...

    True to use height:'auto', false to use fixed height (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 @@ -86,37 +119,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.

    @@ -142,7 +149,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.


    See Ext.layout.FormLayout.fieldTpl also.

    Component clickEvent : String
    The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). Def...
    The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). -Defaults to 'click'.
    Button cls : String
    A CSS class string to apply to the button's main element.
    Button ctCls : String
    An optional extra CSS class that will be added to this component's container. This can be useful for +Defaults to 'click'.
    Button cls : String
    A CSS class string to apply to the button's main element.
    Button contentEl : String
    Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content +for this comp...

    Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content +for this component.

    +
      +
    • Description : +
      This config option is used to take an existing HTML element and place it in the layout element +of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
      • +
    • Notes : +
      The specified HTML element is appended to the layout element of the component after any configured +HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
      +
      The specified HTML element used will not participate in any layout +scheme that the Component may use. It is just HTML. Layouts operate on child items.
      +
      Add either the x-hidden or the x-hide-display CSS class to +prevent a brief flicker of the content before it is rendered to the panel.
      • +
    Component ctCls : String
    An 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.

    @@ -153,7 +174,8 @@ which assigns a value by default:
    To configure the above Class with an extra CSS class append to the default. For example, for BoxLayout (Hbox and Vbox):
    ctCls: 'x-box-layout-ct custom-class'
    -

    Component disabled : Boolean
    True to start disabled (defaults to false)
    Button disabledClass : String
    CSS class added to the component when it is disabled (defaults to 'x-item-disabled').
    Component enableToggle : Boolean
    True to enable pressed/not pressed toggling (defaults to false)
    Button fieldLabel : String
    The label text to display next to this Component (defaults to ''). +

    Component data : Mixed
    The initial set of data to apply to the tpl to +update the content area of the Component.
    Component disabled : Boolean
    True to start disabled (defaults to false)
    Button disabledClass : String
    CSS class added to the component when it is disabled (defaults to 'x-item-disabled').
    Component enableToggle : Boolean
    True to enable pressed/not pressed toggling (defaults to false)
    Button fieldLabel : String
    The 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. @@ -204,7 +226,11 @@ since items are automatically laid out when they are first shown (no sizing is done while hidden).

    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 icon : String
    The path to an image to display in the button (the image will be set as the background-image +button on a window by setting hide:true on the button when adding it to its parent container.
    Component html : String/Object
    An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML conten...
    An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML content is added after the component is rendered, +so the document will not contain this HTML at the time the render event is fired. +This content is inserted into the body before any configured contentEl is appended.
    Component icon : String
    The path to an image to display in the button (the image will be set as the background-image CSS property of the butt...
    The path to an image to display in the button (the image will be set as the background-image CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon')
    Button iconAlign : String
    (Optional) The side of the Button box to render the icon. Four values are allowed: <ul class="mdetail-params"> @@ -557,7 +583,16 @@ Instances, or subclasses which need a different DOM structure may provide a diff template layout in conjunction with an implementation of getTemplateArgs.
    Button text : String
    The button text to be used as innerHTML (html tags are accepted)
    Button toggleGroup : String
    The group this toggle button is a member of (only 1 per group can be pressed)
    Button toggleHandler : Function
    Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:<ul class="mdetail-p...
    Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:
    • button : Ext.Button
      this Button object
    • state : Boolean
      The next state of the Button, true means pressed.
      • -
    Button tooltip : String/Object
    The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config obj...
    The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object
    Button tooltipType : String
    The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
    Button type : String
    submit, reset or button - defaults to 'button'
    Button width : Number
    The width of this component in pixels (defaults to auto). +
    Button tooltip : String/Object
    The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config obj...
    The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object
    Button tooltipType : String
    The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
    Button tpl : Mixed
    An Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +Used in conjunction with the data and...
    An Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +Used in conjunction with the data and +tplWriteMode configurations.
    Component tplWriteMode : String
    The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.X...
    The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.XTemplate.overwrite).
    Component type : String
    submit, reset or button - defaults to 'button'
    Button width : Number
    The 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 : 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 @@ -655,7 +690,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 cloneConfig( Object 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 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 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 : 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() @@ -706,9 +746,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 findParentByType( String/Class xtype ) +true, the container will be returned.
    Parameters:Returns:
    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).

    @@ -814,7 +856,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 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 @@ -826,7 +868,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