ImageGrid/ui (gen4)/features/ui-progress.js

/**********************************************************************
* 
*
*
**********************************************************************/
((typeof define)[0]=='u'?function(f){module.exports=f(require)}:define)(
function(require){ var module={} // makes module AMD/node compatible...
/*********************************************************************/

var actions = require('lib/actions')
var features = require('lib/features')

var core = require('features/core')



/*********************************************************************/

var ProgressActions = actions.Actions({
	config: {
		'progress-fade-duration': 200,
		'progress-done-delay': 1000,
	},

	// Progress bar widget...
	//
	// 	Create progress bar...
	// 	.testProgress('text')
	//
	// 	Update progress bar (value, max, msg)...
	// 	.testProgress('text', 0, 10)
	// 	.testProgress('text', 10, 50, 'message')
	//
	// 	Update progress bar value (has no effect if max is not set)...
	// 	.testProgress('text', 10)
	//
	// 	Close progress bar...
	// 	.testProgress('text', 'close')
	//
	// 	Relative progress modification...
	// 	.testProgress('text', '+1')
	// 	.testProgress('text', '+0', '+1')
	//
	//
	// XXX move configuration to .config
	// XXX should we report errors and stoppages??? (error state??)
	// XXX multiple containers...
	// XXX shorten the nested class names...
	// XXX revise styles...
	showProgress: ['- Interface/Show progress bar...',
		function(text, value, max){
			var viewer = this.ribbons.viewer
			var that = this

			var msg = text instanceof Array ? text.slice(1).join(': ') : null
			text = text instanceof Array ? text[0] : text

			// container...
			var container = viewer.find('.progress-container')
			container = container.length == 0 ?
				$('<div/>')
					.addClass('progress-container')
					.appendTo(viewer)
				: container

			// widget...
			var widget = container.find('.progress-bar[name="'+text+'"]')
			// close action...
			if(value == 'close'){
				widget.trigger('progressClose')
				return
			}
			widget = widget.length == 0 ?
				$('<div/>')
					.addClass('progress-bar')
					.attr('name', text)
					.text(text)
					// close button...
					.append($('<span class="close">&times;</span>')
						.on('click', function(){ widget.trigger('progressClose') }))
					// state...
					.append($('<span/>')
						.addClass('progress-details'))
					// bar...
					.append($('<progress/>'))
					// events...
					.on('progressClose', function(){ 
						widget
							.fadeOut(that.config['progress-fade-duration'] || 200, function(){
								$(this).remove() 
							})
					})
					.appendTo(container)
				: widget

			// reset closing timeout...
			var timeout = widget.attr('close-timeout')
			timeout && clearTimeout(JSON.parse(timeout))

			// get the widget parts we are updating...
			var bar = widget.find('progress')
			var state = widget.find('.progress-details')

			// XXX stub???
			// normalize max and value...
			max = max != null ? 
					(typeof(max) == typeof('str') && /[+-][0-9]+/.test(max) ? 
						parseInt(bar.attr('max') || 0) + parseInt(max)
					: parseInt(max))
				: bar.attr('max')
			value = value != null ? 
					(typeof(value) == typeof('str') && /[+-][0-9]+/.test(value) ? 
						parseInt(bar.attr('value') || 0) + parseInt(value)
					: parseInt(value))
				: bar.attr('value')

			// format the message...
			msg = msg ? ': '+msg : ''
			msg = ' '+ msg 
				//+ (value && value >= (max || 0) ? ' ('+value+' done)' 
				+ (value && value >= (max || 0) ? ' (done)' 
					: value && max && value != max ? ' ('+ value +' of '+ max +')'
					: '...')

			// update widget...
			bar.attr({
				value: value || '',
				max: max || '',
			})
			state.text(msg)

			// auto-close...
			// XXX make this optional... 
			if(value && value >= (max || 0)){
				widget.attr('close-timeout', 
					JSON.stringify(setTimeout(function(){ 
						widget.trigger('progressClose') 
					}, this.config['progress-done-delay'] || 1000)))
			}

			// XXX what should we return??? (state, self, controller?)
		}],
})

var Progress = 
module.Progress = core.ImageGridFeatures.Feature({
	title: '',
	doc: '',

	tag: 'ui-progress',
	depends: [
		'ui',
	],

	actions: ProgressActions, 
})




/**********************************************************************
* vim:set ts=4 sw=4 :                               */ return module })