ImageGrid/ui (gen4)/actions.js

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

define(function(require){ var module = {}
console.log('>>> actions')



/*********************************************************************/
//
// Might also be a good idea to add "relative terms" to be used as 
// arguments for actions (a-la jQuery collections):
//
// 	Image			- current image
// 		.next(<offset> | 'all')
// 		.prev(..)
// 	Ribbon			- ribbon or ribbon images
// 		.next(..)
// 		.prev(..)
//
// 	Images			- all images
// 	Marked			- marked images
// 	Bookmarked		- bookmarked images
//
//
// NOTE: these can also beused as a basis for actions...
//
//
/*********************************************************************/

// XXX test the context if it's a jQuery object use it's interface and 
// 		if it's a events.EventEmitter instance use that...
var fireEvent =
module.fireEvent =
function(context, name, args){
	var EventEmitter = nodejs != null 
		? nodejs.require('events').EventEmitter 
		: null
	var jQuery = typeof(jQuery) != 'undefined' ? jQuery : null

	// jQuery event...
	if(typeof(context) == typeof('str')
			|| (jq_object != null 
				&& context instanceof jQuery)){
		var c = $(context)
			.trigger(name, args)

	// node event...
	} else if(EventEmitter != null && context instanceof EventEmitter){
		var c = context
			.emit.apply(context, [name].concat(args))

	} else {
		console.error('Incompatible event context type:', context)
	}
	return c
}


// NOTE: context is dynamic.
var Action =
module.Action = 
function Action(context, name, doc, code){
	var action = function(){
		var args = args2array(arguments)
		var c = fireEvent(context, name + '.pre', args)

		// run compound action content...
		if(code != null){
			// code is a function...
			if(typeof(code) == typeof(function(){})){
				code.apply(this, [c].concat(args))

			// code is an object...
			} else {
				for(var a in code){
					var sargs = code[a]
					sargs = sargs.constructor.name != 'Array' ? [sargs] : sargs
					this[a].apply(this, sargs)
				}
			}
		}

		fireEvent(c, name, args)
		fireEvent(c, name + '.post', args)
		return c
	}
	action.doc = doc == null ? name : doc
	return action
}


// if actions is given this will extend that action object, else a new 
// action object will be created.
//
// names format:
// 	{
// 		// basic action...
// 		<action-name>: <doc>,
//
// 		// compound action...
// 		<action-name>: [<doc>, {
// 			<action-name>: <args>,
// 			...
// 		}],
//
// 		// compound action with a JS function...
// 		<action-name>: [<doc>, 
// 			// this is run in the context of the action set...
// 			// NOTE: this will get the same arguments passed to the action
// 			//		preceded with the action event context.
// 			function(evt_context, ...){
// 				...
// 			}],
//
// 		...
// 	}
//
//
// NOTE: context is dynamic.
var Actions =
module.Action = 
function Actions(context, names, actions, mode){
	actions = actions == null ? {} : actions
	Object.keys(names).forEach(function(e){
		var doc = names[e]
		var code = doc.constructor.name == 'Array' ? doc[1] : null
		doc = code != null ? doc : doc[0]

		actions[e] = Action(context, e, doc, code, mode)
	})
	return actions
}



/*********************************************************************/
//
// Action variables:
//
// 	SCREEN_IMAGES		
// 		- screen width in images
// 		- resolves to number
// 		
// 	CURRENT				
// 		- current image
// 		- resolves to gid
// 		- support basic math: +/-
// 			e.g. CURRENT + 1	~ next image
//
// 	RIBBON				
// 		- current ribbon
// 		- resolves to gid
// 		- support basic math: +/-
//
// 	BASE				
// 		- base ribbon
// 		- resolves to gid
// 		- support basic math: +/-
//
//
// XXX add action variables!!!
var SCREEN_IMAGES = null




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

// XXX need a way to define compound actions...
// 		- compound action is like a normal action with a set of other 
// 			actions chanined to it's main event.
// 		- actions should accept arguments, both optional and required
var BASE_ACTIONS =
module.BASE_ACTIONS = {
	// basic editing...
	shiftImageUp: 
		'Shift image to the ribbon above current, creating one if '
		+'it does not exist',
	shiftImageDown:
		'Shift image to the ribbon below current, creating one if '
		+'it does not exist',
	shiftImageUpNewRibbon: '',
	shiftImageDownNewRibbon: '',
	shiftImageLeft: 'Shift image to the left',
	shiftImageRight: 'Shift image to the right',

	moveRibbonUp: 'Move current ribbon one position up',
	moveRibbonDown: 'Move current ribbon one position down',

	sortImages: '',
	reverseImages: '',
	setAsBaseRibbon: '',

	// image adjustments...
	rotateCW: '',
	rotateCCW: '',
	flipVertical: '',
	flipHorizontal: '',

	// external editors/viewers...
	systemOpen: '',
	openWith: '',

	// crop...
	// XXX should this be here on in a crop pligin...
	cropRibbon: '',
	cropCurrentRibbonAndAbove: '',
	uncropView: 'Uncrop to previous crop',
	uncropAll: 'Uncrop to base',
	uncropViewAndKeepOrder: 
		'Uncrop view to previous crop, keeping current image order',
	uncropAllAndKeepOrder: 'Uncrop to base, keeping current image order',

	openURL: '',
	//openHistory: '',

	saveOrder: '',
	saveState: '',
	exportImages: '',

	exit: '',
}


// XXX think of a better name...
var setupBaseActions =
module.setupBaseActions =
function setupBaseActions(context, actions){
	return Actions(context, BASE_ACTIONS, actions)
}



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

var UI_ACTIONS =
module.UI_ACTIONS = {
	focusImage: '',
	focusRibbon: '',

	// basic navigation...
	nextImage: ['Focus next image in current ribbon', { focusImage: 'next' }],
	nextRibbon: ['Focus next ribbon (down)', { focusRibbon: 'next' }],
	// XXX actions vars...
	nextScreen: ['Show next screen width of images', { focusImage: SCREEN_IMAGES }],

	prevImage: ['Focus previous image in current ribbon', { focusImage: 'prev' }],
	prevRibbon: ['Focus previous ribbon (up)', { focusRibbon: 'prev' }],
	// XXX actions vars...
	prevScreen: ['Show previous screen width of images', { focusImage: -SCREEN_IMAGES }],

	firstImage: 'Focus first image in ribbon',
	lastImage: 'Focus last image in ribbon',

	// zooming...
	zoomIn: 'Zoom in',
	zoomOut: 'Zoom out',

	// NOTE: if this gets a count argument it will fit count images, 
	// 		default is one.
	fitImage: 'Fit image',

	// XXX should these be relative to screen rather than actual image counts?
	fitTwo: ['Fit two images', { fitImage: 2, }],
	fitThree: ['Fit three images', { fitImage: 3, }],
	fitFour: ['Fit four images', { fitImage: 4, }],
	fitFive: ['Fit five images', { fitImage: 5, }],
	fitSix: ['Fit six images', { fitImage: 6, }],
	fitSeven: ['Fit seven images', { fitImage: 7, }],
	fitEight: ['Fit eight images', { fitImage: 8, }],
	fitNine: ['Fit nine images', { fitImage: 9, }],

	fitMax: 'Fit the maximum number of images',

	fitSmall: 'Show small image',
	fitNormal: 'Show normal image',
	fitScreen: 'Fit image to screen',

	// modes...
	singleImageMode: 'Show single image',
	ribbonMode: 'Show ribbon',

	toggleTheme: 'Toggle themes',

	// dialogs...
	// XXX move to specific blocks...
	openDialog: 'Show open diaolg',
	historyDialog: 'Show history dialog',
	cropDialog: 'Show crop dialog',

	// panels...
	togglePanels: '',
	showInfoPanel: '',
	showTagsPanel: '',
	showSearchPanel: '',
	showQuickEditPanel: '',
	showStatesPanel: '',
	showHistoryPanel: '',
	showDirBrowserPanel: '',
	showConsolePanel: '',

	// developer actions...
	showConsole: 'Show application console',
	showDevTools: 'Show development tools',
}


// XXX think of a better name...
var setupUIActions =
module.setupUIActions =
function setupUIActions(context, actions){
	return Actions(context, UI_ACTIONS, actions)
}



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

// Marks actions...
// XXX move to marks.js
var MARKS_ACTIONS =
module.MARKS_ACTIONS = {
	toggleMark: '',
	toggleMarkBlock: '',

	nextMarked: '',
	prevMarked: '',
	nextMarkedInRibbon: '',
	prevMarkedInRibbon: '',

	markRibbon: '',
	unmarkRibbon: '',
	markAll: '',
	unmarkAll: '',
	invertMarkedRibbon: '',
	invertMarkedAll: '',

	// placing...
	placeMarkedAfter: 'Place marked images after current',
	placeMarkedBefore: 'Place marked images before current',

	shiftMarkedUp: '',
	shiftMarkedDown: '',
	shiftMarkedLeft: '',
	shiftMarkedRight: '',
	shiftMarkedUpNewRibbon: '',
	shiftMarkedDownNewRibbon: '',

	cropMarkedImages: '',
	cropMarkedImagesToSingleRibbon: '',

	markDialog: 'Show mark dialog',
	placeMarkedDialog: '',
}

var setupMarksActions = 
module.setupMarksActions = 
function setupMarksActions(context, actions){
	return Actions(context, MARKS_ACTIONS, actions)
}



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

// Bookmarks actions...
// XXX move to bookmarks.js
var BOOKMARKS_ACTIONS =
module.BOOKMARKS_ACTIONS = {
	toggleBookmark: 'Toggle image bookmark',

	nextBookmarked: '',
	prevBookmarked: '',
	nextBookmarkedInRibbon: '',
	prevBookmarkedInRibbon: '',

	bookmarkMarked: 'Bookmark marked images',
	unbookmarkMarked: 'Remove bookmarks from marked images',
	toggleBookmarkMarked: 'Toggle bookmarks on marked images',

	clearRibbonBookmarks: 'Remove bookmarks in ribbon',
	clearAllBookmarks: 'Clear all bookmarks',

	cropBookmarkedImages: '',
	cropBookmarkedImagesToSingleRibbon: '',
}

var setupBookmarksActions =
module.setupBookmarksActions =
function setupBookmarksActions(context, actions){
	return Actions(context, BOOKMARKS_ACTIONS, actions)
}




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