docs/source/AnchorLayout.html

   1 <html>
   2 <head>
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4   <title>The source code</title>
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   7 </head>
   8 <body  onload="prettyPrint();">
   9     <pre class="prettyprint lang-js">/*!
  10  * Ext JS Library 3.3.1
  11  * Copyright(c) 2006-2010 Sencha Inc.
  12  * licensing@sencha.com
  13  * http://www.sencha.com/license
  14  */
  15 <div id="cls-Ext.layout.AnchorLayout"></div>/**
  16  * @class Ext.layout.AnchorLayout
  17  * @extends Ext.layout.ContainerLayout
  18  * <p>This is a layout that enables anchoring of contained elements relative to the container's dimensions.
  19  * If the container is resized, all anchored items are automatically rerendered according to their
  20  * <b><tt>{@link #anchor}</tt></b> rules.</p>
  21  * <p>This class is intended to be extended or created via the layout:'anchor' {@link Ext.Container#layout}
  22  * config, and should generally not need to be created directly via the new keyword.</p>
  23  * <p>AnchorLayout does not have any direct config options (other than inherited ones). By default,
  24  * AnchorLayout will calculate anchor measurements based on the size of the container itself. However, the
  25  * container using the AnchorLayout can supply an anchoring-specific config property of <b>anchorSize</b>.
  26  * If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating
  27  * anchor measurements based on it instead, allowing the container to be sized independently of the anchoring
  28  * logic if necessary.  For example:</p>
  29  * <pre><code>
  30 var viewport = new Ext.Viewport({
  31     layout:'anchor',
  32     anchorSize: {width:800, height:600},
  33     items:[{
  34         title:'Item 1',
  35         html:'Content 1',
  36         width:800,
  37         anchor:'right 20%'
  38     },{
  39         title:'Item 2',
  40         html:'Content 2',
  41         width:300,
  42         anchor:'50% 30%'
  43     },{
  44         title:'Item 3',
  45         html:'Content 3',
  46         width:600,
  47         anchor:'-100 50%'
  48     }]
  49 });
  50  * </code></pre>
  51  */
  52 Ext.layout.AnchorLayout = Ext.extend(Ext.layout.ContainerLayout, {
  53     <div id="cfg-Ext.layout.AnchorLayout-anchor"></div>/**
  54      * @cfg {String} anchor
  55      * <p>This configuation option is to be applied to <b>child <tt>items</tt></b> of a container managed by
  56      * this layout (ie. configured with <tt>layout:'anchor'</tt>).</p><br/>
  57      *
  58      * <p>This value is what tells the layout how an item should be anchored to the container. <tt>items</tt>
  59      * added to an AnchorLayout accept an anchoring-specific config property of <b>anchor</b> which is a string
  60      * containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%').
  61      * The following types of anchor values are supported:<div class="mdetail-params"><ul>
  62      *
  63      * <li><b>Percentage</b> : Any value between 1 and 100, expressed as a percentage.<div class="sub-desc">
  64      * The first anchor is the percentage width that the item should take up within the container, and the
  65      * second is the percentage height.  For example:<pre><code>
  66 // two values specified
  67 anchor: '100% 50%' // render item complete width of the container and
  68                    // 1/2 height of the container
  69 // one value specified
  70 anchor: '100%'     // the width value; the height will default to auto
  71      * </code></pre></div></li>
  72      *
  73      * <li><b>Offsets</b> : Any positive or negative integer value.<div class="sub-desc">
  74      * This is a raw adjustment where the first anchor is the offset from the right edge of the container,
  75      * and the second is the offset from the bottom edge. For example:<pre><code>
  76 // two values specified
  77 anchor: '-50 -100' // render item the complete width of the container
  78                    // minus 50 pixels and
  79                    // the complete height minus 100 pixels.
  80 // one value specified
  81 anchor: '-50'      // anchor value is assumed to be the right offset value
  82                    // bottom offset will default to 0
  83      * </code></pre></div></li>
  84      *
  85      * <li><b>Sides</b> : Valid values are <tt>'right'</tt> (or <tt>'r'</tt>) and <tt>'bottom'</tt>
  86      * (or <tt>'b'</tt>).<div class="sub-desc">
  87      * Either the container must have a fixed size or an anchorSize config value defined at render time in
  88      * order for these to have any effect.</div></li>
  89      *
  90      * <li><b>Mixed</b> : <div class="sub-desc">
  91      * Anchor values can also be mixed as needed.  For example, to render the width offset from the container
  92      * right edge by 50 pixels and 75% of the container's height use:
  93      * <pre><code>
  94 anchor: '-50 75%'
  95      * </code></pre></div></li>
  96      *
  97      *
  98      * </ul></div>
  99      */
 100
 101     // private
 102     monitorResize : true,
 103
 104     type : 'anchor',
 105
 106     <div id="cfg-Ext.layout.AnchorLayout-defaultAnchor"></div>/**
 107      * @cfg {String} defaultAnchor
 108      *
 109      * default anchor for all child container items applied if no anchor or specific width is set on the child item.  Defaults to '100%'.
 110      *
 111      */
 112     defaultAnchor : '100%',
 113
 114     parseAnchorRE : /^(r|right|b|bottom)$/i,
 115
 116
 117     getLayoutTargetSize : function() {
 118         var target = this.container.getLayoutTarget(), ret = {};
 119         if (target) {
 120             ret = target.getViewSize();
 121
 122             // IE in strict mode will return a width of 0 on the 1st pass of getViewSize.
 123             // Use getStyleSize to verify the 0 width, the adjustment pass will then work properly
 124             // with getViewSize
 125             if (Ext.isIE && Ext.isStrict && ret.width == 0){
 126                 ret =  target.getStyleSize();
 127             }
 128             ret.width -= target.getPadding('lr');
 129             ret.height -= target.getPadding('tb');
 130         }
 131         return ret;
 132     },
 133
 134     // private
 135     onLayout : function(container, target) {
 136         Ext.layout.AnchorLayout.superclass.onLayout.call(this, container, target);
 137
 138         var size = this.getLayoutTargetSize(),
 139             containerWidth = size.width,
 140             containerHeight = size.height,
 141             overflow = target.getStyle('overflow'),
 142             components = this.getRenderedItems(container),
 143             len = components.length,
 144             boxes = [],
 145             box,
 146             anchorWidth,
 147             anchorHeight,
 148             component,
 149             anchorSpec,
 150             calcWidth,
 151             calcHeight,
 152             anchorsArray,
 153             totalHeight = 0,
 154             i,
 155             el;
 156
 157         if(containerWidth < 20 && containerHeight < 20){
 158             return;
 159         }
 160
 161         // find the container anchoring size
 162         if(container.anchorSize) {
 163             if(typeof container.anchorSize == 'number') {
 164                 anchorWidth = container.anchorSize;
 165             } else {
 166                 anchorWidth = container.anchorSize.width;
 167                 anchorHeight = container.anchorSize.height;
 168             }
 169         } else {
 170             anchorWidth = container.initialConfig.width;
 171             anchorHeight = container.initialConfig.height;
 172         }
 173
 174         for(i = 0; i < len; i++) {
 175             component = components[i];
 176             el = component.getPositionEl();
 177
 178             // If a child container item has no anchor and no specific width, set the child to the default anchor size
 179             if (!component.anchor && component.items && !Ext.isNumber(component.width) && !(Ext.isIE6 && Ext.isStrict)){
 180                 component.anchor = this.defaultAnchor;
 181             }
 182
 183             if(component.anchor) {
 184                 anchorSpec = component.anchorSpec;
 185                 // cache all anchor values
 186                 if(!anchorSpec){
 187                     anchorsArray = component.anchor.split(' ');
 188                     component.anchorSpec = anchorSpec = {
 189                         right: this.parseAnchor(anchorsArray[0], component.initialConfig.width, anchorWidth),
 190                         bottom: this.parseAnchor(anchorsArray[1], component.initialConfig.height, anchorHeight)
 191                     };
 192                 }
 193                 calcWidth = anchorSpec.right ? this.adjustWidthAnchor(anchorSpec.right(containerWidth) - el.getMargins('lr'), component) : undefined;
 194                 calcHeight = anchorSpec.bottom ? this.adjustHeightAnchor(anchorSpec.bottom(containerHeight) - el.getMargins('tb'), component) : undefined;
 195
 196                 if(calcWidth || calcHeight) {
 197                     boxes.push({
 198                         component: component,
 199                         width: calcWidth || undefined,
 200                         height: calcHeight || undefined
 201                     });
 202                 }
 203             }
 204         }
 205         for (i = 0, len = boxes.length; i < len; i++) {
 206             box = boxes[i];
 207             box.component.setSize(box.width, box.height);
 208         }
 209
 210         if (overflow && overflow != 'hidden' && !this.adjustmentPass) {
 211             var newTargetSize = this.getLayoutTargetSize();
 212             if (newTargetSize.width != size.width || newTargetSize.height != size.height){
 213                 this.adjustmentPass = true;
 214                 this.onLayout(container, target);
 215             }
 216         }
 217
 218         delete this.adjustmentPass;
 219     },
 220
 221     // private
 222     parseAnchor : function(a, start, cstart) {
 223         if (a && a != 'none') {
 224             var last;
 225             // standard anchor
 226             if (this.parseAnchorRE.test(a)) {
 227                 var diff = cstart - start;
 228                 return function(v){
 229                     if(v !== last){
 230                         last = v;
 231                         return v - diff;
 232                     }
 233                 };
 234             // percentage
 235             } else if(a.indexOf('%') != -1) {
 236                 var ratio = parseFloat(a.replace('%', ''))*.01;
 237                 return function(v){
 238                     if(v !== last){
 239                         last = v;
 240                         return Math.floor(v*ratio);
 241                     }
 242                 };
 243             // simple offset adjustment
 244             } else {
 245                 a = parseInt(a, 10);
 246                 if (!isNaN(a)) {
 247                     return function(v) {
 248                         if (v !== last) {
 249                             last = v;
 250                             return v + a;
 251                         }
 252                     };
 253                 }
 254             }
 255         }
 256         return false;
 257     },
 258
 259     // private
 260     adjustWidthAnchor : function(value, comp){
 261         return value;
 262     },
 263
 264     // private
 265     adjustHeightAnchor : function(value, comp){
 266         return value;
 267     }
 268
 269     <div id="prop-Ext.layout.AnchorLayout-activeItem"></div>/**
 270      * @property activeItem
 271      * @hide
 272      */
 273 });
 274 Ext.Container.LAYOUTS['anchor'] = Ext.layout.AnchorLayout;
 275 </pre>
 276 </body>
 277 </html>