/*
* 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
* @namespace photonui
*/
var Stone = require("stonejs");
var uuid = require("uuid");
var Base = require("./base.js");
var Helpers = require("./helpers.js");
var _widgets = {};
/**
* Base class for all PhotonUI widgets.
*
* wEvents:
*
* * show:
* - description: called when the widget is displayed (a change in the parent's
* visibility can also trigger this event).
* - callback: function(widget)
*
* * hide:
* - description: called when the widget is hidden (a change in the parent's visibility
* can also trigger this event).
* - callback: function(widget)
*
* @class Widget
* @constructor
* @extends photonui.Base
* @param {Object} params An object that can contain any property of the widget (optional).
*/
var Widget = Base.$extend({
// Constructor
__init__: function (params) {
// New instances for object properties
this.__html = {};
this._layoutOptions = {};
// Build the html
this._buildHtml();
// wEvents
this._registerWEvents(["show", "hide"]);
// Parent constructor
this.$super(params);
// Default name
if (!this.name) {
this.name = "widget-" + uuid.v4();
}
// Additional className
if (params && params.className) {
this.addClass(params.className);
}
// Bind some events
if (this.html) {
this._bindEvent("pop-contextmenu", this.html, "contextmenu", this.__onContextMenu.bind(this));
}
this._bindEvent("locale-changed", document, "stonejs-locale-changed", this.__onLocaleChanged.bind(this));
// Register the widget
_widgets[this.name] = this;
},
//////////////////////////////////////////
// Properties and Accessors //
//////////////////////////////////////////
// ====== Public properties ======
/**
* The unique name of the widget.
*
* @property name
* @type String
* @default "widget-" + uuid.v4()
*/
_name: null,
getName: function () {
return this._name;
},
setName: function (name) {
delete _widgets[this.name];
this._name = name;
_widgets[name] = this;
if (this.html) {
this.html.id = this.name;
}
},
/**
* The parent widget name.
*
* @property parentName
* @type String
* @readOnly
* @default null (no parent)
*/
_parentName: null,
getParentName: function () {
return this._parentName;
},
/**
* The parent widget.
*
* @property parent
* @type photonui.Widget
* @readOnly
* @default null (no parent)
*/
getParent: function () {
return Widget.getWidget(this.parentName);
},
/**
* Is the widget visible or hidden.
*
* @property visible
* @type Boolean
* @default true
*/
_visible: true,
isVisible: function () {
"@photonui-update";
return this._visible;
},
setVisible: function (visible) {
this._visible = Boolean(visible);
if (!this.html) {
return;
}
if (visible) {
this.html.style.display = "";
} else {
this.html.style.setProperty("display", "none", "important");
}
this._visibilityChanged();
},
/**
* Tooltip.
*
* @property tooltip
* @type String
* @default null
*/
_tooltip: null,
getTooltip: function () {
return this._tooltip;
},
setTooltip: function (tooltip) {
this._tooltip = tooltip;
if (tooltip) {
this.html.title = tooltip;
} else {
this.html.removeAttribute("title");
}
},
/**
* The name of the managed contextual menu (`photonui.PopupWindow().name`).
*
* @property contextMenuName
* @type String
* @default null (= no context menu)
*/
_contextMenuName: null,
getContextMenuName: function () {
return this._contextMenuName;
},
setContextMenuName: function (contextMenuName) {
this._contextMenuName = contextMenuName;
},
/**
* The managed contextual menu.
*
* @property contextMenu
* @type photonui.PopupWindow
* @default null (= no context menu)
*/
getContextMenu: function () {
return Widget.getWidget(this.contextMenuName);
},
setContextMenu: function (contextMenu) {
var PopupWindow = require("./container/popupwindow.js");
if (contextMenu instanceof PopupWindow) {
this.contextMenuName = contextMenu.name;
} else {
this.contextMenuName = null;
}
},
/**
* Layout options.
*
* @property layoutOptions
* @type Object
* @default {}
*/
_layoutOptions: {},
getLayoutOptions: function () {
return this._layoutOptions;
},
setLayoutOptions: function (layoutOptions) {
for (var option in layoutOptions) {
this._layoutOptions[option] = layoutOptions[option];
}
},
/**
* Html outer element of the widget (if any).
*
* @property html
* @type HTMLElement
* @default null
* @readOnly
*/
getHtml: function () {
Helpers.log("debug", "getHtml() method is not implemented on this widget.");
return null;
},
/**
* Absolute position of the widget on the page.
*
* `{x: Number, y: Number}`
*
* @property absolutePosition
* @type Object
* @readOnly
*/
getAbsolutePosition: function () {
if (!this.html) {
return {x: 0, y: 0};
}
return Helpers.getAbsolutePosition(this.html);
},
/**
* Widget width (outer HTML element).
*
* @property offsetWidth
* @type Number
* @readOnly
*/
getOffsetWidth: function () {
if (!this.html) {
return 0;
}
return this.html.offsetWidth;
},
/**
* Widget height (outer HTML element).
*
* @property offsetHeight
* @type Number
* @readOnly
*/
getOffsetHeight: function () {
if (!this.html) {
return 0;
}
return this.html.offsetHeight;
},
// ====== Private properties ======
/**
* Object containing references to the widget HTML elements
*
* @property __html
* @type Object
* @private
*/
__html: {}, // HTML Elements
//////////////////////////////////////////
// Methods //
//////////////////////////////////////////
// ====== Public methods ======
/**
* Display the widget (equivalent to widget.visible = true).
*
* @method show
*/
show: function () {
this.visible = true;
},
/**
* Hide the widget (equivalent to widget.visible = false).
*
* @method hide
*/
hide: function () {
this.visible = false;
},
/**
* Detache the widget from its parent.
*
* @method unparent
*/
unparent: function () {
if (this.parent) {
this.parent.removeChild(this);
} else if (this.html && this.html.parentNode) {
this.html.parentNode.removeChild(this.html);
}
},
/**
* Destroy the widget.
*
* @method destroy
*/
destroy: function () {
this.$super();
this.unparent();
delete _widgets[this.name];
},
/**
* Add a class to the outer HTML element of the widget.
*
* @method addClass
* @param {String} className The class to add.
*/
addClass: function (className) {
if (!this.html) {
return;
}
var classes = this.html.className.split(" ");
if (classes.indexOf(className) < 0) {
classes.push(className);
}
this.html.className = classes.join(" ");
},
/**
* Remove a class from the outer HTML element of the widget.
*
* @method removeClass
* @param {String} className The class to remove.
*/
removeClass: function (className) {
if (!this.html) {
return;
}
var classes = this.html.className.split(" ");
var index = classes.indexOf(className);
if (index >= 0) {
classes.splice(index, 1);
}
this.html.className = classes.join(" ");
},
// ====== Private methods ======
/**
* Build the widget HTML.
*
* @method _buildHtml
* @private
*/
_buildHtml: function () {
Helpers.log("debug", "_buildHtml() method not implemented on this widget.");
},
/**
* Called when the visibility changes.
*
* @method _visibilityChanged
* @private
* @param {Boolean} visibility Current visibility state (otptional, defaut=this.visible)
*/
_visibilityChanged: function (visibility) {
visibility = (visibility !== undefined) ? visibility : this.visible;
if (visibility && this.visible) {
this._callCallbacks("show");
} else {
this._callCallbacks("hide");
}
},
//////////////////////////////////////////
// Internal Events Callbacks //
//////////////////////////////////////////
/**
* Called when the context menu should be displayed.
*
* @method __onContextMenu
* @private
* @param event
*/
__onContextMenu: function (event) {
event.stopPropagation();
event.preventDefault();
if (this.contextMenuName) {
this.contextMenu.popupXY(event.pageX, event.pageY);
}
},
/**
* Called when the locale is changed.
*
* @method __onLocaleChanged
* @private
*/
__onLocaleChanged: function () {
// Update lazy strings...
for (var prop in this.$map.computedProperties) {
if (this[prop] instanceof Stone.LazyString) {
this[prop] = this[prop];
}
}
},
__classvars__: {
/**
* @property e_parent
* @static
* @type HTMLElement
* @default null
*/
e_parent: null,
/**
* Get a widget.
*
* @method getWidget
* @static
* @param {String} name The widget name.
* @return {Widget} The widget or null.
*/
getWidget: function (name) {
if (_widgets[name] !== undefined) {
return _widgets[name];
}
return null;
},
/**
* Get all instanciated PhotonUI widgets.
*
* @method getAllWidgets
* @static
* @return {Object} An object containing all widgets `{"widgetName": Widget, ...}`
*/
getAllWidgets: function (name) {
return _widgets;
},
/**
* Insert a widget in the DOM.
*
* method domInsert
* @static
* @param {photonui.Widget} widget The widget to insert.
* @param {HTMLElement} element The DOM node or its id (optional, default=Widget.e_parent)
*/
domInsert: function (widget, element) {
element = element || Widget.e_parent || document.getElementsByTagName("body")[0];
if (typeof(element) == "string") {
element = document.getElementById(element);
}
element.appendChild(widget.html);
}
}
});
module.exports = Widget;
