File: src/visual/faicon.js
/*
* 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 BaseIcon = require("./baseicon.js");
/**
* Font Awesome Icon.
*
* Special contructor params:
*
* new photonui.FAIcon( {optional params...} )
* new photonui.FAIcon( "iconName", {optional params...} )
*
* @class FAIcon
* @constructor
* @extends photonui.BaseIcon
*/
var FAIcon = BaseIcon.$extend({
// Constructor
__init__: function (params1, params2) {
var params = {};
if (params1 && typeof(params1) == "string") {
params.iconName = params1;
if (params2 && typeof(params2) == "object") {
for (var i in params2) {
params[i] = params2[i];
}
}
} else if (params1) {
params = params1;
}
this.$super(params);
},
//////////////////////////////////////////
// Properties and Accessors //
//////////////////////////////////////////
// ====== Public properties ======
/**
* The Font Awesome icon name (e.g. "fa-cog").
*
* Icon list: http://fontawesome.io/icons/
*
* @property iconName
* @type String
* @default ""
*/
_iconName: "",
getIconName: function () {
"@photonui-update";
return this._iconName;
},
setIconName: function (iconName) {
this._iconName = iconName || "";
this.__html.icon.className = "fa " + this.iconName + " " + this.size;
},
/**
* Font Awesome icon size (e.g. "fa-2x").
*
* Icon sizes list: http://fontawesome.io/examples/#larger
*
* @property size
* @type String
* @default ""
*/
_size: "",
getSize: function () {
"@photonui-update";
return this._size;
},
setSize: function (size) {
this._size = size || "";
this.__html.icon.className = "fa " + this.iconName + " " + this.size;
},
/**
* The icon color.
*
* @property color
* @type String
* default: "inherit"
*/
_color: "inherit",
getColor: function () {
"@photonui-update";
return this._color;
},
setColor: function (color) {
this._color = color || "inherit";
this.__html.icon.style.color = this.color;
},
/**
* Html outer element of the widget (if any).
*
* @property html
* @type HTMLElement
* @default null
* @readOnly
*/
getHtml: function () {
return this.__html.outer;
},
//////////////////////////////////////////
// Methods //
//////////////////////////////////////////
// ====== Private methods ======
/**
* Build the widget HTML.
*
* @method _buildHtml
* @private
*/
_buildHtml: function () {
this.__html.outer = document.createElement("span");
this.__html.outer.className = "photonui-widget photonui-icon photonui-faicon";
this.__html.icon = document.createElement("i");
this.__html.outer.appendChild(this.__html.icon);
}
});
module.exports = FAIcon;