X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..10a866c12701c0a0afd0ac85dcdcf32a421514ac:/docs/output/Ext.CycleButton.html diff --git a/docs/output/Ext.CycleButton.html b/docs/output/Ext.CycleButton.html index cb03c801..e9559812 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
xtype:cycle
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: @@ -37,13 +37,13 @@ to create its subcomponents from that markup if applicable.
If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
-
Component arrowAlign : String
(Optional) The side of the Button box to render the arrow if the button has an associated menu. -Two values are allowe...

(Optional) The side of the Button box to render the arrow if the button has an associated menu. -Two values are allowed:

- +
Component arrowAlign : String
(Optional) The side of the Button box to render the arrow if the button has an associated menu. +Two values are allow...

(Optional) The side of the Button box to render the arrow if the button has an associated menu. +Two values are allowed:

+

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 @@ -105,7 +105,9 @@ result in elements needing to be synchronized with the new height. Example:

< } } } -}).show();
BoxComponent autoShow : Boolean
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove +}).show();
BoxComponent 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 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 @@ -137,11 +139,19 @@ child items when the browser changes its width:

var myPanel = <
     }, {
         title: 'Box 3'
     }],
-});
BoxComponent buttonSelector : String
(Optional) A DomQuery selector which is used to extract the active, clickable element from the -DOM structure created....

(Optional) A DomQuery selector which is used to extract the active, clickable element from the -DOM structure created.

-

When a custom template is used, you must ensure that this selector results in the selection of -a focussable element.

+});
BoxComponent 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.

+

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

BoxComponent boxMinHeight : Number
The minimum value in pixels which this BoxComponent will set its height to. +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 buttonSelector : String
(Optional) A DomQuery selector which is used to extract the active, clickable element from the +DOM structure created...

(Optional) A DomQuery selector which is used to extract the active, clickable element from the +DOM structure created.

+

When a custom template is used, you must ensure that this selector results in the selection of +a focussable element.

Defaults to 'button:first-child'.

Button changeHandler : Function
A callback function that will be invoked each time the active menu item in the button's menu has changed. If this c...
A callback function that will be invoked each time the active menu item in the button's menu has changed. If this callback is not supplied, the SplitButton will instead @@ -154,9 +164,23 @@ directly after each form field wrapper to provide field clearing (defaults to 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 clickEvent : String
The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu). -De...
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 +

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). +De...
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 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.

+
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.

@@ -167,7 +191,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. @@ -184,11 +209,11 @@ Example use:

new Ext.FormPanel({
 });
Component forceIcon : String
A css class which sets an image to be used as the static icon for this button. This icon will always be displayed r...
A css class which sets an image to be used as the static icon for this button. This icon will always be displayed regardless of which item is selected in the dropdown list. This overrides the -default behavior of changing the button's icon to match the selected item's icon on change.
CycleButton handleMouseEvents : Boolean
False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
Button handler : Function
A function called when the button is clicked (can be used instead of click event). -The handler is passed the followin...
A function called when the button is clicked (can be used instead of click event). -The handler is passed the following parameters:
    -
  • b : Button
    This Button.
    • -
  • e : EventObject
    The click event.
    • +default behavior of changing the button's icon to match the selected item's icon on change.
CycleButton handleMouseEvents : Boolean
False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
Button handler : Function
A function called when the button is clicked (can be used instead of click event). +The handler is passed the followi...
A function called when the button is clicked (can be used instead of click event). +The handler is passed the following parameters:
    +
  • b : Button
    This Button.
    • +
  • e : EventObject
    The click event.
Button height : Number
The 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 : Boolean
True to start hidden (defaults to false)
Button hideLabel : Boolean
true to completely hide the label element @@ -215,17 +240,21 @@ 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 -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"> -'top'<...

(Optional) The side of the Button box to render the icon. Four values are allowed:

-
    -
  • 'top'
    • -
  • 'right'
    • -
  • 'bottom'
    • -
  • 'left'
    • -
+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 but...
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"> +'top...

(Optional) The side of the Button box to render the icon. Four values are allowed:

+
    +
  • 'top'
    • +
  • 'right'
    • +
  • 'bottom'
    • +
  • 'left'
    • +

Defaults to 'left'.

Button iconCls : String
A css class which sets a background image to be used as the icon for this button
Button 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 @@ -416,14 +445,14 @@ 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 menu : Mixed
    Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde...
    Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
    Button menuAlign : String
    The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').
    Button minWidth : Number
    The minimum width for this button (used to give a set of buttons a common width). +

    Defaults to:

    {top:0, right:0, bottom:0, left:0}
    BoxComponent menu : Mixed
    Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde...
    Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
    Button menuAlign : String
    The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').
    Button minWidth : Number
    The minimum width for this button (used to give a set of buttons a common width). See also Ext.Panel.minButtonWidth.
    Button 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 overflowText : String
    If used in a Toolbar, the +useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
    Component overflowText : String
    If used in a Toolbar, the +text to be used if this item is shown in the overflow menu. See also +Ext.Toolbar.Item.ove...
    If used in a Toolbar, the text to be used if this item is shown in the overflow menu. See also -Ext.Toolbar.Item.overf...
    If used in a Toolbar, the -text to be used if this item is shown in the overflow menu. See also Ext.Toolbar.Item.overflowText.
    Button 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 ...
    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. @@ -440,9 +469,9 @@ object. The ptype will be looked up at render time up to determine 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 : String
    A 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.

    +take advantage of lazy instantiation and rendering.
    Component ref : String
    A 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',
@@ -461,9 +490,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
         }
     }
 });
    -

    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 : String
    Note: this config is only used when this BoxComponent is rendered +

    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.

    +

    Also see the added and removed events.

    Component region : String
    Note: 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').


    @@ -479,18 +509,18 @@ to render and manage its child items.
    When using this config, a call to render() is not required.
    -

    See render also.

    Component repeat : Boolean/Object
    True to repeat fire the click event while the mouse is down. This can also be -a ClickRepeater config object (defaults...
    True to repeat fire the click event while the mouse is down. This can also be -a ClickRepeater config object (defaults to false).
    Button scale : String
    (Optional) The size of the Button. Three values are allowed: -<ul class="mdetail-params"> -'small'<div class="sub-desc"...

    (Optional) The size of the Button. Three values are allowed:

    -
      -
    • 'small'
      Results in the button element being 16px high.
      • -
    • 'medium'
      Results in the button element being 24px high.
      • -
    • 'large'
      Results in the button element being 32px high.
      • -
    -

    Defaults to 'small'.

    Button scope : Object
    The scope (this reference) in which the -handler and toggleHandler is +

    See render also.

    Component repeat : Boolean/Object
    True to repeat fire the click event while the mouse is down. This can also be +a ClickRepeater config object (default...
    True to repeat fire the click event while the mouse is down. This can also be +a ClickRepeater config object (defaults to false).
    Button scale : String
    (Optional) The size of the Button. Three values are allowed: +<ul class="mdetail-params"> +'small'<div class="sub-des...

    (Optional) The size of the Button. Three values are allowed:

    +
      +
    • 'small'
      Results in the button element being 16px high.
      • +
    • 'medium'
      Results in the button element being 24px high.
      • +
    • 'large'
      Results in the button element being 32px high.
      • +
    +

    Defaults to 'small'.

    Button scope : Object
    The scope (this reference) in which the +handler and toggleHandler is executed. Defaults to this Button.
    Button showText : Boolean
    True to display the active item's text as the button text (defaults to false)
    CycleButton stateEvents : Array
    An 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 @@ -565,13 +595,24 @@ Ext.Element.ap...

    A custom style specification to be appl 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 template : Ext.Template
    A Template used to create the Button's DOM structure. -Instances, or subclasses which need a different DOM structure m...

    A Template used to create the Button's DOM structure.

    -Instances, or subclasses which need a different DOM structure may provide a different -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 if 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). +must be called in order for the tips to render.
    BoxComponent template : Ext.Template
    +A Template used to create the Button's DOM structure. +Instances, or subclasses which need a different DOM structure...
    +

    A Template used to create the Button's DOM structure.

    +Instances, or subclasses which need a different DOM structure may provide a different +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 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 @@ -584,8 +625,8 @@ The predefined xtypes are listed 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

    PropertyDefined By
     y : Number
    The local y (top) coordinate for this component if contained within a positioning container.
    		BoxComponent

    Public Properties

    PropertyDefined By
     disabled : Boolean
    Read-only. True if this button is disabled
    		Button
     pressed : Boolean
    Read-only. True if this button is pressed (only if enableToggle = true)
    		Button
     rendered : Boolean
    True if this component has been rendered. Read-only.
    		Component

    Public Methods

    MethodDefined By
     pressed : Boolean
    Read-only. True if this button is pressed (only if enableToggle = true)
    		Button
     rendered : Boolean
    True if this component has been rendered. Read-only.
    		Component

    Public Methods

    MethodDefined By

    Public Events

    EventDefined By

    Public Events

    EventDefined By