From abe5277f729824872cf92c767d1d24a039a20bb1 Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Sun, 1 May 2016 21:54:44 +0300
Subject: [PATCH] refining the resizing protocol...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 ui (gen4)/features/core.js |  8 ++++
 ui (gen4)/features/ui.js   | 82 ++++++++++++++++++++++++--------------
 ui (gen4)/lib/actions.js   |  3 ++
 3 files changed, 64 insertions(+), 29 deletions(-)

diff --git a/ui (gen4)/features/core.js b/ui (gen4)/features/core.js
index 1916df99..ef4db0d8 100755
--- a/ui (gen4)/features/core.js	
+++ b/ui (gen4)/features/core.js	
@@ -18,6 +18,14 @@ var toggler = require('lib/toggler')
 
 /*********************************************************************/
 
+var protocolAction =
+module.protocol = function(protocol, func){
+	return function(){
+		this[protocol].chainCall(this, func, arguments)
+	}
+}
+
+
 // NOTE: if not state is set this assumes that the first state is the 
 // 		default...
 var makeConfigToggler = 
diff --git a/ui (gen4)/features/ui.js b/ui (gen4)/features/ui.js
index f4189588..9c083ba5 100755
--- a/ui (gen4)/features/ui.js	
+++ b/ui (gen4)/features/ui.js	
@@ -592,12 +592,36 @@ module.ViewerActions = actions.Actions({
 	// Zooming/scaling root action...
 	//
 	// Protocol:
-	// 	- all root zoom/scale action bust be wrapped in the .resizing action
+	// 	- a compliant action must be wrapped in the .resizing action
+	// 	- a compliant action must pass the sizing unit, value and 
+	// 		overflow to the wrapping action.
+	//
+	// Example:
+	//	actionName: ['...',
+	//		function(value){
+	//			this.resizing.chainCall(this, function(){
+	//
+	//				// action code...
+	//
+	//			}, 
+	//			// action unit...
+	//			'scale', 
+	//			// action value...
+	//			scale)
+	//		}],
+	//
 	//
 	// This will enable clients to attach to a single in/out point.
 	//
 	// NOTE: not intended for direct use...
-	resizing: ['- Zoom/', function(){}],
+	resizing: ['- Zoom/', function(unit, size, overflow){
+		// This is a resizing protocol root function.
+		//
+		// This will never be used directly, but will wrap protocol user
+		// functions.
+		//
+		// As an example see: .setScale(..)
+	}],
 
 	// Root zoom/sclae actions...
 	//
@@ -607,14 +631,14 @@ module.ViewerActions = actions.Actions({
 			this.resizing.chainCall(this, function(){
 				this.ribbons && scale && this.ribbons.scale(scale)
 				this.refresh()
-			})
+			}, 'scale', scale)
 		}],
 	fitOrig: ['Zoom/Fit to original scale',
 		function(){ 
 			this.resizing.chainCall(this, function(){
 				this.ribbons.scale(1) 
 				this.refresh()
-			})
+			}, 'scale', 1)
 		}],
 	// NOTE: if this gets a count argument it will fit count images, 
 	// 		default is one.
@@ -633,7 +657,7 @@ module.ViewerActions = actions.Actions({
 				}
 				this.ribbons.fitImage(count)
 				this.refresh()
-			})
+			}, 'screenwidth', count, overflow)
 		}],
 	// NOTE: this does not accout for ribbon spacing...
 	fitRibbon: ['Zoom/Fit ribbon vertically',
@@ -641,7 +665,7 @@ module.ViewerActions = actions.Actions({
 			this.resizing.chainCall(this, function(){
 				this.ribbons.fitRibbon(count, whole)
 				this.refresh()
-			})
+			}, 'screenheight', count, whole)
 		}],
 
 
@@ -1487,31 +1511,31 @@ module.PartialRibbons = core.ImageGridFeatures.Feature({
 			function(_, target){
 				this.preCacheJumpTargets(target)
 			}],
-		['setScale.pre', 
-			function(s){
-				this.updateRibbon('current', this.screenwidth / s || 1)
-				//this.preCacheJumpTargets()
-			}],
-		['resizing.pre', 
-			function(n){
-				this.updateRibbon('current', n || 1)
-				//this.preCacheJumpTargets()
-			}],
-		['fitRibbon.pre', 
-			function(n){
-				n = n || 1
 
-				// convert target height in ribbons to width in images...
-				// NOTE: this does not account for compensation that 
-				// 		.updateRibbon(..) makes for fitting whole image
-				// 		counts, this is a small enough error so as not
-				// 		to waste time on...
-				var s = this.ribbons.scale()
-				var h = this.ribbons.getScreenHeightRibbons()
-				var w = this.ribbons.getScreenWidthImages()
-				var nw = w / (h/n)
+		['resizing.pre',
+			function(unit, size){
+				if(unit == 'scale'){
+					this.updateRibbon('current', this.screenwidth / size || 1)
+
+				} else if(unit == 'screenwidth'){
+					this.updateRibbon('current', size || 1)
+
+				} else if(unit == 'screenheight'){
+					size = size || 1
+
+					// convert target height in ribbons to width in images...
+					// NOTE: this does not account for compensation that 
+					// 		.updateRibbon(..) makes for fitting whole image
+					// 		counts, this is a small enough error so as not
+					// 		to waste time on...
+					var s = this.ribbons.scale()
+					var h = this.ribbons.getScreenHeightRibbons()
+					var w = this.ribbons.getScreenWidthImages()
+					var nw = w / (h/size)
+
+					this.updateRibbon('current', nw)
+				}
 
-				this.updateRibbon('current', nw)
 				//this.preCacheJumpTargets()
 			}],
 	],
diff --git a/ui (gen4)/lib/actions.js b/ui (gen4)/lib/actions.js
index 6e3a4a30..5270c8f9 100755
--- a/ui (gen4)/lib/actions.js	
+++ b/ui (gen4)/lib/actions.js	
@@ -87,6 +87,9 @@ var object = require('lib/object')
 // 		<action-set>.getDoc(<action-name>[, ..])
 // 				-> dict of action-name, doc
 //
+// 		<action-set>.a.getHandlerDocStr(<action-name>)
+// 				-> formated string of action handlers
+//
 // 		<action-set>.actions
 // 				-> list of action names
 //