/*
|
This file is part of Ext JS 4.2
|
|
Copyright (c) 2011-2013 Sencha Inc
|
|
Contact: http://www.sencha.com/contact
|
|
GNU General Public License Usage
|
This file may be used under the terms of the GNU General Public License version 3.0 as
|
published by the Free Software Foundation and appearing in the file LICENSE included in the
|
packaging of this file.
|
|
Please review the following information to ensure the GNU General Public License version 3.0
|
requirements will be met: http://www.gnu.org/copyleft/gpl.html.
|
|
If you are unsure which license is appropriate for your use, please contact the sales department
|
at http://www.sencha.com/contact.
|
|
Build date: 2013-05-16 14:36:50 (f9be68accb407158ba2b1be2c226a6ce1f649314)
|
*/
|
/**
|
* A specialized container representing the viewable application area (the browser viewport).
|
*
|
* The Viewport renders itself to the document body, and automatically sizes itself to the size of
|
* the browser viewport and manages window resizing. There may only be one Viewport created
|
* in a page.
|
*
|
* Like any {@link Ext.container.Container Container}, a Viewport will only perform sizing and positioning
|
* on its child Components if you configure it with a {@link #layout}.
|
*
|
* A Common layout used with Viewports is {@link Ext.layout.container.Border border layout}, but if the
|
* required layout is simpler, a different layout should be chosen.
|
*
|
* For example, to simply make a single child item occupy all available space, use
|
* {@link Ext.layout.container.Fit fit layout}.
|
*
|
* To display one "active" item at full size from a choice of several child items, use
|
* {@link Ext.layout.container.Card card layout}.
|
*
|
* Inner layouts are available because all {@link Ext.panel.Panel Panel}s
|
* added to the Viewport, either through its {@link #cfg-items}, or the {@link #method-add}
|
* method of any of its child Panels may themselves have a layout.
|
*
|
* The Viewport does not provide scrolling, so child Panels within the Viewport should provide
|
* for scrolling if needed using the {@link #autoScroll} config.
|
*
|
* An example showing a classic application border layout:
|
*
|
* @example
|
* Ext.create('Ext.container.Viewport', {
|
* layout: 'border',
|
* items: [{
|
* region: 'north',
|
* html: '<h1 class="x-panel-header">Page Title</h1>',
|
* border: false,
|
* margins: '0 0 5 0'
|
* }, {
|
* region: 'west',
|
* collapsible: true,
|
* title: 'Navigation',
|
* width: 150
|
* // could use a TreePanel or AccordionLayout for navigational items
|
* }, {
|
* region: 'south',
|
* title: 'South Panel',
|
* collapsible: true,
|
* html: 'Information goes here',
|
* split: true,
|
* height: 100,
|
* minHeight: 100
|
* }, {
|
* region: 'east',
|
* title: 'East Panel',
|
* collapsible: true,
|
* split: true,
|
* width: 150
|
* }, {
|
* region: 'center',
|
* xtype: 'tabpanel', // TabPanel itself has no title
|
* activeTab: 0, // First tab active by default
|
* items: {
|
* title: 'Default Tab',
|
* html: 'The first tab\'s content. Others may be added dynamically'
|
* }
|
* }]
|
* });
|
*/
|
Ext.define('Ext.container.Viewport', {
|
extend: 'Ext.container.Container',
|
alias: 'widget.viewport',
|
requires: ['Ext.EventManager'],
|
alternateClassName: 'Ext.Viewport',
|
|
// Privatize config options which, if used, would interfere with the
|
// correct operation of the Viewport as the sole manager of the
|
// layout of the document body.
|
|
/**
|
* @cfg {String/HTMLElement/Ext.Element} applyTo
|
* @private
|
*/
|
|
/**
|
* @cfg {Boolean} allowDomMove
|
* @private
|
*/
|
|
/**
|
* @cfg {String/HTMLElement/Ext.Element} renderTo
|
* Always renders to document body.
|
* @private
|
*/
|
|
/**
|
* @cfg {Number} height
|
* Sets itself to viewport width.
|
* @private
|
*/
|
|
/**
|
* @cfg {Number} width
|
* Sets itself to viewport height.
|
* @private
|
*/
|
|
/**
|
* @property {Boolean} isViewport
|
* `true` in this class to identify an object as an instantiated Viewport, or subclass thereof.
|
*/
|
isViewport: true,
|
|
ariaRole: 'application',
|
|
preserveElOnDestroy: true,
|
|
viewportCls: Ext.baseCSSPrefix + 'viewport',
|
|
initComponent : function() {
|
var me = this,
|
html = document.body.parentNode,
|
el = me.el = Ext.getBody();
|
|
// Get the DOM disruption over with before the Viewport renders and begins a layout
|
Ext.getScrollbarSize();
|
|
// Clear any dimensions, we will size later on
|
me.width = me.height = undefined;
|
|
me.callParent(arguments);
|
Ext.fly(html).addCls(me.viewportCls);
|
if (me.autoScroll) {
|
Ext.fly(html).setStyle(me.getOverflowStyle());
|
delete me.autoScroll;
|
}
|
el.setHeight = el.setWidth = Ext.emptyFn;
|
el.dom.scroll = 'no';
|
me.allowDomMove = false;
|
me.renderTo = me.el;
|
},
|
|
// override here to prevent an extraneous warning
|
applyTargetCls: function(targetCls) {
|
this.el.addCls(targetCls);
|
},
|
|
onRender: function() {
|
var me = this;
|
|
me.callParent(arguments);
|
|
// Important to start life as the proper size (to avoid extra layouts)
|
// But after render so that the size is not stamped into the body
|
me.width = Ext.Element.getViewportWidth();
|
me.height = Ext.Element.getViewportHeight();
|
},
|
|
afterFirstLayout: function() {
|
var me = this;
|
|
me.callParent(arguments);
|
setTimeout(function() {
|
Ext.EventManager.onWindowResize(me.fireResize, me);
|
}, 1);
|
},
|
|
fireResize : function(width, height){
|
// In IE we can get resize events that have our current size, so we ignore them
|
// to avoid the useless layout...
|
if (width != this.width || height != this.height) {
|
this.setSize(width, height);
|
}
|
},
|
|
initHierarchyState: function(hierarchyState) {
|
this.callParent([this.hierarchyState = Ext.rootHierarchyState]);
|
},
|
|
beforeDestroy: function(){
|
var me = this;
|
|
me.removeUIFromElement();
|
me.el.removeCls(me.baseCls);
|
Ext.fly(document.body.parentNode).removeCls(me.viewportCls);
|
me.callParent();
|
}
|
});
|
