docs/api/Ext.ComponentQuery.html

   1 <!DOCTYPE html><html><head><title>Ext.ComponentQuery | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.ComponentQuery',
  13         docClass: 'Ext.ComponentQuery',
  14         docReq: 'Ext.ComponentQuery',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'ComponentQuery.html#Ext-ComponentQuery';
  33     clsInfo = {"methods":["query"],"cfgs":[],"properties":[],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/ComponentQuery.html#Ext-ComponentQuery" target="_blank">Ext.ComponentQuery</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>Provides searching of Components within <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a> (globally) or a specific
  38 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> on the document with a similar syntax to a CSS selector.</p>
  39
  40 <p>Components can be retrieved by using their <a href="Ext.Component.html" rel="Ext.Component" class="docClass">xtype</a> with an optional . prefix</p>
  41
  42 <ul>
  43     <li>component or .component</li>
  44     <li>gridpanel or .gridpanel</li>
  45 </ul>
  46
  47
  48 <p>An itemId or id must be prefixed with a #</p>
  49
  50 <ul>
  51     <li>#myContainer</li>
  52 </ul>
  53
  54
  55 <p>Attributes must be wrapped in brackets</p>
  56
  57 <ul>
  58     <li>component[autoScroll]</li>
  59     <li>panel[title="Test"]</li>
  60 </ul>
  61
  62
  63 <p>Member expressions from candidate Components may be tested. If the expression returns a <i>truthy</i> value,
  64 the candidate Component will be included in the query:</p>
  65
  66 <pre class="prettyprint"><code>var disabledFields = myFormPanel.query("{isDisabled()}");
  67 </code></pre>
  68
  69
  70 <p>Pseudo classes may be used to filter results in the same way as in <a href="Ext.DomQuery.html" rel="Ext.DomQuery" class="docClass">DomQuery</a>:<code></p>
  71
  72 <pre class="prettyprint">// Function receives array and returns a filtered array.
  73 Ext.ComponentQuery.pseudos.invalid = function(items) {
  74     var i = 0, l = items.length, c, result = [];
  75     for (; i < l; i++) {
  76         if (!(c = items[i]).isValid()) {
  77             result.push(c);
  78         }
  79     }
  80     return result;
  81 };
  82
  83 var invalidFields = myFormPanel.query('field:invalid');
  84 if (invalidFields.length) {
  85     invalidFields[0].getEl().scrollIntoView(myFormPanel.body);
  86     for (var i = 0, l = invalidFields.length; i < l; i++) {
  87         invalidFields[i].getEl().frame("red");
  88     }
  89 }
  90 </pre>
  91
  92
  93 <p></code></p>
  94
  95 <p>
  96 Default pseudos include:<br />
  97 - not
  98 </p>
  99
 100
 101 <p>Queries return an array of components.
 102 Here are some example queries.</p>
 103
 104 <pre class="prettyprint"><code>    // retrieve all Ext.Panels in the document by xtype
 105     var panelsArray = Ext.ComponentQuery.query('panel');
 106
 107     // retrieve all Ext.Panels within the container with an id myCt
 108     var panelsWithinmyCt = Ext.ComponentQuery.query('#myCt panel');
 109
 110     // retrieve all direct children which are Ext.Panels within myCt
 111     var directChildPanel = Ext.ComponentQuery.query('#myCt > panel');
 112
 113     // retrieve all gridpanels and listviews
 114     var gridsAndLists = Ext.ComponentQuery.query('gridpanel, listview');
 115 </code></pre>
 116
 117
 118 <p>For easy access to queries based from a particular Container see the <a href="Ext.container.Container.html#query" rel="Ext.container.Container#query" class="docClass">Ext.container.Container.query</a>,
 119 <a href="Ext.container.Container.html#down" rel="Ext.container.Container#down" class="docClass">Ext.container.Container.down</a> and <a href="Ext.container.Container.html#child" rel="Ext.container.Container#child" class="docClass">Ext.container.Container.child</a> methods. Also see
 120 <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">Ext.Component.up</a>.</p>
 121 <div class="members"><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-query" class="member f ni"><a href="Ext.ComponentQuery.html#method-query" rel="method-query" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.ComponentQuery.html" class="definedIn docClass">Ext.ComponentQuery</a><br/><a href="../source/ComponentQuery.html#Ext-ComponentQuery-method-query" class="viewSource">view source</a></div><a name="query"></a><a name="method-query"></a><a href="Ext.ComponentQuery.html#" rel="method-query" class="cls expand">query</a>(
 122 <span class="pre">Object component, Object selector</span>)
 123  : Boolean</div><div class="description"><div class="short"><p>Tests whether the passed Component matches the selector string.</p>
 124 </div><div class="long"><p>Tests whether the passed Component matches the selector string.</p>
 125 <h3 class="pa">Parameters</h3><ul><li><span class="pre">component</span> : Object<div class="sub-desc"><p>The Component to test</p>
 126 </div></li><li><span class="pre">selector</span> : Object<div class="sub-desc"><p>The selector string to test against.</p>
 127 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the Component matches the selector.</p>
 128 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>