X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..92c2b89db26be16707f4a805d3303ab2531006e1:/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..88d97649 100644 --- a/docs/output/Ext.menu.ColorMenu.html +++ b/docs/output/Ext.menu.ColorMenu.html @@ -1,4 +1,4 @@ -
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.
+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:
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:
layout: 'anchor' // or 'form', or 'absolute'
See Ext.layout.AnchorLayout.anchor also.
See Ext.layout.AnchorLayout.anchor also.
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.
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
).True to use width:'auto', false to use fixed width (or allow it to be managed by its parent @@ -127,10 +129,21 @@ child items when the browser changes its width:
var myPanel = <
}, {
title: 'Box 3'
}],
-});
The maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to ['add', 'remove']
.
50
.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 +153,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.See Ext.layout.FormLayout.fieldTpl also.
Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
+for this component.
layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items
.x-hidden
or the x-hide-display
CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.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 +178,20 @@ which assigns a value by default:ctCls: 'x-box-layout-ct custom-class'
-tpl
to
+update the content area of the Component.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'.
Defaults to 'panel'
, except Ext.menu.Menu which defaults to 'menuitem'
,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'
.
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,13 +206,19 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
By default, a Menu configured as floating:true
-will be rendered as an Ext.Layer (an absolutely positioned,
-floating Component with zindex=15000).
-If configured as floating:false
, the Menu may be
-used as child item of another Container instead of a free-floating
+});
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 flex
property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex
value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a
flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
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 +269,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
itemId
and ref
.
Note: to access the container of an item see ownerCt
.
An additional CSS class to apply to the div wrapping the form item +
Note: to access the container of an item see ownerCt
.
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 +284,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.
// Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
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 id
with
@@ -288,7 +329,7 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
Note: to access the container of an item see ownerCt.
Note: to access the container of an item see ownerCt.
The separator to display after the text of each @@ -333,9 +374,9 @@ Example use:
new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
layout:'menu'
).
-Developers may override this configuration option if another layout is required.
+});layout:'menu'
).
+Developers may override this configuration option if another layout is required.
See Ext.Container.layout for additional information.Container
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.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',
@@ -455,9 +496,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.
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').
See render also.
handler
-function will be called. Defaults to this ColorMenu instance.See render also.
'resize'
.handler
+function will be called. Defaults to this ColorMenu instance.An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents
may be any type
@@ -546,8 +588,21 @@ Ext.Element.ap...
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.data
and
+tplWriteMode
configurations.Ext.XTemplate.overwrite
).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) )
+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 | |
private : Object We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container | |
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 , Object (Optional) , Object (Optional) )
:
Ext.ComponentAdds Component(s) to this Container.
Description :
@@ -596,10 +655,10 @@ accordingly (see
- | 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 +699,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()
@@ -705,9 +766,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 ] )
:
@@ -743,9 +836,9 @@ by calling Examines this container's items property
and gets a direct child component of this container.Parameters:
| Container | |
getEl()
@@ -794,7 +887,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()
:
@@ -855,7 +948,26 @@ to participate in determination of inherited xtypes.
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:
| Component | |
nextSibling()
+the default), or true to check whether this Component is directly of the specified xtype.Returns:
| 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,7 +1020,9 @@ 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.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.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
:
@@ -947,23 +1061,32 @@ This may be one of:
| 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 +1144,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 )
|