/*
* Copyright (c) 2014-2015, Wanadev <http://www.wanadev.fr/>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of Wanadev nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authored by: Fabien LOISON <http://flozz.fr/>
*/
/**
* PhotonUI - Javascript Web User Interface.
*
* @module PhotonUI
* @submodule Layout
* @namespace photonui
*/
var Helpers = require("../helpers.js");
var Layout = require("./layout.js");
/**
* Vertical and horizontal box layout.
*
* Layout Options:
*
* {
* align: <String (stretch|expand, start|left|top, center|middle, end|right|bottom), default=stretch>,
*
* order: <Number default=null (auto)>
*
* minWidth: <Number (null=auto), default=null>,
* maxWidth: <Number (null=auto), default=null>,
* width: <Number (null=auto), default=null>,
*
* minHeight: <Number (null=auto), default=null>,
* maxHeight: <Number (null=auto), default=null>,
* height: <Number (null=auto), default=null>
* }
*
* @class BoxLayout
* @constructor
* @extends photonui.Layout
*/
var BoxLayout = Layout.$extend({
// Constructor
__init__: function (params) {
this.$super(params);
},
//////////////////////////////////////////
// Properties and Accessors //
//////////////////////////////////////////
// ====== Public properties ======
/**
* The layout orientation ("vertical" or "horizontal").
*
* @property orientation
* @type String
* @default "vertical"
*/
_orientation: "vertical",
getOrientation: function () {
"@photonui-update";
return this._orientation;
},
setOrientation: function (orientation) {
if (orientation != "vertical" && orientation != "horizontal") {
throw new Error("The orientation should be \"vertical\" or \"horizontal\".");
}
this._orientation = orientation;
this.removeClass("photonui-layout-orientation-vertical");
this.removeClass("photonui-layout-orientation-horizontal");
this.addClass("photonui-layout-orientation-" + this.orientation);
this.spacing = this.spacing;
},
/**
* Vertical padding (px).
*
* @property verticalPadding
* @type Number
* @default 0
*/
_verticalPadding: 0,
getVerticalPadding: function () {
return this._verticalPadding;
},
setVerticalPadding: function (padding) {
this._verticalPadding = padding | 0;
this.__html.outerbox.style.paddingLeft = this._verticalPadding + "px";
this.__html.outerbox.style.paddingRight = this._verticalPadding + "px";
},
/**
* Horizontal padding (px).
*
* @property horizontalPadding
* @type Number
* @default 0
*/
_horizontalPadding: 0,
getHorizontalPadding: function () {
return this._horizontalPadding;
},
setHorizontalPadding: function (padding) {
this._horizontalPadding = padding | 0;
this.__html.outerbox.style.paddingTop = this._horizontalPadding + "px";
this.__html.outerbox.style.paddingBottom = this._horizontalPadding + "px";
},
/**
* Spacing between children widgets.
*
* @property spacing
* @type Number
* @default 5
*/
_spacing: 5,
getSpacing: function () {
return this._spacing;
},
setSpacing: function (spacing) {
this._spacing = spacing | 0;
var children = this.children;
var nodes = this.__html.outerbox.childNodes;
var last = 0;
var lastOrder;
var currentOrder;
for (var i = 0 ; i < nodes.length ; i++) {
lastOrder = 0;
currentOrder = 0;
if (children[last] && children[last].layoutOptions && children[last].layoutOptions.order) {
lastOrder = children[last].layoutOptions.order | 0;
}
if (children[i] && children[i].layoutOptions && children[i].layoutOptions.order) {
currentOrder = children[i].layoutOptions.order | 0;
}
if (currentOrder >= lastOrder) {
last = i;
}
if (this.orientation == "horizontal") {
nodes[i].style.marginRight = this._spacing + "px";
nodes[i].style.marginBottom = "";
} else {
nodes[i].style.marginRight = "";
nodes[i].style.marginBottom = this._spacing + "px";
}
}
if (nodes.length > 0) {
nodes[last].style.marginRight = "";
nodes[last].style.marginBottom = "";
}
},
/**
* Whether to stretch the box to its parent height or not.
*
* @property stretchToParentHeight
* @type Boolean
* @default true
*/
_stretchToParentHeight: true,
getStretchToParentHeight: function () {
"@photonui-update";
return this._stretchToParentHeight;
},
setStretchToParentHeight: function (stretch) {
this._stretchToParentHeight = stretch;
if (this._stretchToParentHeight) {
this.__html.outerbox.style.height = "100%";
} else {
this.__html.outerbox.style.height = "";
}
},
/**
* Html outer element of the widget (if any).
*
* @property html
* @type HTMLElement
* @default null
* @readOnly
*/
getHtml: function () {
return this.__html.outerbox;
},
//////////////////////////////////////////
// Methods //
//////////////////////////////////////////
// ====== Private methods ======
/**
* Build the widget HTML.
*
* @method _buildHtml
* @private
*/
_buildHtml: function () {
this.__html.outerbox = document.createElement("div");
this.__html.outerbox.className = "photonui-widget photonui-boxlayout";
},
/**
* Update the layout.
*
* @method _updateLayout
* @private
*/
_updateLayout: function () {
Helpers.cleanNode(this.__html.outerbox);
var fragment = document.createDocumentFragment();
var children = this.children;
var container = null;
for (var i = 0 ; i < children.length ; i++) {
var options = this._computeLayoutOptions(children[i]);
container = document.createElement("div");
container.className = "photonui-container photonui-boxlayout-item";
// layout option: align
container.className += " photonui-layout-align-" + options.align;
// layout options: order
if (options.order !== null) {
container.style.order = options.order;
}
// layout options: *width
if (options.minWidth !== null) {
container.style.minWidth = options.minWidth + "px";
}
if (options.maxWidth !== null) {
container.style.maxWidth = options.maxWidth + "px";
}
if (options.width !== null) {
container.style.width = options.width + "px";
}
// layout options: *height
if (options.minHeight !== null) {
container.style.minHeight = options.minHeight + "px";
}
if (options.maxHeight !== null) {
container.style.maxHeight = options.maxHeight + "px";
}
if (options.height !== null) {
container.style.height = options.height + "px";
}
container.appendChild(children[i].html);
fragment.appendChild(container);
}
this.__html.outerbox.appendChild(fragment);
this.spacing = this.spacing;
},
/**
* Returns a normalized layoutOption for a given widget.
*
* @method _computeLayoutOptions
* @private
* @param {photonui.Widget} widget
* @return {Object} the layout options
*/
_computeLayoutOptions: function (widget) {
var woptions = widget.layoutOptions || {};
var options = {
align: "stretch",
minWidth: null,
maxWidth: null,
width: null,
minHeight: null,
maxHeight: null,
height: null,
order: null
};
// align
if (["stretch", "expand"].indexOf(woptions.align) > -1) {
options.align = "stretch";
} else if (["center", "middle"].indexOf(woptions.align) > -1) {
options.align = "center";
} else if (["start", "begin", "top", "left"].indexOf(woptions.align) > -1) {
options.align = "start";
} else if (["end", "bottom", "right"].indexOf(woptions.align) > -1) {
options.align = "end";
}
// order
if (woptions.order !== undefined && woptions.order !== null) {
options.order = woptions.order | 0;
}
// *width
if (woptions.minWidth !== undefined && woptions.minWidth !== null) {
options.minWidth = woptions.minWidth | 0;
}
if (woptions.maxWidth !== undefined && woptions.maxWidth !== null) {
options.maxWidth = woptions.maxWidth | 0;
}
if (woptions.width !== undefined && woptions.width !== null) {
options.width = woptions.width | 0;
options.minWidth = woptions.width | 0;
options.maxWidth = woptions.width | 0;
}
// *height
if (woptions.minHeight !== undefined && woptions.minHeight !== null) {
options.minHeight = woptions.minHeight | 0;
}
if (woptions.maxHeight !== undefined && woptions.maxHeight !== null) {
options.maxHeight = woptions.maxHeight | 0;
}
if (woptions.height !== undefined && woptions.height !== null) {
options.height = woptions.height | 0;
options.minHeight = woptions.height | 0;
options.maxHeight = woptions.height | 0;
}
return options;
}
});
module.exports = BoxLayout;
