update docs and comments

Stanislav Kalashnik · Stanislav Kalashnik · commit 2903d2826efa · 2015-02-18T17:47:48.000+02:00
diff --git a/app/js/component.js b/app/js/component.js
@@ -117,11 +117,10 @@ function Component ( config ) {
 
 	// outer handle
 	if ( config.$node !== undefined ) {
-
 		if ( DEBUG ) {
 			if ( !(config.$node instanceof Element) ) { throw 'wrong config.$node type'; }
 		}
-
+		// apply
 		this.$node = config.$node;
 	} else {
 		// empty div in case nothing is given
@@ -133,7 +132,7 @@ function Component ( config ) {
 		if ( DEBUG ) {
 			if ( !(config.$body instanceof Element) ) { throw 'wrong config.$body type'; }
 		}
-
+		// apply
 		this.$body = config.$body;
 	} else {
 		// inner and outer handlers are identical
@@ -145,7 +144,7 @@ function Component ( config ) {
 		if ( DEBUG ) {
 			if ( !(config.$content instanceof Element) ) { throw 'wrong config.$content type'; }
 		}
-
+		// apply
 		this.$body.appendChild(config.$content);
 	}
 
@@ -157,7 +156,7 @@ function Component ( config ) {
 		if ( DEBUG ) {
 			if ( !(config.parent instanceof Component) ) { throw 'wrong config.parent type'; }
 		}
-
+		// apply
 		config.parent.add(this);
 	}
 
@@ -166,7 +165,7 @@ function Component ( config ) {
 	//	if ( DEBUG ) {
 	//		if ( !(config.page instanceof Component) ) { throw 'wrong config.page type'; }
 	//	}
-    //
+    //	// apply
 	//	this.page = config.page;
 	//}
 
@@ -195,7 +194,7 @@ function Component ( config ) {
 		if ( DEBUG ) {
 			if ( !Array.isArray(config.children) ) { throw 'wrong config.children type'; }
 		}
-
+		// apply
 		this.add.apply(this, config.children);
 	}
 
@@ -244,6 +243,10 @@ function Component ( config ) {
 		this.$node.title = 'component ' + this.constructor.name + '.' + this.id + ' (outer)';
 		this.$body.title = 'component ' + this.constructor.name + '.' + this.id + ' (inner)';
 	}
+
+	// @todo remove or implement
+	// navigation by keyboard
+	//this.addListener('keydown', this.navigateDefault);
 }
 
 
@@ -252,6 +255,37 @@ Component.prototype = Object.create(Emitter.prototype);
 Component.prototype.constructor = Component;
 
 
+/**
+ * Default method to move focus according to pressed keys.
+ *
+ * @todo remove or implement
+ *
+ * @param {Event} event generated event source of movement
+ */
+/*Component.prototype.navigateDefault = function ( event ) {
+	switch ( event.code ) {
+		case keys.up:
+		case keys.down:
+		case keys.right:
+		case keys.left:
+			// notify listeners
+			this.emit('overflow');
+			break;
+	}
+};*/
+
+
+/**
+ * Current active method to move focus according to pressed keys.
+ * Can be redefined to provide custom navigation.
+ *
+ * @todo remove or implement
+ *
+ * @type {function}
+ */
+/*Component.prototype.navigate = Component.prototype.navigateDefault;*/
+
+
 /**
  * Add a new component as a child.
  *
diff --git a/app/js/ui/grid.js b/app/js/ui/grid.js
@@ -136,7 +136,7 @@ function Grid ( config ) {
 		if ( DEBUG ) {
 			if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }
 		}
-
+		// apply
 		this.navigate = config.navigate;
 	}
 
diff --git a/app/js/ui/input.js b/app/js/ui/input.js
@@ -103,7 +103,7 @@ function Input ( config ) {
 		if ( DEBUG ) {
 			if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }
 		}
-
+		// apply
 		this.navigate = config.navigate;
 	}
 
@@ -185,7 +185,7 @@ Input.prototype.init = function ( config ) {
 			if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }
 			if ( config.type !== this.TYPE_TEXT && config.type !== this.TYPE_PASSWORD ) { throw 'config.type must be one of the TYPE_* constant'; }
 		}
-
+		// apply
 		this.type = config.type;
 	}
 
@@ -194,7 +194,7 @@ Input.prototype.init = function ( config ) {
 		if ( DEBUG ) {
 			if ( typeof config.value !== 'string' ) { throw 'config.value must be a string'; }
 		}
-
+		// apply
 		this.setValue(config.value);
 	}
 
@@ -204,8 +204,7 @@ Input.prototype.init = function ( config ) {
 			if ( typeof config.placeholder !== 'string' ) { throw 'config.placeholder must be a string'; }
 			if ( config.placeholder.length === 0 ) { throw 'config.placeholder must be not an empty string'; }
 		}
-
-		// apply placeholder
+		// apply
 		this.$placeholder.innerText = config.placeholder;
 	}
 };
diff --git a/app/js/ui/list.js b/app/js/ui/list.js
@@ -108,7 +108,7 @@ function List ( config ) {
 		if ( DEBUG ) {
 			if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }
 		}
-
+		// apply
 		this.type = config.type;
 	}
 
@@ -127,7 +127,7 @@ function List ( config ) {
 		if ( DEBUG ) {
 			if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }
 		}
-
+		// apply
 		this.navigate = config.navigate;
 	}
 
@@ -299,7 +299,6 @@ List.prototype.init = function ( config ) {
 		if ( DEBUG ) {
 			if ( !Array.isArray(config.data) ) { throw 'wrong config.data type'; }
 		}
-
 		// prepare user data
 		this.data = normalize(config.data);
 	}
@@ -309,7 +308,7 @@ List.prototype.init = function ( config ) {
 		if ( DEBUG ) {
 			if ( typeof config.render !== 'function' ) { throw 'wrong config.render type'; }
 		}
-
+		// apply
 		this.renderItem = config.render;
 	}
 
@@ -319,7 +318,7 @@ List.prototype.init = function ( config ) {
 			if ( Number(config.size) !== config.size ) { throw 'config.size must be a number'; }
 			if ( config.size <= 0 ) { throw 'config.size should be positive'; }
 		}
-
+		// apply
 		this.size = config.size;
 	}
 
diff --git a/app/js/ui/progress.bar.js b/app/js/ui/progress.bar.js
@@ -161,45 +161,44 @@ ProgressBar.prototype.set = function ( value ) {
 /**
  * Init or re-init current max or/and min or/and value.
  *
- * @param {Object} config init parameters
- * @param {number} [config.value=0] initial value
- * @param {number} [config.max=100] max progress value
- * @param {number} [config.min=0] min progress value
+ * @param {Object} config init parameters (subset of constructor config params)
  */
 ProgressBar.prototype.init = function ( config ) {
 	if ( DEBUG ) {
 		if ( arguments.length !== 1 ) { throw 'wrong arguments number'; }
 		if ( typeof config !== 'object' ) { throw 'wrong config type'; }
 	}
 
-	// assignment of configuration parameters if they were transferred
+	// set max progress value
 	if ( config.max !== undefined ) {
 		if ( DEBUG ) {
 			if ( Number(config.max) !== config.max ) { throw 'config.max value must be a number'; }
 		}
-
+		// apply
 		this.max = config.max;
 	}
 
+	// set min progress value
 	if ( config.min !== undefined ) {
 		if ( DEBUG ) {
 			if ( Number(config.min) !== config.min ) { throw 'config.min value must be a number'; }
 		}
-
+		// apply
 		this.min = config.min;
 	}
 
 	if ( DEBUG ) {
 		if ( this.min >= this.max ) { throw 'this.min value must be less than this.max'; }
 	}
 
+	// set actual progress value
 	if ( config.value !== undefined ) {
 		if ( DEBUG ) {
 			if ( Number(config.value) !== config.value ) { throw 'config.value must be a number'; }
 			if ( config.value > this.max ) { throw 'config.value more than config.maximum'; }
 			if ( config.value < this.min ) { throw 'config.value less than config.minimum'; }
 		}
-
+		// apply
 		this.value = config.value;
 	}
 
diff --git a/app/js/ui/scroll.bar.js b/app/js/ui/scroll.bar.js
@@ -98,7 +98,7 @@ function ScrollBar ( config ) {
 		if ( DEBUG ) {
 			if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }
 		}
-
+		// apply
 		this.type = config.type;
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ function Grid ( config ) {`
`136`	`136`	`if ( DEBUG ) {`
`137`	`137`	`if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }`
`138`	`138`	`}`
`139`		`-`
	`139`	`+ // apply`
`140`	`140`	`this.navigate = config.navigate;`
`141`	`141`	`}`
`142`	`142`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ function Input ( config ) {`
`103`	`103`	`if ( DEBUG ) {`
`104`	`104`	`if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }`
`105`	`105`	`}`
`106`		`-`
	`106`	`+ // apply`
`107`	`107`	`this.navigate = config.navigate;`
`108`	`108`	`}`
`109`	`109`
`@@ -185,7 +185,7 @@ Input.prototype.init = function ( config ) {`
`185`	`185`	`if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }`
`186`	`186`	`if ( config.type !== this.TYPE_TEXT && config.type !== this.TYPE_PASSWORD ) { throw 'config.type must be one of the TYPE_* constant'; }`
`187`	`187`	`}`
`188`		`-`
	`188`	`+ // apply`
`189`	`189`	`this.type = config.type;`
`190`	`190`	`}`
`191`	`191`
`@@ -194,7 +194,7 @@ Input.prototype.init = function ( config ) {`
`194`	`194`	`if ( DEBUG ) {`
`195`	`195`	`if ( typeof config.value !== 'string' ) { throw 'config.value must be a string'; }`
`196`	`196`	`}`
`197`		`-`
	`197`	`+ // apply`
`198`	`198`	`this.setValue(config.value);`
`199`	`199`	`}`
`200`	`200`
`@@ -204,8 +204,7 @@ Input.prototype.init = function ( config ) {`
`204`	`204`	`if ( typeof config.placeholder !== 'string' ) { throw 'config.placeholder must be a string'; }`
`205`	`205`	`if ( config.placeholder.length === 0 ) { throw 'config.placeholder must be not an empty string'; }`
`206`	`206`	`}`
`207`		`-`
`208`		`- // apply placeholder`
	`207`	`+ // apply`
`209`	`208`	`this.$placeholder.innerText = config.placeholder;`
`210`	`209`	`}`
`211`	`210`	`};`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ function List ( config ) {`
`108`	`108`	`if ( DEBUG ) {`
`109`	`109`	`if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }`
`110`	`110`	`}`
`111`		`-`
	`111`	`+ // apply`
`112`	`112`	`this.type = config.type;`
`113`	`113`	`}`
`114`	`114`
`@@ -127,7 +127,7 @@ function List ( config ) {`
`127`	`127`	`if ( DEBUG ) {`
`128`	`128`	`if ( typeof config.navigate !== 'function' ) { throw 'wrong config.navigate type'; }`
`129`	`129`	`}`
`130`		`-`
	`130`	`+ // apply`
`131`	`131`	`this.navigate = config.navigate;`
`132`	`132`	`}`
`133`	`133`
`@@ -299,7 +299,6 @@ List.prototype.init = function ( config ) {`
`299`	`299`	`if ( DEBUG ) {`
`300`	`300`	`if ( !Array.isArray(config.data) ) { throw 'wrong config.data type'; }`
`301`	`301`	`}`
`302`		`-`
`303`	`302`	`// prepare user data`
`304`	`303`	`this.data = normalize(config.data);`
`305`	`304`	`}`
`@@ -309,7 +308,7 @@ List.prototype.init = function ( config ) {`
`309`	`308`	`if ( DEBUG ) {`
`310`	`309`	`if ( typeof config.render !== 'function' ) { throw 'wrong config.render type'; }`
`311`	`310`	`}`
`312`		`-`
	`311`	`+ // apply`
`313`	`312`	`this.renderItem = config.render;`
`314`	`313`	`}`
`315`	`314`
`@@ -319,7 +318,7 @@ List.prototype.init = function ( config ) {`
`319`	`318`	`if ( Number(config.size) !== config.size ) { throw 'config.size must be a number'; }`
`320`	`319`	`if ( config.size <= 0 ) { throw 'config.size should be positive'; }`
`321`	`320`	`}`
`322`		`-`
	`321`	`+ // apply`
`323`	`322`	`this.size = config.size;`
`324`	`323`	`}`
`325`	`324`
Original file line number	Diff line number	Diff line change
`@@ -161,45 +161,44 @@ ProgressBar.prototype.set = function ( value ) {`
`161`	`161`	`/**`
`162`	`162`	`* Init or re-init current max or/and min or/and value.`
`163`	`163`	`*`
`164`		`- * @param {Object} config init parameters`
`165`		`- * @param {number} [config.value=0] initial value`
`166`		`- * @param {number} [config.max=100] max progress value`
`167`		`- * @param {number} [config.min=0] min progress value`
	`164`	`+ * @param {Object} config init parameters (subset of constructor config params)`
`168`	`165`	`*/`
`169`	`166`	`ProgressBar.prototype.init = function ( config ) {`
`170`	`167`	`if ( DEBUG ) {`
`171`	`168`	`if ( arguments.length !== 1 ) { throw 'wrong arguments number'; }`
`172`	`169`	`if ( typeof config !== 'object' ) { throw 'wrong config type'; }`
`173`	`170`	`}`
`174`	`171`
`175`		`- // assignment of configuration parameters if they were transferred`
	`172`	`+ // set max progress value`
`176`	`173`	`if ( config.max !== undefined ) {`
`177`	`174`	`if ( DEBUG ) {`
`178`	`175`	`if ( Number(config.max) !== config.max ) { throw 'config.max value must be a number'; }`
`179`	`176`	`}`
`180`		`-`
	`177`	`+ // apply`
`181`	`178`	`this.max = config.max;`
`182`	`179`	`}`
`183`	`180`
	`181`	`+ // set min progress value`
`184`	`182`	`if ( config.min !== undefined ) {`
`185`	`183`	`if ( DEBUG ) {`
`186`	`184`	`if ( Number(config.min) !== config.min ) { throw 'config.min value must be a number'; }`
`187`	`185`	`}`
`188`		`-`
	`186`	`+ // apply`
`189`	`187`	`this.min = config.min;`
`190`	`188`	`}`
`191`	`189`
`192`	`190`	`if ( DEBUG ) {`
`193`	`191`	`if ( this.min >= this.max ) { throw 'this.min value must be less than this.max'; }`
`194`	`192`	`}`
`195`	`193`
	`194`	`+ // set actual progress value`
`196`	`195`	`if ( config.value !== undefined ) {`
`197`	`196`	`if ( DEBUG ) {`
`198`	`197`	`if ( Number(config.value) !== config.value ) { throw 'config.value must be a number'; }`
`199`	`198`	`if ( config.value > this.max ) { throw 'config.value more than config.maximum'; }`
`200`	`199`	`if ( config.value < this.min ) { throw 'config.value less than config.minimum'; }`
`201`	`200`	`}`
`202`		`-`
	`201`	`+ // apply`
`203`	`202`	`this.value = config.value;`
`204`	`203`	`}`
`205`	`204`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ function ScrollBar ( config ) {`
`98`	`98`	`if ( DEBUG ) {`
`99`	`99`	`if ( Number(config.type) !== config.type ) { throw 'config.type must be a number'; }`
`100`	`100`	`}`
`101`		`-`
	`101`	`+ // apply`
`102`	`102`	`this.type = config.type;`
`103`	`103`	`}`
`104`	`104`