From: Alexander Ebert <ebert@woltlab.com>
Date: Sun, 3 May 2015 19:00:46 +0000 (+0200)
Subject: Changed var Foo = function() to function Foo(), added missing JSDoc
X-Git-Tag: 3.0.0_Beta_1~2422
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=a0c09b4b7d40ea592785059ae045d144f43a040a;p=GitHub%2FWoltLab%2FWCF.git

Changed var Foo = function() to function Foo(), added missing JSDoc
---

diff --git a/wcfsetup/install/files/js/WoltLab/WCF/CallbackList.js b/wcfsetup/install/files/js/WoltLab/WCF/CallbackList.js
index 148d77571b..3b2aaf14bb 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/CallbackList.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/CallbackList.js
@@ -12,7 +12,7 @@ define(['Dictionary'], function(Dictionary) {
 	/**
 	 * @constructor
 	 */
-	var CallbackList = function() {
+	function CallbackList() {
 		this._dictionary = new Dictionary();
 	};
 	CallbackList.prototype = {
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Core.js b/wcfsetup/install/files/js/WoltLab/WCF/Core.js
index 6eb70df14f..892e822b2a 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/Core.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/Core.js
@@ -12,7 +12,7 @@ define(['jQuery'], function($) {
 	/**
 	 * @constructor
 	 */
-	var Core = function() {};
+	function Core() {};
 	Core.prototype = {
 		/**
 		 * Initializes the core UI modifications and unblocks jQuery's ready event.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/DOM/Traverse.js b/wcfsetup/install/files/js/WoltLab/WCF/DOM/Traverse.js
index 1eb7b5afe0..ff180ada0f 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/DOM/Traverse.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/DOM/Traverse.js
@@ -48,7 +48,7 @@ define(['DOM/Util'], function(DOMUtil) {
 	/**
 	 * @constructor
 	 */
-	var DOMTraverse = function() {};
+	function DOMTraverse() {};
 	DOMTraverse.prototype = {
 		/**
 		 * Examines parent nodes and returns the first parent that matches the given selector.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/DOM/Util.js b/wcfsetup/install/files/js/WoltLab/WCF/DOM/Util.js
index ffa911b368..18d3a898ce 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/DOM/Util.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/DOM/Util.js
@@ -23,7 +23,7 @@ define(function() {
 	/**
 	 * @constructor
 	 */
-	var DOMUtil = function() {};
+	function DOMUtil() {};
 	DOMUtil.prototype = {
 		/**
 		 * Returns a unique element id.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Date/Time/Relative.js b/wcfsetup/install/files/js/WoltLab/WCF/Date/Time/Relative.js
index 477d740a1b..2c1d76439b 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/Date/Time/Relative.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/Date/Time/Relative.js
@@ -15,7 +15,7 @@ define(function() {
 	/**
 	 * @constructor
 	 */
-	var DateTimeRelative = function() {};
+	function DateTimeRelative() {};
 	DateTimeRelative.prototype = {
 		/**
 		 * Transforms <time> elements on init and binds event listeners.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Dictionary.js b/wcfsetup/install/files/js/WoltLab/WCF/Dictionary.js
index 505253c744..ce3ae6046f 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/Dictionary.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/Dictionary.js
@@ -14,7 +14,7 @@ define(function() {
 	/**
 	 * @constructor
 	 */
-	var Dictionary = function() {
+	function Dictionary() {
 		this._dictionary = (_hasMap) ? new Map() : {};
 	};
 	Dictionary.prototype = {
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/Event/Handler.js b/wcfsetup/install/files/js/WoltLab/WCF/Event/Handler.js
index 21b63967bb..d6bf74f7ee 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/Event/Handler.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/Event/Handler.js
@@ -14,7 +14,7 @@ define(['Dictionary'], function(Dictionary) {
 	/**
 	 * @constructor
 	 */
-	var EventHandler = function() {};
+	function EventHandler() {};
 	EventHandler.prototype = {
 		/**
 		 * Adds an event listener.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/UI/Alignment.js b/wcfsetup/install/files/js/WoltLab/WCF/UI/Alignment.js
index bff6c610e7..25a01a7a3d 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/UI/Alignment.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/UI/Alignment.js
@@ -12,57 +12,8 @@ define(['Core', 'DOM/Util'], function(Core, DOMUtil) {
 	/**
 	 * @constructor
 	 */
-	var UiAlignment = function() {};
-	UiAlignment.prototype = {
-		_tryAlignmentHorizontal: function(align, elDimensions, refDimensions, refOffsets, windowWidth) {
-			var left = 'auto';
-			var right = 'auto';
-			var result = true;
-			
-			if (align === 'left') {
-				left = refOffsets.left;
-				if (left + elDimensions.width > windowWidth) {
-					result = false;
-				}
-			}
-			else {
-				right = refOffsets.left + refDimensions.width;
-				if (right - elDimensions.width < 0) {
-					result = false;
-				}
-			}
-			
-			return {
-				left: left,
-				right: right,
-				result: result
-			}
-		},
-		_tryAlignmentVertical: function(align, elDimensions, refDimensions, refOffsets, windowHeight, verticalOffset) {
-			var bottom = 'auto';
-			var top = 'auto';
-			var result = true;
-			
-			if (align === 'top') {
-				bottom = refOffsets.top + verticalOffset;
-				if (bottom - elDimensions.height < 0) {
-					result = false;
-				}
-			}
-			else {
-				top = refOffsets.top + refDimensions.height + verticalOffset;
-				if (top + elDimensions.height > windowHeight) {
-					result = false;
-				}
-			}
-			
-			return {
-				bottom: bottom,
-				top: top,
-				result: result
-			}
-		},
-		
+	function UIAlignment() {};
+	UIAlignment.prototype = {
 		/**
 		 * Sets the alignment for target element relatively to the reference element.
 		 * 
@@ -142,8 +93,8 @@ define(['Core', 'DOM/Util'], function(Core, DOMUtil) {
 			
 			// set pointer position
 			if (options.pointer) {
-				var pointer = null;
-				
+				//var pointer = null;
+				// TODO: implement pointer support, e.g. for interactive dropdowns
 				console.debug("TODO");
 			}
 			else if (options.pointerClassNames.length === 2) {
@@ -160,8 +111,79 @@ define(['Core', 'DOM/Util'], function(Core, DOMUtil) {
 				right: right + (right !== 'auto' ? 'px' : ''),
 				top: top + (top !== 'auto' ? 'px' : '')
 			});
+		},
+		
+		/**
+		 * Calculates left/right position and verifys if the element would be still within the page's boundaries.
+		 * 
+		 * @param	{string}			align		align to this side of the reference element
+		 * @param	{object<string, integer>}	elDimensions	element dimensions
+		 * @param	{object<string, integer>}	refDimensions	reference element dimensions
+		 * @param	{object<string, integer>}	refOffsets	position of reference element relative to the document
+		 * @param	{integer}			windowWidth	window width
+		 * @returns	{object<string, *>}	calculation results
+		 */
+		_tryAlignmentHorizontal: function(align, elDimensions, refDimensions, refOffsets, windowWidth) {
+			var left = 'auto';
+			var right = 'auto';
+			var result = true;
+			
+			if (align === 'left') {
+				left = refOffsets.left;
+				if (left + elDimensions.width > windowWidth) {
+					result = false;
+				}
+			}
+			else {
+				right = refOffsets.left + refDimensions.width;
+				if (right - elDimensions.width < 0) {
+					result = false;
+				}
+			}
+			
+			return {
+				left: left,
+				right: right,
+				result: result
+			};
+		},
+		
+		/**
+		 * Calculates top/bottom position and verifys if the element would be still within the page's boundaries.
+		 * 
+		 * @param	{string}			align		align to this side of the reference element
+		 * @param	{object<string, integer>}	elDimensions	element dimensions
+		 * @param	{object<string, integer>}	refDimensions	reference element dimensions
+		 * @param	{object<string, integer>}	refOffsets	position of reference element relative to the document
+		 * @param	{integer}			windowHeight	window height
+		 * @param	{integer}			verticalOffset	desired gap between element and reference element
+		 * @returns	{object<string, *>}	calculation results
+		 */
+		_tryAlignmentVertical: function(align, elDimensions, refDimensions, refOffsets, windowHeight, verticalOffset) {
+			var bottom = 'auto';
+			var top = 'auto';
+			var result = true;
+			
+			if (align === 'top') {
+				bottom = refOffsets.top + verticalOffset;
+				if (bottom - elDimensions.height < 0) {
+					result = false;
+				}
+			}
+			else {
+				top = refOffsets.top + refDimensions.height + verticalOffset;
+				if (top + elDimensions.height > windowHeight) {
+					result = false;
+				}
+			}
+			
+			return {
+				bottom: bottom,
+				top: top,
+				result: result
+			};
 		}
 	};
 	
-	return new UiAlignment();
+	return new UIAlignment();
 });
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/UI/Dropdown/Simple.js b/wcfsetup/install/files/js/WoltLab/WCF/UI/Dropdown/Simple.js
index 38c9e96d4e..62b5bac7b4 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/UI/Dropdown/Simple.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/UI/Dropdown/Simple.js
@@ -21,7 +21,7 @@ define(
 	/**
 	 * @constructor
 	 */
-	var SimpleDropdown = function() { };
+	function SimpleDropdown() { };
 	SimpleDropdown.prototype = {
 		/**
 		 * Performs initial setup such as setting up dropdowns and binding listeners.
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/UI/Mobile.js b/wcfsetup/install/files/js/WoltLab/WCF/UI/Mobile.js
index ac34683b6a..abc03b59f9 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/UI/Mobile.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/UI/Mobile.js
@@ -17,8 +17,8 @@ define(['jQuery', 'enquire', 'DOM/Traverse'], function($, enquire, DOMTraverse)
 	/**
 	 * @constructor
 	 */
-	var UiMobile = function() {};
-	UiMobile.prototype = {
+	function UIMobile() {};
+	UIMobile.prototype = {
 		/**
 		 * Initializes the mobile UI using enquire.js.
 		 */
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu.js b/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu.js
index be211c846a..0a02501191 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu.js
@@ -1,14 +1,34 @@
 "use strict";
 
+/**
+ * Common interface for tab menu access.
+ * 
+ * @author	Alexander Ebert
+ * @copyright	2001-2015 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @module	WoltLab/WCF/UI/TabMenu
+ */
 define(['Dictionary', 'DOM/Util', './TabMenu/Simple'], function(Dictionary, DOMUtil, SimpleTabMenu) {
 	var _tabMenus = new Dictionary();
 	
 	/**
 	 * @constructor
 	 */
-	var UiTabMenu = function() {};
-	UiTabMenu.prototype = {
-		init: function() {
+	function UITabMenu() {};
+	UITabMenu.prototype = {
+		/**
+		 * Sets up tab menus and binds listeners.
+		 */
+		setup: function() {
+			this._init();
+			
+			// TODO: use WCF.DOMNodeInsertedHandler
+		},
+		
+		/**
+		 * Initializes available tab menus.
+		 */
+		_init: function() {
 			var tabMenus = document.querySelectorAll('.tabMenuContainer:not(.staticTabMenuContainer)');
 			for (var i = 0, length = tabMenus.length; i < length; i++) {
 				var container = tabMenus[i];
@@ -27,10 +47,16 @@ define(['Dictionary', 'DOM/Util', './TabMenu/Simple'], function(Dictionary, DOMU
 			}
 		},
 		
+		/**
+		 * Returns a SimpleTabMenu instance for given container id.
+		 * 
+		 * @param	{string}	containerId	tab menu container id
+		 * @return	{SimpleTabMenu}	tab menu object
+		 */
 		getTabMenu: function(containerId) {
 			return _tabMenus.get(containerId);
 		}
 	};
 	
-	return new UiTabMenu();
+	return new UITabMenu();
 });
diff --git a/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu/Simple.js b/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu/Simple.js
index 6be0a66ebd..faa6d4d2ee 100644
--- a/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu/Simple.js
+++ b/wcfsetup/install/files/js/WoltLab/WCF/UI/TabMenu/Simple.js
@@ -14,7 +14,7 @@ define(['jQuery', 'Dictionary', 'DOM/Util', 'EventHandler'], function($, Diction
 	 * @param	{Element}	container	container element
 	 * @constructor
 	 */
-	var TabMenuSimple = function(containerId, container) {
+	function TabMenuSimple(containerId, container) {
 		this._container = container;
 		this._containers = new Dictionary();
 		this._containerId = containerId;