X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..e9397f91ede62d446aed37d23256e8938fc4c335:/docs/output/Ext.menu.ColorMenu.html?ds=inline diff --git a/docs/output/Ext.menu.ColorMenu.html b/docs/output/Ext.menu.ColorMenu.html index 32239f0c..a242a535 100644 --- a/docs/output/Ext.menu.ColorMenu.html +++ b/docs/output/Ext.menu.ColorMenu.html @@ -1,24 +1,29 @@ -
Observable Component BoxComponent Container Menu ColorMenu
Package: | Ext.menu |
Defined In: | ColorMenu.js |
Class: | ColorMenu |
Extends: | Menu |
xtype: | colormenu |
A menu containing a Ext.ColorPalette Component.
-Notes:
Observable + Component + BoxComponent + Container + Menu + ColorMenu
Package: | Ext.menu |
Defined In: | ColorMenu.js |
Class: | ColorMenu |
Extends: | Menu |
A menu containing a Ext.ColorPalette Component.
+Notes:
Config Options | Defined By | |
---|---|---|
activeItem : String/Number A string component id or the numeric index of the component that should be initially activated within the
container's... A string component id or the numeric index of the component that should be initially activated within the
container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
item in the container's collection). activeItem only applies to layout styles that can display
items one at a time (like Ext.layout.AccordionLayout, Ext.layout.CardLayout and
-Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. | Container | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
allowOtherMenus : Boolean True to allow multiple menus to be displayed at the same time (defaults to false) | Menu | |
anchor : String Note: this config is only used when this Component is rendered
+Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. | Container | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
allowOtherMenus : Boolean True to allow multiple menus to be displayed at the same time (defaults to false) | Menu | |
anchor : String Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component.
| 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 @@ -127,10 +134,21 @@ child items when the browser changes its width:
| BoxComponent | |
bufferResize : Boolean/Number When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
-t... When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+}); | 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 | |
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 | Container | |
bufferResize : Boolean/Number When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
-with a large quantity of sub-components for which frequent layout calls would be expensive. | Container | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50 . | Container | |
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'). @@ -140,7 +158,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
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
| 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. @@ -151,19 +183,20 @@ which assigns a value by default:
- | Component | |
defaultAlign : String The default Ext.Element.alignTo anchor position value for this menu
-relative to its element of origin (defaults to '... The default Ext.Element.alignTo anchor position value for this menu
-relative to its element of origin (defaults to 'tl-bl?') | Menu | |
defaultOffsets : Array An array specifying the [x, y] offset in pixels by which to
-change the default Menu popup position after aligning ac... An array specifying the [x, y] offset in pixels by which to
-change the default Menu popup position after aligning according to the defaultAlign
+ | Component | |
data : Mixed The initial set of data to apply to the tpl to
+update the content area of the Component. | Component | |
defaultAlign : String The default Ext.Element.alignTo anchor position value for this menu
+relative to its element of origin (defaults to 't... The default Ext.Element.alignTo anchor position value for this menu
+relative to its element of origin (defaults to 'tl-bl?') | Menu | |
defaultOffsets : Array An array specifying the [x, y] offset in pixels by which to
+change the default Menu popup position after aligning acc... An array specifying the [x, y] offset in pixels by which to
+change the default Menu popup position after aligning according to the defaultAlign
configuration. Defaults to [0, 0]. | Menu | |
defaultType : String The default xtype of child Components to create in this Container when
a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component. -Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem', -and Ext.Toolbar and Ext.ButtonGroup which default to 'button'. | Container | |
defaults : Object A config object that will be applied to all items added to this container either via the items
-config or via the add... A config object that will be applied to all items added to this container either via the items
-config or via the add method. The defaults config can contain any number of
-name/value property pairs to be added to each item, and should be valid for the types of items
+ Defaults to | Container | |
defaults : Object A config object that will be applied to all items added to this container either via the items
+config or via the add ... | Menu | |
disabled : Boolean Render this component disabled (default is false). | Component | |
disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | |
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 @@ -178,20 +211,26 @@ Example use:
| Component | |
floating : Boolean By default, a Menu configured as floating:true
-will be rendered as an Ext.Layer (an absolutely positioned,
-floating... By default, a Menu configured as | Component | |
flex : Number Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a | BoxComponent | |
floating : Boolean By default, a Menu configured as floating:true
+will be rendered as an Ext.Layer (an absolutely positioned,
+floating C... | Menu | |
forceLayout : Boolean If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | |
handler : Function Optional. A function that will handle the select event of this menu.
-The handler is passed the following parameters:... Optional. A function that will handle the select event of this menu.
-The handler is passed the following parameters:
| Container | |
handler : Function Optional. A function that will handle the select event of this menu.
+The handler is passed the following parameters:<... Optional. A function that will handle the select event of this menu.
+The handler is passed the following parameters:
| ColorMenu | |
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 Render this component hidden (default is false). If true, the
@@ -221,7 +260,11 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). | Component | |
hideOnClick : Boolean False to continue showing the menu after a color is selected, defaults to true. | ColorMenu | |
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 | |
id : String The unique id of this component (defaults to an auto-assigned id).
+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 | |
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 not have an object reference available (e.g., using Ext.getCmp). @@ -231,10 +274,13 @@ rules to style the specific instance of this component uniquely, and also to sel sub-elements using this component's id as the parent.Note: to avoid complications imposed by a unique id also see
Note: to access the container of an item see | Component | |
ignoreParentClicks : Boolean True to ignore clicks on any item in this menu that is a parent item (displays
-a submenu) so that the submenu is not... True to ignore clicks on any item in this menu that is a parent item (displays
-a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false). | Menu | |
itemCls : String An additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item + Note: to access the container of an item see | Component | |
ignoreParentClicks : Boolean True to ignore clicks on any item in this menu that is a parent item (displays
+a submenu) so that the submenu is not ... True to ignore clicks on any item in this menu that is a parent item (displays
+a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false). | Menu | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo... 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. +Ext.form.FormPanel or specifying layout:'form'). + An additional CSS class to apply to the div wrapping the form item element of this field. If supplied, itemCls at the field level will override the default itemCls supplied at the container level. The value specified for itemCls will be added to the default class ('x-form-item'). @@ -243,22 +289,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.Note: see the note for fieldLabel. -Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. Instead of using an Note: to access the container of an item see ownerCt. | Component | |
items : Mixed An array of items to be added to this menu. Menus may contain either menu items,
+ Note: to access the container of an item see ownerCt. | Component | |
items : Mixed An array of items to be added to this menu. Menus may contain either menu items,
or general Components. | Menu | |
labelSeparator : String The separator to display after the text of each
fieldLabel. This property may be configured at various levels.
The o... The separator to display after the text of each @@ -333,9 +379,9 @@ Example use:
| Component | |
layout : String/Object This class assigns a default layout (layout:'menu').
-Developers may override this configuration option if another la... This class assigns a default layout ( layout:'menu' ).
-Developers may override this configuration option if another layout is required.
+}); | Component | |
layout : String/Object This class assigns a default layout (layout:'menu').
+Developers may override this configuration option if another lay... This class assigns a default layout ( layout:'menu' ).
+Developers may override this configuration option if another layout is required.
See Ext.Container.layout for additional information. | Menu | |
layoutConfig : Object | Container | |
listeners : Object A config object containing one or more event handlers to be added to this
@@ -420,7 +466,7 @@ of the viewport. This value is typically managed by the chosen Container | ||
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
+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 | |
paletteId : String An id to assign to the underlying color palette. Defaults to null. | ColorMenu | |
plain : Boolean True to remove the incised line down the left side of the menu. Defaults to false. | Menu | |
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.
When a component is created, if any plugins are available, the component will call the init method on each
@@ -434,9 +480,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 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:
-In the code above, if the ref had been | Component | |
region : String | 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'). @@ -473,9 +520,9 @@ to render and manage its child items. When using this config, a call to render() is not required.
See render also. | Component | |
scope : Object The scope (this reference) in which the handler
-function will be called. Defaults to this ColorMenu instance. | ColorMenu | |
shadow : Boolean/String True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
-for bottom-right shadow (defaults to 's... True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
+ See render also. | Component | |
resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize' . | Container | |
scope : Object The scope (this reference) in which the handler
+function will be called. Defaults to this ColorMenu instance. | ColorMenu | |
shadow : Boolean/String True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
+for bottom-right shadow (defaults to 'si... True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
for bottom-right shadow (defaults to 'sides') | Menu | |
showSeparator : Boolean True to show the icon separator. (defaults to true). | Menu | |
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). A custom style specification to be appl
}
})
]
-}); | Component | |
subMenuAlign : String The Ext.Element.alignTo anchor position value to use for submenus of
-this menu (defaults to 'tl-tr?') | Menu | |
width : Number The width of this component in pixels (defaults to auto).
+}); | Component | |
subMenuAlign : String The Ext.Element.alignTo anchor position value to use for submenus of
+this menu (defaults to 'tl-tr?') | Menu | |
tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+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 | |
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 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 | |
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
@@ -560,7 +620,7 @@ 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 |
Property | Defined By | |
---|---|---|
disabled : Boolean True if this component is disabled. Read-only. | Component | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
+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 | |
zIndex : Number zIndex to use when the menu is floating. | Menu |
Property | Defined By | |
---|---|---|
disabled : Boolean True if this component is disabled. Read-only. | Component | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the
-See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
items : MixedCollection The collection of components in this container as a Ext.util.MixedCollection | Container | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | |
palette : ColorPalette -The {@link Ext.ColorPalette} instance for this ColorMenu | ColorMenu | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
add( Object/Array component , Object (Optional) , Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
+ See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
items : MixedCollection The collection of components in this container as a Ext.util.MixedCollection | Container | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... | Component | |
palette : ColorPalette +The {@link Ext.ColorPalette} instance for this ColorMenu | ColorMenu | |
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref . | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
add( ...Object/Array component )
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin... Adds Component(s) to this Container. @@ -596,10 +658,10 @@ accordingly (see
- Parameters:
| Container | |
addClass( string cls )
+Parameters:
| Container | |
addClass( string cls )
:
Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addElement( Mixed el )
:
- Ext.menu.ItemAdds an Ext.Element object to the menu Adds an Ext.Element object to the menu Parameters:
| Menu | |
addEvents( Object object )
+ Ext.menu.ItemAdds an Ext.Element object to the menu Adds an Ext.Element object to the menu Parameters:
| Menu | |
addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addItem( Ext.menu.Item item )
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addItem( Ext.menu.Item item )
:
Ext.menu.ItemAdds an existing object based on Ext.menu.BaseItem to the menu Adds an existing object based on Ext.menu.BaseItem to the menu Parameters:
| Menu | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -638,8 +702,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
Attaching multiple handlers in 1 call
Or a shorthand syntax: Returns:
| Observable | |
addMenuItem( Object config )
:
Ext.menu.ItemCreates a new Ext.menu.Item based an the supplied config object and adds it to the menu Creates a new Ext.menu.Item based an the supplied config object and adds it to the menu Parameters:
| Menu | |
addSeparator()
@@ -676,12 +740,12 @@ Or a shorthand syntax: : Ext.menu.Item Creates a new Ext.menu.TextItem with the supplied text and adds it to the menu Creates a new Ext.menu.TextItem with the supplied text and adds it to the menu Parameters:
| Menu | |
applyToMarkup( String/HTMLElement el )
:
- voidApply 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:
| Component | |
bubble( Function fn , [Object scope ], [Array args ] )
+ voidApply 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:
| Component | |
bubble( Function fn , [Object scope ], [Array args ] )
:
- Ext.ContainerBubbles 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
+ 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:
| Container | |
cascade( Function fn , [Object scope ], [Array args ] )
+the bubble is stopped.Parameters:
| Component | |
cascade( Function fn , [Object scope ], [Array args ] )
:
Ext.ContainerCascades down the component/container heirarchy from this component (called first), calling the specified function wi... Cascades down the component/container heirarchy from this component (called first), calling the specified function with
each component. The scope (this) of
@@ -705,9 +769,41 @@ to... Force this container's layout to be recalculated. A
to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:
| Container | |
enable()
:
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
find( String prop , String value )
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
+ :
+ voidEnables 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 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:
Parameters:
| Observable | |
find( String prop , String value )
:
ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:
| Container | |
findBy( Function fn , [Object scope ] )
:
@@ -722,9 +818,11 @@ the default), or true to check whether this Component is directly of the specifi
:
Ext.ContainerFind 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:
| Component | |
findParentByType( String/Class xtype )
+true, the container will be returned.Parameters:
| Component | |
findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
- Ext.ContainerFind 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:
| Component | |
fireEvent( String eventName , Object... args )
+ Ext.ContainerFind 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:
| Component | |
fireEvent( String eventName , Object... args )
:
BooleanFires 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). @@ -743,9 +841,9 @@ by calling Examines this container'sitems property
and gets a direct child component of this container.Parameters:
| Container | |
getEl()
@@ -794,7 +892,7 @@ the element into which the Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getResizeEl()
:
- void Returns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
contains both the Parameters:
| BoxComponent | |
getSize()
+This Element is returned as the resizeEl .Parameters:
| BoxComponent | |
getSize()
:
Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getWidth()
:
@@ -842,7 +940,7 @@ property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.Component.Returns:
| Container | |
isVisible()
:
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
+ BooleanReturns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
BooleanTests 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 @@ -854,8 +952,31 @@ to participate in determination of inherited xtypes.
Parameters:
| Component | |
nextSibling()
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance Parameters:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component +is destroyed. Usage:
+or:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
nextSibling()
:
Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -908,12 +1029,14 @@ which this component will be inserted (defaults to appending to the end of the c
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:
| Observable | |
setDisabled( Boolean disabled )
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| Component | |
setHeight( Mixed height )
+ :
+ Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setPagePosition( Number x , Number y )
@@ -940,30 +1063,39 @@ This may be one of:
| BoxComponent | |
setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show( Mixed element , [String position ], [Ext.menu.Menu parentMenu ] )
:
- voidIf floating=true, shows this menu relative to
-another element, otherwise uses Ext.Component.show. If floating=true , shows this menu relative to
-another element, otherwise uses Ext.Component.show.Parameters:
| Menu | |
showAt( Array xyPosition , [Ext.menu.Menu parentMenu ] )
:
- voidDisplays this menu at a specific xy position Displays this menu at a specific xy position Parameters:
| Menu | |
suspendEvents( Boolean queueSuspended )
+ voidDisplays this menu at a specific xy position and fires the 'show' event if a
+handler for the 'beforeshow' event does ... Displays this menu at a specific xy position and fires the 'show' event if a
+handler for the 'beforeshow' event does not return false cancelling the operation. Parameters:
| Menu | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
syncSize()
:
Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | |
un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent |
Event | Defined By | |
---|---|---|
add :
( Ext.Container this , Ext.Component component , Number index )
- Listeners will be called with the following arguments:
| Container | |
afterlayout :
+ Listeners will be called with the following arguments:
| Container | |
added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afterlayout :
( Ext.Container this , ContainerLayout layout )
Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments:
| Container | |
afterrender :
( Ext.Component this )
@@ -1021,7 +1153,9 @@ Fires after the component is hidden when calling the Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
remove :
( Ext.Container this , Ext.Component component )
- Listeners will be called with the following arguments:
| Container | |
render :
+ Listeners will be called with the following arguments:
| Container | |
removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
|