X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.form.FieldSet.html diff --git a/docs/output/Ext.form.FieldSet.html b/docs/output/Ext.form.FieldSet.html deleted file mode 100644 index f3ccd103..00000000 --- a/docs/output/Ext.form.FieldSet.html +++ /dev/null @@ -1,2936 +0,0 @@ -
Observable - Component - BoxComponent - Container - Panel - FieldSet
Package: | Ext.form |
Defined In: | FieldSet.js |
Class: | FieldSet |
Extends: | Panel |
Config Options | -Defined By | -|
---|---|---|
- |
-
- allowDomMove : Boolean
- Whether the component can move the Dom node when rendering (defaults to true).
- |
- Component | -
- |
-
- animCollapse : Boolean
- True to animate the transition when the panel is collapsed, false to skip the animation (defaults to false).
- |
- FieldSet | -
- |
-
- autoDestroy : Boolean
-
- If true the container will automatically destroy any contained component that is removed from it, else destruction mu...
-
- If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).
- |
- Container | -
- |
-
- autoEl : String/Object
-
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...
-
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage:
- |
- Component | -
- |
-
- autoHeight : Boolean
-
- True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...
-
- True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all.
- |
- BoxComponent | -
- |
-
- autoLoad : Object/String/Function
-
- A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt ...
-
- A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt to load its contents immediately upon render.
- The URL will become the default URL for this panel's body element, so it may be refreshed at any time. |
- Panel | -
- |
-
- autoScroll : Boolean
-
- True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to c...
-
- True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false).
- |
- Panel | -
- |
-
- 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 (defaults to false). Note: Although many components inherit this c...
-
- True to use width:'auto', false to use fixed width (defaults to false). Note: Although many components inherit this config option, not all will function as expected with a width of 'auto'. Setting autoWidth:true means that the browser will manage width based on the element's contents, and that Ext will not manage it at all.
- |
- BoxComponent | -
- |
-
- baseCls : String
- The base CSS class applied to the fieldset (defaults to 'x-fieldset').
- |
- FieldSet | -
- |
-
- bodyCfg : Object
-
- A DomHelper configuration object specifying the element structure of this Panel's body Element. This may be used to f...
-
-
- A DomHelper configuration object specifying the element structure of this Panel's body Element. This may be used to force the body Element to use a different form of markup than is created automatically. An example of this might be to create a child Panel containing custom content, such as a header, or forcing centering of all Panel content by having the body be a <center> element: |
- Panel | -
- |
-
- bodyStyle : String/Object/Function
-
- Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to nu...
-
- Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
- |
- Panel | -
- |
-
- checkboxName : String
- The name to assign to the fieldset's checkbox if checkboxToggle = true (defaults to '[checkbox id]-checkbox').
- |
- FieldSet | -
- |
-
- checkboxToggle : Mixed
-
- True to render a checkbox into the fieldset frame just in front of the legend, or a DomHelper config object to create...
-
- True to render a checkbox into the fieldset frame just in front of the legend, or a DomHelper config object to create the checkbox. (defaults to false). The fieldset will be expanded or collapsed when the checkbox is toggled.
- |
- FieldSet | -
- |
-
- clearCls : String
-
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...
-
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left').
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. |
- Component | -
- |
-
- cls : String
-
- An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...
-
- 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 | -
- |
-
- collapsed : Boolean
- True to render the panel collapsed, false to render it expanded (defaults to false).
- |
- Panel | -
- |
-
- collapsedCls : String
- A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
- |
- Panel | -
- |
-
- collapsible : Boolean
-
- True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header ...
-
- True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false).
- |
- Panel | -
- |
-
- contentEl : String
-
- The id of an existing HTML node to use as the panel's body content (defaults to ''). The specified Element is appende...
-
- The id of an existing HTML node to use as the panel's body content (defaults to ''). The specified Element is appended to the Panel's body Element by the Panel's afterRender method after any configured HTML has been inserted, and so the document will not contain this HTML at the time the render event is fired.
- |
- Panel | -
- |
-
- ctCls : String
-
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
-
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
- |
- Component | -
- |
-
- defaults : Object
-
- A config object that will be applied to all components added to this container either via the items config or via the...
-
- A config object that will be applied to all components added to this container either via the items config or via the add or insert methods. 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 being added to the container. For example, to automatically apply padding to the body of each of a set of contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
- |
- Container | -
- |
-
- disabled : Boolean
- Render this component disabled (default is false).
- |
- Component | -
- |
-
- draggable : Boolean
-
- True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD conf...
-
-
- True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true. Ext.Panel.DD is an internal, undocumented class which moves a proxy Element around in place of the Panel's element, but provides no other behaviour during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be added by implementing the interface methods of Ext.dd.DragDrop eg: |
- Panel | -
- |
-
- fieldLabel : String
-
- The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...
-
- The label text to display next to this Component (defaults to '')
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- height : Number
- The height of this component in pixels (defaults to auto).
- |
- BoxComponent | -
- |
-
- Render this component hidden (default is false).
- |
-
- hidden : Boolean Component | -
- |
-
- hideBorders : Boolean
-
- True to hide the borders of each contained component, false to defer to the component's existing border settings (def...
-
- True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
- |
- Container | -
- |
-
- hideLabel : Boolean
-
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...
-
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space.
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- hideMode : String
-
- How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...
-
-
- How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts. |
- 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 | -
- |
-
- html : String/Object
-
- An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to ''). The HTML content ...
-
- An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to ''). The HTML content is added by the Panel's afterRender method, and 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.
- |
- Panel | -
- |
-
- 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.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.
- |
- Component | -
- |
-
- itemCls : String
- A css class to apply to the x-form-item of fields. This property cascades to child containers.
- |
- FieldSet | -
- |
-
- items : Mixed
-
- A single item, or an array of child Components to be added to this container. Each item can be any type of object bas...
-
- A single item, or an array of child Components to be added to this container. Each item can be any type of object based on Ext.Component.
- Component config objects may also be specified in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the added Component will not be rendered immediately. To take advantage of this "lazy instantiation", set the Ext.Component.xtype config property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.Component. If a single item is being passed, it should be passed directly as an object reference (e.g., items: {...}). Multiple items should be passed as an array of objects (e.g., items: [{...}, {...}]). |
- Container | -
- |
-
- keys : Object/Array
-
- A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa...
-
- A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
- |
- Panel | -
- |
-
- labelSeparator : String
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- labelStyle : String
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').
- . This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- labelWidth : Number
- The width of labels. This property cascades to child containers.
- |
- FieldSet | -
- |
-
- layout : String
- The Ext.Container.layout to use inside the fieldset (defaults to 'form').
- |
- FieldSet | -
- |
-
- layoutConfig : Object
-
- This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layou...
-
- This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layout config value). For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified:
- |
- Container | -
- |
-
- listeners : Object
-
- (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
-
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
- |
- Observable | -
- |
-
- maskDisabled : Boolean
-
- True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway...
-
- True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled.
- |
- Panel | -
- |
-
- minButtonWidth : Number
- Minimum width in pixels of all buttons in this panel (defaults to 75)
- |
- Panel | -
- |
-
- monitorResize : Boolean
-
- True to automatically monitor window resize events to handle anything that is sensitive to the current size of the vi...
-
- True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.
- |
- 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 requirement for a v...
-
- 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 plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.
- |
- Component | -
- |
-
- renderTo : Mixed
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
- |
- Component | -
- |
-
- stateEvents : Array
-
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
-
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']).
- See stateful for an explanation of saving and restoring Component state. |
- Component | -
- |
-
- stateId : String
-
- The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...
-
- The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id).
- See stateful for an explanation of saving and restoring Component state. |
- Component | -
- |
-
- stateful : Boolean
-
- A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...
-
-
- A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component. For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page: Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events |
- Component | -
- |
-
- style : String
-
- A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...
-
- A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.
- |
- Component | -
- |
-
- tabTip : String
-
- Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must...
-
- Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must be called in order for the tips to render.
- |
- Panel | -
- |
-
- title : String
-
- The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut...
-
- The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
- |
- Panel | -
- |
-
- width : Number
- The width of this component in pixels (defaults to auto).
- |
- BoxComponent | -
- |
-
- x : Number
- The local x (left) coordinate for this component if contained within a positioning container.
- |
- BoxComponent | -
- |
-
- y : Number
- The local y (top) coordinate for this component if contained within a positioning container.
- |
- BoxComponent | -
Property | -Defined By | -|
---|---|---|
- |
-
- body : Ext.Element
-
-
-The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config,...
-
-
-The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, or it may be loaded using the
-autoLoad config, or through the Panel's Updater. Read-only.
-
- If this is used to load visible HTML elements in either way, then -the Panel may not be used as a Layout for hosting nested Panels. -If this Panel is intended to be used as the host of a Layout (See layout -then the body Element must not be loaded or changed - it is under the control -of the Panel's Layout. |
- Panel | -
- |
-
- buttons : Array
- This Panel's Array of buttons as created from the buttons
-config property. Read only.
- |
- Panel | -
- |
-
- dd : Ext.dd.DragSource.
-
- If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles drag...
-
-
- If this Panel is configured draggable, this property will contain -an instance of Ext.dd.DragSource which handles dragging the Panel. -The developer must provide implementations of the abstract methods of Ext.dd.DragSource -in order to supply behaviour for each stage of the drag/drop process. See draggable. |
- Panel | -
- |
-
- disabled : Boolean
- True if this component is disabled. Read-only.
- |
- Component | -
- |
-
-
-True if this component is hidden. Read-only.
- |
-
- hidden : Boolean 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.
- |
- Component | -
- |
-
- rendered : Boolean
- True if this component has been rendered. Read-only.
- |
- Component | -
Method | -Defined By | -|
---|---|---|
- |
-
- FieldSet( Object config )
-
-
-
-
-
- Parameters:
-
-
|
- FieldSet | -
- |
-
- add( Ext.Component/Object component ) : Ext.Component
-
- Adds a Component to this Container. Fires the beforeadd event before
-adding, then fires the add event after the compo...
-
-
- Adds a Component to this Container. Fires the beforeadd event before -adding, then fires the add event after the component has been added. -You will never call the render method of a child Component when using a Container. -Child Components are rendered by this Container's layout manager when -this Container is first rendered. -Certain layout managers allow dynamic addition of child components. Those that do -include Ext.layout.CardLayout, Ext.layout.AnchorLayout, -Ext.layout.FormLayout, Ext.layout.TableLayout. -If the Container is already rendered when add is called, you may need to call -doLayout to refresh the view which causes any unrendered child Components -to be rendered. This is required so that you can add multiple child components if needed -while only refreshing the layout once. -When creating complex UIs, it is important to remember that sizing and positioning -of child items is the responsibility of the Container's layout manager. If -you expect child items to be sized in response to user interactions, you must -specify a layout manager which creates and manages the type of layout you have in mind. -Omitting the layout config means that a basic layout manager is -used which does nothnig but render child components sequentially into the Container. -No sizing or positioning will be performed in this situation.
- Parameters:
-
-
|
- Container | -
- |
-
- addButton( String/Object config , Function handler , Object scope ) : Ext.Button
-
- Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to ...
-
- Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to add buttons via the buttons config.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- addClass( string cls ) : void
-
- Adds a CSS class to the component's underlying element.
-
- Adds a CSS class to the component's underlying element.
-
- Parameters:
-
-
|
- Component | -
- |
-
- addEvents( Object object ) : void
-
- Used to define events on this Observable
-
- Used to define events on this Observable
-
- Parameters:
-
-
|
- Observable | -
- |
-
- addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void
-
- Appends an event handler to this component
-
- Appends an event handler to this component
-
- Parameters:
-
-
|
- Observable | -
- |
-
- applyToMarkup( String/HTMLElement el ) : void
-
- Apply this component to existing markup that is valid. With this function, no call to render() is required.
-
- Apply this component to existing markup that is valid. With this function, no call to render() is required.
-
- Parameters:
-
-
|
- Component | -
- |
-
- bubble( Function fn , [Object scope ], [Array args ] ) : void
-
- 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 ] ) : void
-
- Cascades 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
-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 cascade is stopped on that branch.
-
- Parameters:
-
-
|
- Container | -
- |
-
- cloneConfig( Object overrides ) : Ext.Component
-
- Clone the current component using the original config values passed into this instance by default.
-
- Clone the current component using the original config values passed into this instance by default.
-
- Parameters:
-
-
|
- Component | -
- |
-
- collapse( Boolean animate ) : Ext.Panel
-
- Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse ac...
-
- Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse action if it returns false.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- destroy() : void
-
- Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c...
-
- Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its Ext.Container (if applicable) and unregistering it from
-Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly.
-
- Parameters:
-
-
|
- Component | -
- |
-
- disable() : Ext.Component
-
- Disable this component.
-
- Disable this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- doLayout( [Boolean shallow ] ) : void
-
- Force this container's layout to be recalculated. A call to this function is required after adding a new component
-to...
-
- Force this container's layout to be recalculated. A call to this function is required after adding a new component
-to an already rendered container, or possibly after changing sizing/position properties of child components.
-
- Parameters:
-
-
|
- Container | -
- |
-
- enable() : Ext.Component
-
- Enable this component.
-
- Enable this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- expand( Boolean animate ) : Ext.Panel
-
- Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action ...
-
- Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action if it returns false.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- find( String prop , String value ) : Array
-
- Find 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 fcn , [Object scope ] ) : Array
-
- Find a component under this container at any level by a custom function. If the passed function returns
-true, the com...
-
- Find a component under this container at any level by a custom function. If the passed function returns
-true, the component will be included in the results. The passed function is called with the arguments (component, this container).
-
- Parameters:
-
-
|
- Container | -
- |
-
- findById( String id ) : Ext.Component
-
- Find a component under this container at any level by id
-
- Find a component under this container at any level by id
-
- Parameters:
-
-
|
- Container | -
- |
-
- findByType( String/Class xtype , [Boolean shallow ] ) : Array
-
- Find a component under this container at any level by xtype or class
-
- Find a component under this container at any level by xtype or class
-
- Parameters:
-
-
|
- Container | -
- |
-
- findParentBy( Function fcn , [Object scope ] ) : Ext.Container
-
- Find a container above this component at any level by a custom function. If the passed function returns
-true, the con...
-
- Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. The passed function is called with the arguments (container, this component).
-
- Parameters:
-
-
|
- Component | -
- |
-
- findParentByType( String/Class xtype ) : Ext.Container
-
- Find a container above this component at any level by xtype or class
-
- Find a container above this component at any level by xtype or class
-
- Parameters:
-
-
|
- Component | -
- |
-
- fireEvent( String eventName , Object... args ) : Boolean
-
- Fires the specified event with the passed parameters (minus the event name).
-
- Fires the specified event with the passed parameters (minus the event name).
-
- Parameters:
-
-
|
- Observable | -
- |
-
- getBox( [Boolean local ] ) : Object
-
- Gets the current box measurements of the component's underlying element.
-
- Gets the current box measurements of the component's underlying element.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- getComponent( String/Number id ) : Ext.Component
-
- Gets a direct child Component by id, or by index.
-
- Gets a direct child Component by id, or by index.
-
- Parameters:
-
-
|
- Container | -
- |
-
- getEl() : Ext.Element
-
- Returns the underlying Ext.Element.
-
- Returns the underlying Ext.Element.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getFrameHeight() : Number
-
- Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and ...
-
- Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getFrameWidth() : Number
-
- Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the bo...
-
- Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the body width see getInnerWidth.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getId() : String
-
- Returns the id of this component.
-
- Returns the id of this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getInnerHeight() : Number
-
- Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame he...
-
- Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame height see getFrameHeight.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getInnerWidth() : Number
-
- Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame widt...
-
- Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame width see getFrameWidth.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getItemId() : String
-
- Returns the item id of this component.
-
- Returns the item id of this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getLayout() : ContainerLayout
-
- Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a defau...
-
- Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a default Ext.layout.ContainerLayout will be created and set as the container's layout.
-
- Parameters:
-
-
|
- Container | -
- |
-
- getLayoutTarget() : Ext.Element
-
- Returns the Element to be used to contain the child Components of this Container.
-An implementation is provided which...
-
-
- Returns the Element to be used to contain the child Components of this Container. -An implementation is provided which returns the Container's Element, but -if there is a more complex structure to a Container, this may be overridden to return -the element into which the layout renders child Components.
- Parameters:
-
-
|
- Container | -
- |
-
- getPosition( [Boolean local ] ) : Array
-
- Gets the current XY position of the component's underlying element.
-
- Gets the current XY position of the component's underlying element.
-
- 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 | -
- |
-
- getTool( String id ) : Object
-
- Retrieve a tool by id.
-
- Retrieve a tool by id.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getUpdater() : Ext.Updater
-
- Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body.
-
- Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- getXType() : String
-
- Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex...
-
- Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ext.Component header. Example usage:
-
-
- Parameters:
-
-
|
- Component | -
- |
-
- getXTypes() : String
-
- Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext...
-
-
- Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all -available xtypes, see the Ext.Component header. -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -Example usage: -
- Parameters:
-
-
|
- Component | -
- |
-
- hasListener( String eventName ) : Boolean
-
- Checks to see if this object has any listeners for a specified event
-
- Checks to see if this object has any listeners for a specified event
-
- Parameters:
-
-
|
- Observable | -
- |
-
- hide() : Ext.Component
-
- Hide this component.
-
- Hide this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- insert( Number index , Ext.Component component ) : Ext.Component
-
- Inserts a Component into this Container at a specified index. Fires the
-beforeadd event before inserting, then fires ...
-
- Inserts a Component into this Container at a specified index. Fires the
-beforeadd event before inserting, then fires the add event after the
-Component has been inserted.
-
- Parameters:
-
-
|
- Container | -
- |
-
- isVisible() : void
-
- Returns true if this component is visible.
-
- Returns true if this component is visible.
-
- Parameters:
-
-
|
- Component | -
- |
-
- isXType( String xtype , [Boolean shallow ] ) : void
-
- Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th...
-
-
- Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended -from the xtype (default) or whether it is directly of the xtype specified (shallow = true). -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -For a list of all available xtypes, see the Ext.Component header. -Example usage: -
- Parameters:
-
-
|
- Component | -
- |
-
- load( Object/String/Function config ) : Ext.Panel
-
- Loads this content panel immediately with content returned from an XHR call.
-
- Loads this content panel immediately with content returned from an XHR call.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- on( String eventName , Function handler , [Object scope ], [Object options ] ) : void
-
- Appends an event handler to this element (shorthand for addListener)
-
- Appends an event handler to this element (shorthand for addListener)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- purgeListeners() : void
-
- Removes all listeners for this object
-
- Removes all listeners for this object
-
- Parameters:
-
-
|
- Observable | -
- |
-
- relayEvents( Object o , Array events ) : void
-
- Relays selected events from the specified Observable as if the events were fired by this.
-
- Relays selected events from the specified Observable as if the events were fired by this.
-
- Parameters:
-
-
|
- Observable | -
- |
-
- remove( Component/String component , [Boolean autoDestroy ] ) : Ext.Component
-
- Removes a component from this container. Fires the beforeremove event before removing, then fires
-the remove event a...
-
- Removes a component from this container. Fires the beforeremove event before removing, then fires
-the remove event after the component has been removed.
-
- Parameters:
-
-
|
- Container | -
- |
-
- removeAll( [Boolean autoDestroy ] ) : Array
-
- Removes all components from this container.
-
- Removes all components from this container.
-
- Parameters:
-
-
|
- Container | -
- |
-
- removeClass( string cls ) : void
-
- Removes a CSS class from the component's underlying element.
-
- Removes a CSS class from the component's underlying element.
-
- Parameters:
-
-
|
- Component | -
- |
-
- removeListener( String eventName , Function handler , [Object scope ] ) : void
-
- Removes a listener
-
- Removes a listener
-
- Parameters:
-
-
|
- Observable | -
- |
-
- render( [Element/HTMLElement/String container ], [String/Number position ] ) : void
-
- Render this Component into the passed HTML element.
-If you are using a Container object to house this Component, then...
-
-
- Render this Component into the passed HTML element. -If you are using a Container object to house this Component, then -do not use the render method. -A Container's child Components are rendered by that Container's -layout manager when the Container is first rendered. -Certain layout managers allow dynamic addition of child components. Those that do -include Ext.layout.CardLayout, Ext.layout.AnchorLayout, -Ext.layout.FormLayout, Ext.layout.TableLayout. -If the Container is already rendered when a new child Component is added, you may need to call -the Container's doLayout to refresh the view which causes any -unrendered child Components to be rendered. This is required so that you can add multiple -child components if needed while only refreshing the layout once. -When creating complex UIs, it is important to remember that sizing and positioning -of child items is the responsibility of the Container's layout manager. -If you expect child items to be sized in response to user interactions, you must -configure the Container with a layout manager which creates and manages the type of layout you -have in mind. -Omitting the Container's layout config means that a basic -layout manager is used which does nothing but render child components sequentially into the -Container. No sizing or positioning will be performed in this situation.
- Parameters:
-
-
|
- Component | -
- |
-
- resumeEvents() : void
-
- Resume firing events. (see suspendEvents)
-
- Resume firing events. (see suspendEvents)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- setDisabled( Boolean disabled ) : void
-
- Convenience function for setting disabled/enabled by boolean.
-
- Convenience function for setting disabled/enabled by boolean.
-
- Parameters:
-
-
|
- Component | -
- |
-
- setHeight( Number height ) : Ext.BoxComponent
- |
- BoxComponent | -
- |
-
- setPagePosition( Number x , Number y ) : Ext.BoxComponent
-
- Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ...
-
- Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- setPosition( Number left , Number top ) : Ext.BoxComponent
-
- Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ...
-
- Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- setSize( Number/Object width , Number height ) : Ext.BoxComponent
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width...
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- setTitle( String title , [String iconCls ] ) : void
-
- Sets the title text for the panel and optionally the icon class.
-In order to be able to set the title, a header eleme...
-
-
- Sets the title text for the panel and optionally the icon class. -In order to be able to set the title, a header element must have been created -for the Panel. This is triggered either by configuring the Panel with a non-blank title, -or configuring it with header: true.
- Parameters:
-
-
|
- Panel | -
- |
-
- setVisible( Boolean visible ) : Ext.Component
-
- Convenience 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.BoxComponent
- |
- BoxComponent | -
- |
-
- show() : Ext.Component
-
- Show this component.
-
- Show this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- suspendEvents() : void
-
- Suspend 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 | -
- |
-
- toggleCollapse( Boolean animate ) : Ext.Panel
-
-
-
- Shortcut for performing an expand or collapse based on the current state of the panel.
-
- Parameters:
-
-
|
- Panel | -
- |
-
- un( String eventName , Function handler , [Object scope ] ) : void
-
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- updateBox( Object box ) : Ext.BoxComponent
-
- Sets 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 )
-
- Fires after any Ext.Component is added or inserted into the container.
-
- Fires after any Ext.Component is added or inserted into the container.
-
- Listeners will be called with the following arguments:
-
-
|
- Container | -
- |
-
- 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 | -
- |
-
- beforeadd : ( Ext.Container this , Ext.Component component , Number index )
-
- Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add.
-
- Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add.
-
- Listeners will be called with the following arguments:
-
-
|
- Container | -
- |
-
- beforecollapse : ( Ext.Panel p , Boolean animate )
-
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
-
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -
- |
-
- beforedestroy : ( Ext.Component this )
-
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforeexpand : ( Ext.Panel p , Boolean animate )
-
- Fires before the Panel is expanded. A handler can return false to cancel the expand.
-
- Fires before the Panel is expanded. A handler can return false to cancel the expand.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -
- |
-
- beforehide : ( Ext.Component this )
-
- Fires before the component is hidden. Return false to stop the hide.
-
- Fires before the component is hidden. Return false to stop the hide.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforeremove : ( Ext.Container this , Ext.Component component )
-
- Fires before any Ext.Component is removed from the container. A handler can return
-false to cancel the remove.
-
- Fires before any Ext.Component is removed from the container. A handler can return
-false to cancel the remove.
-
- Listeners will be called with the following arguments:
-
-
|
- Container | -
- |
-
- beforerender : ( Ext.Component this )
-
- Fires before the component is rendered. Return false to stop the render.
-
- Fires before the component is rendered. Return false to stop the render.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforeshow : ( Ext.Component this )
-
- Fires before the component is shown. Return false to stop the show.
-
- Fires before the component is shown. Return false to stop the show.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforestaterestore : ( Ext.Component this , Object state )
-
- Fires before the state of the component is restored. Return false to stop the restore.
-
- Fires before the state of the component is restored. Return false to stop the restore.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforestatesave : ( Ext.Component this , Object state )
-
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
-
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- collapse : ( Ext.Panel p )
-
- Fires after the Panel has been collapsed.
-
- Fires after the Panel has been collapsed.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -
- |
-
- destroy : ( Ext.Component this )
-
- Fires after the component is destroyed.
-
- Fires after the component is destroyed.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- disable : ( Ext.Component this )
-
- Fires after the component is disabled.
-
- Fires after the component is disabled.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- enable : ( Ext.Component this )
-
- Fires after the component is enabled.
-
- Fires after the component is enabled.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- expand : ( Ext.Panel p )
-
- Fires after the Panel has been expanded.
-
- Fires after the Panel has been expanded.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -
- |
-
- hide : ( Ext.Component this )
-
- Fires after the component is hidden.
-
- Fires after the component is hidden.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- iconchange : ( Ext.Panel p , String The , String The )
-
- Fires after the Panel icon class has been set or changed.
-
- Fires after the Panel icon class has been set or changed.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -
- |
-
- move : ( Ext.Component this , Number x , Number y )
-
- 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 )
-
- Fires after any Ext.Component is removed from the container.
-
- Fires after any Ext.Component is removed from the container.
-
- Listeners will be called with the following arguments:
-
-
|
- Container | -
- |
-
- render : ( Ext.Component this )
-
- Fires after the component is rendered.
-
- Fires after the component is rendered.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
-
- Fires after the component is resized.
-
- Fires after the component is resized.
-
- Listeners will be called with the following arguments:
-
-
|
- BoxComponent | -
- |
-
- show : ( Ext.Component this )
-
- Fires after the component is shown.
-
- Fires after the component is shown.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- staterestore : ( Ext.Component this , Object state )
-
- Fires after the state of the component is restored.
-
- Fires after the state of the component is restored.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- statesave : ( Ext.Component this , Object state )
-
- Fires after the state of the component is saved to the configured state provider.
-
- Fires after the state of the component is saved to the configured state provider.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- titlechange : ( Ext.Panel p , String The )
-
- Fires after the Panel title has been set or changed.
-
- Fires after the Panel title has been set or changed.
-
- Listeners will be called with the following arguments:
-
-
|
- Panel | -