/*
* 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 Visual
* @namespace photonui
*/
var Widget = require("../widget.js");
var Helpers = require("../helpers.js");
/**
* Label.
*
* @class Label
* @constructor
* @extends photonui.Widget
*/
var Label = Widget.$extend({
// Constructor
__init__: function (params1, params2) {
var params = {};
if (params1 && typeof(params1) == "string") {
params.text = params1;
if (params2 && typeof(params2) == "object") {
for (var i in params2) {
params[i] = params2[i];
}
}
} else if (params1) {
params = params1;
}
params.layoutOptions = params.layoutOptions || {};
if (params.layoutOptions.verticalExpansion === undefined) {
params.layoutOptions.verticalExpansion = false;
}
this.$super(params);
},
//////////////////////////////////////////
// Properties and Accessors //
//////////////////////////////////////////
// ====== Public properties ======
/**
* The label text.
*
* @property text
* @type String
* @default "Label"
*/
_text: "Label",
getText: function () {
"@photonui-update";
return this._text;
},
setText: function (text) {
this._text = text;
Helpers.cleanNode(this.__html.label);
var lines = text.split("\n");
for (var i = 0 ; i < lines.length ; i++) {
this.__html.label.appendChild(document.createTextNode(lines[i]));
if (i < lines.length - 1) {
this.__html.label.appendChild(document.createElement("br"));
}
}
},
/**
* The text horizontal alignement.
*
* * "left",
* * "center",
* * "right".
*
* @property textAlign
* @type String
* @default "left"
*/
_textAlign: "left",
getTextAlign: function () {
"@photonui-update";
return this._textAlign;
},
setTextAlign: function (textAlign) {
if (textAlign != "left" && textAlign != "center" && textAlign != "right") {
throw new Error("Text alignement sould be 'left', 'center' or 'right'.");
}
this._textAlign = textAlign;
this.__html.label.style.textAlign = textAlign;
},
/**
* Link the label with the given input (Field, CheckBox,...) widget.
*
* @property forInputName
* @type String
* @default null
*/
_forInputName: null,
getForInputName: function () {
"@photonui-update";
return this._forInputName;
},
setForInputName: function (forInputName) {
this._forInputName = forInputName;
if (this._forInputName) {
if (this.forInput) {
this.__html.label.setAttribute("for",
Helpers.escapeHtml(this.forInput.inputId || this.forInput.name)
);
} else {
this.__html.label.setAttribute("for",
Helpers.escapeHtml(forInputName)
);
}
} else {
this.__html.label.removeAttribute("for");
}
},
/**
* Link the label with the given input (Field, CheckBox,...) widget.
*
* @property forInput
* @type photonui.Field, photonui.CheckBox
* @default null
*/
getForInput: function () {
return Widget.getWidget(this.forInputName);
},
setForInput: function (forInput) {
this.forInputName = forInput.name;
},
/**
* Html outer element of the widget (if any).
*
* @property html
* @type HTMLElement
* @default null
* @readOnly
*/
getHtml: function () {
return this.__html.label;
},
//////////////////////////////////////////
// Methods //
//////////////////////////////////////////
// ====== Private methods ======
/**
* Build the widget HTML.
*
* @method _buildHtml
* @private
*/
_buildHtml: function () {
this.__html.label = document.createElement("label");
this.__html.label.className = "photonui-widget photonui-label photonui-widget-fixed-height";
}
});
module.exports = Label;