BoxComponent.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:20k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.0.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.BoxComponent
  9.  * @extends Ext.Component
  10.  * <p>Base class for any {@link Ext.Component Component} that is to be sized as a box, using width and height.</p>
  11.  * <p>BoxComponent provides automatic box model adjustments for sizing and positioning and will work correctly
  12.  * within the Component rendering model.</p>
  13.  * <p>A BoxComponent may be created as a custom Component which encapsulates any HTML element, either a pre-existing
  14.  * element, or one that is created to your specifications at render time. Usually, to participate in layouts,
  15.  * a Component will need to be a <b>Box</b>Component in order to have its width and height managed.</p>
  16.  * <p>To use a pre-existing element as a BoxComponent, configure it so that you preset the <b>el</b> property to the
  17.  * element to reference:<pre><code>
  18. var pageHeader = new Ext.BoxComponent({
  19.     el: 'my-header-div'
  20. });</code></pre>
  21.  * This may then be {@link Ext.Container#add added} to a {@link Ext.Container Container} as a child item.</p>
  22.  * <p>To create a BoxComponent based around a HTML element to be created at render time, use the
  23.  * {@link Ext.Component#autoEl autoEl} config option which takes the form of a
  24.  * {@link Ext.DomHelper DomHelper} specification:<pre><code>
  25. var myImage = new Ext.BoxComponent({
  26.     autoEl: {
  27.         tag: 'img',
  28.         src: '/images/my-image.jpg'
  29.     }
  30. });</code></pre></p>
  31.  * @constructor
  32.  * @param {Ext.Element/String/Object} config The configuration options.
  33.  * @xtype box
  34.  */
  35. Ext.BoxComponent = Ext.extend(Ext.Component, {
  36.     // Configs below are used for all Components when rendered by BorderLayout.
  37.     /**
  38.      * @cfg {String} region <p><b>Note</b>: this config is only used when this BoxComponent is rendered
  39.      * by a Container which has been configured to use the <b>{@link Ext.layout.BorderLayout BorderLayout}</b>
  40.      * layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
  41.      * <p>See {@link Ext.layout.BorderLayout} also.</p>
  42.      */
  43.     // margins config is used when a BoxComponent is rendered by BorderLayout or BoxLayout.
  44.     /**
  45.      * @cfg {Object} margins <p><b>Note</b>: this config is only used when this BoxComponent is rendered
  46.      * by a Container which has been configured to use the <b>{@link Ext.layout.BorderLayout BorderLayout}</b>
  47.      * or one of the two <b>{@link Ext.layout.BoxLayout BoxLayout} subclasses.</b></p>
  48.      * <p>An object containing margins to apply to this BoxComponent in the
  49.      * format:</p><pre><code>
  50. {
  51.     top: (top margin),
  52.     right: (right margin),
  53.     bottom: (bottom margin),
  54.     left: (left margin)
  55. }</code></pre>
  56.      * <p>May also be a string containing space-separated, numeric margin values. The order of the
  57.      * sides associated with each value matches the way CSS processes margin values:</p>
  58.      * <p><div class="mdetail-params"><ul>
  59.      * <li>If there is only one value, it applies to all sides.</li>
  60.      * <li>If there are two values, the top and bottom borders are set to the first value and the
  61.      * right and left are set to the second.</li>
  62.      * <li>If there are three values, the top is set to the first value, the left and right are set
  63.      * to the second, and the bottom is set to the third.</li>
  64.      * <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
  65.      * </ul></div></p>
  66.      * <p>Defaults to:</p><pre><code>
  67.      * {top:0, right:0, bottom:0, left:0}
  68.      * </code></pre>
  69.      */
  70.     /**
  71.      * @cfg {Number} x
  72.      * The local x (left) coordinate for this component if contained within a positioning container.
  73.      */
  74.     /**
  75.      * @cfg {Number} y
  76.      * The local y (top) coordinate for this component if contained within a positioning container.
  77.      */
  78.     /**
  79.      * @cfg {Number} pageX
  80.      * The page level x coordinate for this component if contained within a positioning container.
  81.      */
  82.     /**
  83.      * @cfg {Number} pageY
  84.      * The page level y coordinate for this component if contained within a positioning container.
  85.      */
  86.     /**
  87.      * @cfg {Number} height
  88.      * The height of this component in pixels (defaults to auto).
  89.      * <b>Note</b> to express this dimension as a percentage or offset see {@link Ext.Component#anchor}.
  90.      */
  91.     /**
  92.      * @cfg {Number} width
  93.      * The width of this component in pixels (defaults to auto).
  94.      * <b>Note</b> to express this dimension as a percentage or offset see {@link Ext.Component#anchor}.
  95.      */
  96.     /**
  97.      * @cfg {Boolean} autoHeight
  98.      * <p>True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
  99.      * Container's {@link Ext.Container#layout layout manager}. Defaults to false.</p>
  100.      * <p><b>Note</b>: Although many components inherit this config option, not all will
  101.      * function as expected with a height of 'auto'. Setting autoHeight:true means that the
  102.      * browser will manage height based on the element's contents, and that Ext will not manage it at all.</p>
  103.      * <p>If the <i>browser</i> is managing the height, be aware that resizes performed by the browser in response
  104.      * to changes within the structure of the Component cannot be detected. Therefore changes to the height might
  105.      * result in elements needing to be synchronized with the new height. Example:</p><pre><code>
  106. var w = new Ext.Window({
  107.     title: 'Window',
  108.     width: 600,
  109.     autoHeight: true,
  110.     items: {
  111.         title: 'Collapse Me',
  112.         height: 400,
  113.         collapsible: true,
  114.         border: false,
  115.         listeners: {
  116.             beforecollapse: function() {
  117.                 w.el.shadow.hide();
  118.             },
  119.             beforeexpand: function() {
  120.                 w.el.shadow.hide();
  121.             },
  122.             collapse: function() {
  123.                 w.syncShadow();
  124.             },
  125.             expand: function() {
  126.                 w.syncShadow();
  127.             }
  128.         }
  129.     }
  130. }).show();
  131. </code></pre>
  132.      */
  133.     /**
  134.      * @cfg {Boolean} autoWidth
  135.      * <p>True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
  136.      * Container's {@link Ext.Container#layout layout manager}. Defaults to false.</p>
  137.      * <p><b>Note</b>: Although many components  inherit this config option, not all will
  138.      * function as expected with a width of 'auto'. Setting autoWidth:true means that the
  139.      * browser will manage width based on the element's contents, and that Ext will not manage it at all.</p>
  140.      * <p>If the <i>browser</i> is managing the width, be aware that resizes performed by the browser in response
  141.      * to changes within the structure of the Component cannot be detected. Therefore changes to the width might
  142.      * result in elements needing to be synchronized with the new width. For example, where the target element is:</p><pre><code>
  143. &lt;div id='grid-container' style='margin-left:25%;width:50%'>&lt;/div>
  144. </code></pre>
  145.      * A Panel rendered into that target element must listen for browser window resize in order to relay its
  146.       * child items when the browser changes its width:<pre><code>
  147. var myPanel = new Ext.Panel({
  148.     renderTo: 'grid-container',
  149.     monitorResize: true, // relay on browser resize
  150.     title: 'Panel',
  151.     height: 400,
  152.     autoWidth: true,
  153.     layout: 'hbox',
  154.     layoutConfig: {
  155.         align: 'stretch'
  156.     },
  157.     defaults: {
  158.         flex: 1
  159.     },
  160.     items: [{
  161.         title: 'Box 1',
  162.     }, {
  163.         title: 'Box 2'
  164.     }, {
  165.         title: 'Box 3'
  166.     }],
  167. });
  168. </code></pre>
  169.      */
  170.     /* // private internal config
  171.      * {Boolean} deferHeight
  172.      * True to defer height calculations to an external component, false to allow this component to set its own
  173.      * height (defaults to false).
  174.      */
  175.     // private
  176.     initComponent : function(){
  177.         Ext.BoxComponent.superclass.initComponent.call(this);
  178.         this.addEvents(
  179.             /**
  180.              * @event resize
  181.              * Fires after the component is resized.
  182.              * @param {Ext.Component} this
  183.              * @param {Number} adjWidth The box-adjusted width that was set
  184.              * @param {Number} adjHeight The box-adjusted height that was set
  185.              * @param {Number} rawWidth The width that was originally specified
  186.              * @param {Number} rawHeight The height that was originally specified
  187.              */
  188.             'resize',
  189.             /**
  190.              * @event move
  191.              * Fires after the component is moved.
  192.              * @param {Ext.Component} this
  193.              * @param {Number} x The new x position
  194.              * @param {Number} y The new y position
  195.              */
  196.             'move'
  197.         );
  198.     },
  199.     // private, set in afterRender to signify that the component has been rendered
  200.     boxReady : false,
  201.     // private, used to defer height settings to subclasses
  202.     deferHeight: false,
  203.     /**
  204.      * Sets the width and height of this BoxComponent. This method fires the {@link #resize} event. This method can accept
  205.      * either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.
  206.      * @param {Mixed} width The new width to set. This may be one of:<div class="mdetail-params"><ul>
  207.      * <li>A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
  208.      * <li>A String used to set the CSS width style.</li>
  209.      * <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
  210.      * <li><code>undefined</code> to leave the width unchanged.</li>
  211.      * </ul></div>
  212.      * @param {Mixed} height The new height to set (not required if a size object is passed as the first arg).
  213.      * This may be one of:<div class="mdetail-params"><ul>
  214.      * <li>A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
  215.      * <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
  216.      * <li><code>undefined</code> to leave the height unchanged.</li>
  217.      * </ul></div>
  218.      * @return {Ext.BoxComponent} this
  219.      */
  220.     setSize : function(w, h){
  221.         // support for standard size objects
  222.         if(typeof w == 'object'){
  223.             h = w.height;
  224.             w = w.width;
  225.         }
  226.         // not rendered
  227.         if(!this.boxReady){
  228.             this.width = w;
  229.             this.height = h;
  230.             return this;
  231.         }
  232.         // prevent recalcs when not needed
  233.         if(this.cacheSizes !== false && this.lastSize && this.lastSize.width == w && this.lastSize.height == h){
  234.             return this;
  235.         }
  236.         this.lastSize = {width: w, height: h};
  237.         var adj = this.adjustSize(w, h);
  238.         var aw = adj.width, ah = adj.height;
  239.         if(aw !== undefined || ah !== undefined){ // this code is nasty but performs better with floaters
  240.             var rz = this.getResizeEl();
  241.             if(!this.deferHeight && aw !== undefined && ah !== undefined){
  242.                 rz.setSize(aw, ah);
  243.             }else if(!this.deferHeight && ah !== undefined){
  244.                 rz.setHeight(ah);
  245.             }else if(aw !== undefined){
  246.                 rz.setWidth(aw);
  247.             }
  248.             this.onResize(aw, ah, w, h);
  249.             this.fireEvent('resize', this, aw, ah, w, h);
  250.         }
  251.         return this;
  252.     },
  253.     /**
  254.      * Sets the width of the component.  This method fires the {@link #resize} event.
  255.      * @param {Number} width The new width to setThis may be one of:<div class="mdetail-params"><ul>
  256.      * <li>A Number specifying the new width in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
  257.      * <li>A String used to set the CSS width style.</li>
  258.      * </ul></div>
  259.      * @return {Ext.BoxComponent} this
  260.      */
  261.     setWidth : function(width){
  262.         return this.setSize(width);
  263.     },
  264.     /**
  265.      * Sets the height of the component.  This method fires the {@link #resize} event.
  266.      * @param {Number} height The new height to set. This may be one of:<div class="mdetail-params"><ul>
  267.      * <li>A Number specifying the new height in the {@link #getEl Element}'s {@link Ext.Element#defaultUnit}s (by default, pixels).</li>
  268.      * <li>A String used to set the CSS height style.</li>
  269.      * <li><i>undefined</i> to leave the height unchanged.</li>
  270.      * </ul></div>
  271.      * @return {Ext.BoxComponent} this
  272.      */
  273.     setHeight : function(height){
  274.         return this.setSize(undefined, height);
  275.     },
  276.     /**
  277.      * Gets the current size of the component's underlying element.
  278.      * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
  279.      */
  280.     getSize : function(){
  281.         return this.getResizeEl().getSize();
  282.     },
  283.     /**
  284.      * Gets the current width of the component's underlying element.
  285.      * @return {Number}
  286.      */
  287.     getWidth : function(){
  288.         return this.getResizeEl().getWidth();
  289.     },
  290.     /**
  291.      * Gets the current height of the component's underlying element.
  292.      * @return {Number}
  293.      */
  294.     getHeight : function(){
  295.         return this.getResizeEl().getHeight();
  296.     },
  297.     /**
  298.      * Gets the current size of the component's underlying element, including space taken by its margins.
  299.      * @return {Object} An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
  300.      */
  301.     getOuterSize : function(){
  302.         var el = this.getResizeEl();
  303.         return {width: el.getWidth() + el.getMargins('lr'),
  304.                 height: el.getHeight() + el.getMargins('tb')};
  305.     },
  306.     /**
  307.      * Gets the current XY position of the component's underlying element.
  308.      * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false)
  309.      * @return {Array} The XY position of the element (e.g., [100, 200])
  310.      */
  311.     getPosition : function(local){
  312.         var el = this.getPositionEl();
  313.         if(local === true){
  314.             return [el.getLeft(true), el.getTop(true)];
  315.         }
  316.         return this.xy || el.getXY();
  317.     },
  318.     /**
  319.      * Gets the current box measurements of the component's underlying element.
  320.      * @param {Boolean} local (optional) If true the element's left and top are returned instead of page XY (defaults to false)
  321.      * @return {Object} box An object in the format {x, y, width, height}
  322.      */
  323.     getBox : function(local){
  324.         var pos = this.getPosition(local);
  325.         var s = this.getSize();
  326.         s.x = pos[0];
  327.         s.y = pos[1];
  328.         return s;
  329.     },
  330.     /**
  331.      * Sets the current box measurements of the component's underlying element.
  332.      * @param {Object} box An object in the format {x, y, width, height}
  333.      * @return {Ext.BoxComponent} this
  334.      */
  335.     updateBox : function(box){
  336.         this.setSize(box.width, box.height);
  337.         this.setPagePosition(box.x, box.y);
  338.         return this;
  339.     },
  340.     /**
  341.      * <p>Returns the outermost Element of this Component which defines the Components overall size.</p>
  342.      * <p><i>Usually</i> this will return the same Element as <code>{@link #getEl}</code>,
  343.      * but in some cases, a Component may have some more wrapping Elements around its main
  344.      * active Element.</p>
  345.      * <p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
  346.      * contains both the <code>&lt;input></code> Element (which is what would be returned
  347.      * by its <code>{@link #getEl}</code> method, <i>and</i> the trigger button Element.
  348.      * This Element is returned as the <code>resizeEl</code>.
  349.      */
  350.     getResizeEl : function(){
  351.         return this.resizeEl || this.el;
  352.     },
  353.     // protected
  354.     getPositionEl : function(){
  355.         return this.positionEl || this.el;
  356.     },
  357.     /**
  358.      * Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.
  359.      * This method fires the {@link #move} event.
  360.      * @param {Number} left The new left
  361.      * @param {Number} top The new top
  362.      * @return {Ext.BoxComponent} this
  363.      */
  364.     setPosition : function(x, y){
  365.         if(x && typeof x[1] == 'number'){
  366.             y = x[1];
  367.             x = x[0];
  368.         }
  369.         this.x = x;
  370.         this.y = y;
  371.         if(!this.boxReady){
  372.             return this;
  373.         }
  374.         var adj = this.adjustPosition(x, y);
  375.         var ax = adj.x, ay = adj.y;
  376.         var el = this.getPositionEl();
  377.         if(ax !== undefined || ay !== undefined){
  378.             if(ax !== undefined && ay !== undefined){
  379.                 el.setLeftTop(ax, ay);
  380.             }else if(ax !== undefined){
  381.                 el.setLeft(ax);
  382.             }else if(ay !== undefined){
  383.                 el.setTop(ay);
  384.             }
  385.             this.onPosition(ax, ay);
  386.             this.fireEvent('move', this, ax, ay);
  387.         }
  388.         return this;
  389.     },
  390.     /**
  391.      * Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.
  392.      * This method fires the {@link #move} event.
  393.      * @param {Number} x The new x position
  394.      * @param {Number} y The new y position
  395.      * @return {Ext.BoxComponent} this
  396.      */
  397.     setPagePosition : function(x, y){
  398.         if(x && typeof x[1] == 'number'){
  399.             y = x[1];
  400.             x = x[0];
  401.         }
  402.         this.pageX = x;
  403.         this.pageY = y;
  404.         if(!this.boxReady){
  405.             return;
  406.         }
  407.         if(x === undefined || y === undefined){ // cannot translate undefined points
  408.             return;
  409.         }
  410.         var p = this.getPositionEl().translatePoints(x, y);
  411.         this.setPosition(p.left, p.top);
  412.         return this;
  413.     },
  414.     // private
  415.     onRender : function(ct, position){
  416.         Ext.BoxComponent.superclass.onRender.call(this, ct, position);
  417.         if(this.resizeEl){
  418.             this.resizeEl = Ext.get(this.resizeEl);
  419.         }
  420.         if(this.positionEl){
  421.             this.positionEl = Ext.get(this.positionEl);
  422.         }
  423.     },
  424.     // private
  425.     afterRender : function(){
  426.         Ext.BoxComponent.superclass.afterRender.call(this);
  427.         this.boxReady = true;
  428.         this.setSize(this.width, this.height);
  429.         if(this.x || this.y){
  430.             this.setPosition(this.x, this.y);
  431.         }else if(this.pageX || this.pageY){
  432.             this.setPagePosition(this.pageX, this.pageY);
  433.         }
  434.     },
  435.     /**
  436.      * Force the component's size to recalculate based on the underlying element's current height and width.
  437.      * @return {Ext.BoxComponent} this
  438.      */
  439.     syncSize : function(){
  440.         delete this.lastSize;
  441.         this.setSize(this.autoWidth ? undefined : this.getResizeEl().getWidth(), this.autoHeight ? undefined : this.getResizeEl().getHeight());
  442.         return this;
  443.     },
  444.     /* // protected
  445.      * Called after the component is resized, this method is empty by default but can be implemented by any
  446.      * subclass that needs to perform custom logic after a resize occurs.
  447.      * @param {Number} adjWidth The box-adjusted width that was set
  448.      * @param {Number} adjHeight The box-adjusted height that was set
  449.      * @param {Number} rawWidth The width that was originally specified
  450.      * @param {Number} rawHeight The height that was originally specified
  451.      */
  452.     onResize : function(adjWidth, adjHeight, rawWidth, rawHeight){
  453.     },
  454.     /* // protected
  455.      * Called after the component is moved, this method is empty by default but can be implemented by any
  456.      * subclass that needs to perform custom logic after a move occurs.
  457.      * @param {Number} x The new x position
  458.      * @param {Number} y The new y position
  459.      */
  460.     onPosition : function(x, y){
  461.     },
  462.     // private
  463.     adjustSize : function(w, h){
  464.         if(this.autoWidth){
  465.             w = 'auto';
  466.         }
  467.         if(this.autoHeight){
  468.             h = 'auto';
  469.         }
  470.         return {width : w, height: h};
  471.     },
  472.     // private
  473.     adjustPosition : function(x, y){
  474.         return {x : x, y: y};
  475.     }
  476. });
  477. Ext.reg('box', Ext.BoxComponent);
  478. /**
  479.  * @class Ext.Spacer
  480.  * @extends Ext.BoxComponent
  481.  * <p>Used to provide a sizable space in a layout.</p>
  482.  * @constructor
  483.  * @param {Object} config
  484.  */
  485. Ext.Spacer = Ext.extend(Ext.BoxComponent, {
  486.     autoEl:'div'
  487. });
  488. Ext.reg('spacer', Ext.Spacer);