docs/source/Anchor.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-layout.container.Anchor'>/**
   2 </span> * @class Ext.layout.container.Anchor
   3  * @extends Ext.layout.container.Container
   4  *
   5  * This is a layout that enables anchoring of contained elements relative to the container's dimensions.
   6  * If the container is resized, all anchored items are automatically rerendered according to their
   7  * &lt;b&gt;&lt;tt&gt;{@link #anchor}&lt;/tt&gt;&lt;/b&gt; rules.
   8  *
   9  * This class is intended to be extended or created via the layout: 'anchor' {@link Ext.layout.container.AbstractContainer#layout}
  10  * config, and should generally not need to be created directly via the new keyword.&lt;/p&gt;
  11  *
  12  * AnchorLayout does not have any direct config options (other than inherited ones). By default,
  13  * AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the
  14  * container using the AnchorLayout can supply an anchoring-specific config property of &lt;b&gt;anchorSize&lt;/b&gt;.
  15  * If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating
  16  * anchor measurements based on it instead, allowing the container to be sized independently of the anchoring
  17  * logic if necessary.
  18  *
  19  * {@img Ext.layout.container.Anchor/Ext.layout.container.Anchor.png Ext.layout.container.Anchor container layout}
  20  *
  21  * For example:
  22  *     Ext.create('Ext.Panel', {
  23  *         width: 500,
  24  *         height: 400,
  25  *         title: &quot;AnchorLayout Panel&quot;,
  26  *         layout: 'anchor',
  27  *         renderTo: Ext.getBody(),
  28  *         items: [{
  29  *             xtype: 'panel',
  30  *             title: '75% Width and 20% Height',
  31  *             anchor: '75% 20%'
  32  *         },{
  33  *             xtype: 'panel',
  34  *             title: 'Offset -300 Width &amp; -200 Height',
  35  *             anchor: '-300 -200'
  36  *         },{
  37  *             xtype: 'panel',
  38  *             title: 'Mixed Offset and Percent',
  39  *             anchor: '-250 20%'
  40  *         }]
  41  *     });
  42  */
  43
  44 Ext.define('Ext.layout.container.Anchor', {
  45
  46     /* Begin Definitions */
  47
  48     alias: 'layout.anchor',
  49     extend: 'Ext.layout.container.Container',
  50     alternateClassName: 'Ext.layout.AnchorLayout',
  51
  52     /* End Definitions */
  53
  54 <span id='Ext-layout.container.Anchor-cfg-anchor'>    /**
  55 </span>     * @cfg {String} anchor
  56      * &lt;p&gt;This configuation option is to be applied to &lt;b&gt;child &lt;tt&gt;items&lt;/tt&gt;&lt;/b&gt; of a container managed by
  57      * this layout (ie. configured with &lt;tt&gt;layout:'anchor'&lt;/tt&gt;).&lt;/p&gt;&lt;br/&gt;
  58      *
  59      * &lt;p&gt;This value is what tells the layout how an item should be anchored to the container. &lt;tt&gt;items&lt;/tt&gt;
  60      * added to an AnchorLayout accept an anchoring-specific config property of &lt;b&gt;anchor&lt;/b&gt; which is a string
  61      * containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%').
  62      * The following types of anchor values are supported:&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
  63      *
  64      * &lt;li&gt;&lt;b&gt;Percentage&lt;/b&gt; : Any value between 1 and 100, expressed as a percentage.&lt;div class=&quot;sub-desc&quot;&gt;
  65      * The first anchor is the percentage width that the item should take up within the container, and the
  66      * second is the percentage height.  For example:&lt;pre&gt;&lt;code&gt;
  67 // two values specified
  68 anchor: '100% 50%' // render item complete width of the container and
  69                    // 1/2 height of the container
  70 // one value specified
  71 anchor: '100%'     // the width value; the height will default to auto
  72      * &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;
  73      *
  74      * &lt;li&gt;&lt;b&gt;Offsets&lt;/b&gt; : Any positive or negative integer value.&lt;div class=&quot;sub-desc&quot;&gt;
  75      * This is a raw adjustment where the first anchor is the offset from the right edge of the container,
  76      * and the second is the offset from the bottom edge. For example:&lt;pre&gt;&lt;code&gt;
  77 // two values specified
  78 anchor: '-50 -100' // render item the complete width of the container
  79                    // minus 50 pixels and
  80                    // the complete height minus 100 pixels.
  81 // one value specified
  82 anchor: '-50'      // anchor value is assumed to be the right offset value
  83                    // bottom offset will default to 0
  84      * &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;
  85      *
  86      * &lt;li&gt;&lt;b&gt;Sides&lt;/b&gt; : Valid values are &lt;tt&gt;'right'&lt;/tt&gt; (or &lt;tt&gt;'r'&lt;/tt&gt;) and &lt;tt&gt;'bottom'&lt;/tt&gt;
  87      * (or &lt;tt&gt;'b'&lt;/tt&gt;).&lt;div class=&quot;sub-desc&quot;&gt;
  88      * Either the container must have a fixed size or an anchorSize config value defined at render time in
  89      * order for these to have any effect.&lt;/div&gt;&lt;/li&gt;
  90      *
  91      * &lt;li&gt;&lt;b&gt;Mixed&lt;/b&gt; : &lt;div class=&quot;sub-desc&quot;&gt;
  92      * Anchor values can also be mixed as needed.  For example, to render the width offset from the container
  93      * right edge by 50 pixels and 75% of the container's height use:
  94      * &lt;pre&gt;&lt;code&gt;
  95 anchor: '-50 75%'
  96      * &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;
  97      *
  98      *
  99      * &lt;/ul&gt;&lt;/div&gt;
 100      */
 101
 102     type: 'anchor',
 103
 104 <span id='Ext-layout.container.Anchor-cfg-defaultAnchor'>    /**
 105 </span>     * @cfg {String} defaultAnchor
 106      *
 107      * default anchor for all child container items applied if no anchor or specific width is set on the child item.  Defaults to '100%'.
 108      *
 109      */
 110     defaultAnchor: '100%',
 111
 112     parseAnchorRE: /^(r|right|b|bottom)$/i,
 113
 114     // private
 115     onLayout: function() {
 116         this.callParent(arguments);
 117
 118         var me = this,
 119             size = me.getLayoutTargetSize(),
 120             owner = me.owner,
 121             target = me.getTarget(),
 122             ownerWidth = size.width,
 123             ownerHeight = size.height,
 124             overflow = target.getStyle('overflow'),
 125             components = me.getVisibleItems(owner),
 126             len = components.length,
 127             boxes = [],
 128             box, newTargetSize, anchorWidth, anchorHeight, component, anchorSpec, calcWidth, calcHeight,
 129             anchorsArray, anchor, i, el;
 130
 131         if (ownerWidth &lt; 20 &amp;&amp; ownerHeight &lt; 20) {
 132             return;
 133         }
 134
 135         // Anchor layout uses natural HTML flow to arrange the child items.
 136         // To ensure that all browsers (I'm looking at you IE!) add the bottom margin of the last child to the
 137         // containing element height, we create a zero-sized element with style clear:both to force a &quot;new line&quot;
 138         if (!me.clearEl) {
 139             me.clearEl = target.createChild({
 140                 cls: Ext.baseCSSPrefix + 'clear',
 141                 role: 'presentation'
 142             });
 143         }
 144
 145         // find the container anchoring size
 146         if (owner.anchorSize) {
 147             if (typeof owner.anchorSize == 'number') {
 148                 anchorWidth = owner.anchorSize;
 149             }
 150             else {
 151                 anchorWidth = owner.anchorSize.width;
 152                 anchorHeight = owner.anchorSize.height;
 153             }
 154         }
 155         else {
 156             anchorWidth = owner.initialConfig.width;
 157             anchorHeight = owner.initialConfig.height;
 158         }
 159
 160         // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done
 161         if (!Ext.supports.RightMargin) {
 162             target.addCls(Ext.baseCSSPrefix + 'inline-children');
 163         }
 164
 165         for (i = 0; i &lt; len; i++) {
 166             component = components[i];
 167             el = component.el;
 168             anchor = component.anchor;
 169
 170             if (!component.anchor &amp;&amp; component.items &amp;&amp; !Ext.isNumber(component.width) &amp;&amp; !(Ext.isIE6 &amp;&amp; Ext.isStrict)) {
 171                 component.anchor = anchor = me.defaultAnchor;
 172             }
 173
 174             if (anchor) {
 175                 anchorSpec = component.anchorSpec;
 176                 // cache all anchor values
 177                 if (!anchorSpec) {
 178                     anchorsArray = anchor.split(' ');
 179                     component.anchorSpec = anchorSpec = {
 180                         right: me.parseAnchor(anchorsArray[0], component.initialConfig.width, anchorWidth),
 181                         bottom: me.parseAnchor(anchorsArray[1], component.initialConfig.height, anchorHeight)
 182                     };
 183                 }
 184                 calcWidth = anchorSpec.right ? me.adjustWidthAnchor(anchorSpec.right(ownerWidth) - el.getMargin('lr'), component) : undefined;
 185                 calcHeight = anchorSpec.bottom ? me.adjustHeightAnchor(anchorSpec.bottom(ownerHeight) - el.getMargin('tb'), component) : undefined;
 186
 187                 boxes.push({
 188                     component: component,
 189                     anchor: true,
 190                     width: calcWidth || undefined,
 191                     height: calcHeight || undefined
 192                 });
 193             } else {
 194                 boxes.push({
 195                     component: component,
 196                     anchor: false
 197                 });
 198             }
 199         }
 200
 201         // Work around WebKit RightMargin bug. We're going to inline-block all the children only ONCE and remove it when we're done
 202         if (!Ext.supports.RightMargin) {
 203             target.removeCls(Ext.baseCSSPrefix + 'inline-children');
 204         }
 205
 206         for (i = 0; i &lt; len; i++) {
 207             box = boxes[i];
 208             me.setItemSize(box.component, box.width, box.height);
 209         }
 210
 211         if (overflow &amp;&amp; overflow != 'hidden' &amp;&amp; !me.adjustmentPass) {
 212             newTargetSize = me.getLayoutTargetSize();
 213             if (newTargetSize.width != size.width || newTargetSize.height != size.height) {
 214                 me.adjustmentPass = true;
 215                 me.onLayout();
 216             }
 217         }
 218
 219         delete me.adjustmentPass;
 220     },
 221
 222     // private
 223     parseAnchor: function(a, start, cstart) {
 224         if (a &amp;&amp; a != 'none') {
 225             var ratio;
 226             // standard anchor
 227             if (this.parseAnchorRE.test(a)) {
 228                 var diff = cstart - start;
 229                 return function(v) {
 230                     return v - diff;
 231                 };
 232             }
 233             // percentage
 234             else if (a.indexOf('%') != -1) {
 235                 ratio = parseFloat(a.replace('%', '')) * 0.01;
 236                 return function(v) {
 237                     return Math.floor(v * ratio);
 238                 };
 239             }
 240             // simple offset adjustment
 241             else {
 242                 a = parseInt(a, 10);
 243                 if (!isNaN(a)) {
 244                     return function(v) {
 245                         return v + a;
 246                     };
 247                 }
 248             }
 249         }
 250         return null;
 251     },
 252
 253     // private
 254     adjustWidthAnchor: function(value, comp) {
 255         return value;
 256     },
 257
 258     // private
 259     adjustHeightAnchor: function(value, comp) {
 260         return value;
 261     }
 262
 263 });</pre></pre></body></html>