ImageGrid/ui (gen4)/features/ui-widgets.js
Alex A. Naanou fd4b663c1e reworked button placement...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2017-02-08 02:49:15 +03:00

2004 lines
52 KiB
JavaScript
Executable File

/**********************************************************************
*
*
*
**********************************************************************/
((typeof define)[0]=='u'?function(f){module.exports=f(require)}:define)
(function(require){ var module={} // make module AMD/node compatible...
/*********************************************************************/
var keyboard = require('lib/keyboard')
var toggler = require('lib/toggler')
var actions = require('lib/actions')
var features = require('lib/features')
var data = require('imagegrid/data')
var images = require('imagegrid/images')
var ribbons = require('imagegrid/ribbons')
var core = require('features/core')
var base = require('features/base')
var widget = require('lib/widget/widget')
var browse = require('lib/widget/browse')
var overlay = require('lib/widget/overlay')
var drawer = require('lib/widget/drawer')
var browseWalk = require('lib/widget/browse-walk')
/*********************************************************************/
// Format:
// {
// <button-text>: [
// <class>, // optional
// <info>, // optional
// <code>,
// ],
// ...
// }
var makeButtonControls =
module.makeButtonControls =
function(context, cls, data){
cls = cls instanceof Array ? cls : cls.split(/\s+/g)
// remove old versions...
context.ribbons.viewer.find('.'+ cls.join('.')).remove()
// make container...
var controls = $('<div>')
.addClass('buttons '+ cls.join('.'))
.on('mouseover', function(){
var t = $(event.target)
var info = t.attr('info') || t.parents('[info]').attr('info') || ''
context.showStatusBarInfo
&& context.showStatusBarInfo(info)
})
.on('mouseout', function(){
context.showStatusBarInfo
&& context.showStatusBarInfo()
})
// make buttons...
Object.keys(data).forEach(function(k){
// spacer...
if(typeof(data[k]) == typeof('str')
&& /--+/.test(data[k])){
k = '&nbsp;'
var cls = 'spacer'
var doc = ''
var func = function(){}
// normal element...
} else {
var e = data[k].slice()
var code = e.pop()
code = typeof(code) == typeof('str') ?
keyboard.parseActionCall(code)
: code
var func = code instanceof Function ?
code
: function(){
context[code.action].apply(context, code.arguments) }
var cls = e[0] || code.action || ''
var doc = e[1] || code.doc || e[0] || ''
}
controls
.append($('<div>')
.addClass('button ' + cls)
.html(k)
.attr('info', doc)
.click('click', function(){
context.showStatusBarInfo
&& context.showStatusBarInfo()
})
.click(func))
})
controls
.appendTo(context.ribbons.viewer)
}
// XXX write docs:
// - cls can be
// - a single class (str)
// - space separated multiple classes (str)
// - list of classes
// - if cfg is not given then cls[0] is used for it
// - parent can be an element, a getter function or null (defaults to viewer)
var makeButtonControlsToggler =
module.makeButtonControlsToggler =
function(cls, cfg, parent){
cls = cls instanceof Array ? cls : cls.split(/\s+/g)
cfg = cfg || cls[0]
return toggler.Toggler(null,
function(){
parent = parent == null ? this.ribbons.viewer
: parent instanceof Function ? parent.call(this)
: parent
return parent.find('.'+ cls.join('.')).length > 0 ? 'on' : 'off' },
['off', 'on'],
function(state){
if(state == 'on'){
var config = this.config[cfg]
config
&& makeButtonControls(this, cls, config)
} else {
this.ribbons.viewer.find('.'+ cls.join('.')).remove()
}
})
}
// XXX make the selector more accurate...
// ...at this point this will select the first elem with text which
// can be a different elem...
var editItem =
module.editItem =
function(list, elem, callback, options){
return elem
.makeEditable(options
|| {
activate: true,
clear_on_edit: true,
blur_on_abort: false,
blur_on_commit: false,
})
.on('edit-commit', callback || function(){})
.on('edit-abort edit-commit', function(_, text){
list.update()
// XXX make the selector more accurate...
// ...at this point this will select the first elem
// with text which can be a different elem...
.then(function(){ list.select(elem.text()) })
})
}
//---------------------------------------------------------------------
// Edit list in .config...
//
// This will update value_path in .config with the opened item value.
//
var makeConfigListEditor =
module.makeConfigListEditor =
function(actions, path, value_path, options){
path = path.split('.')
var key = path.pop()
options = options ? Object.create(options) : {}
var stateValue = function(value){
var path = value_path instanceof Function ?
value_path(value)
: value_path.split('.')
var key = path.pop()
var target = actions.config
path.forEach(function(p){
target = target[p] = target[p] || {}
})
if(value){
target[key] = value
} else {
return target[key]
}
}
var save = function(value){
stateValue(value)
dialog.close()
}
if(value_path
&& (options.overflow == null
|| options.overflow == 'save')){
options.overflow = save
}
// set the path...
if(value_path && !options.path){
options.path = stateValue()
}
var dialog = browse.makeListEditor(function(lst){
var target = actions.config
path.forEach(function(p){
target = target[p] = target[p] || {}
})
// get...
if(lst === undefined){
return target[key]
// set...
} else {
target[key] = lst
}
}, options)
value_path
&& dialog.open(function(){
save(dialog.selected)
})
return dialog
}
// Wrapper around makeListEditor(..) enabling it to be used as an event
// item handler...
//
// For example this returns a function directly usable as list item event
// handler...
//
// NOTE: this will select the element in the parent dialog via it's first
// .text element...
var makeNestedConfigListEditor =
module.makeNestedConfigListEditor =
function(actions, list, list_key, value_key, options){
options = options || {}
return function(){
var txt = $(this).find('.text').first().text()
var dfl_options = {
path: value_key instanceof Function ?
value_key()
: actions.config[value_key],
// NOTE: this is called when adding a new value and
// list maximum length is reached...
overflow: 'save',
}
options.__proto__ = dfl_options
var o = makeConfigListEditor(actions, list_key, value_key, options)
// update parent menu...
.open(function(){
list
&& list.update()
.then(function(){
txt != ''
&& list.select(txt)
})
})
actions.Overlay(o)
return o
}
}
/*********************************************************************/
// Dialogs and containers...
// Mark an action as a container...
//
// NOTE: the marked action must comply with the container protocol
// (see: makeUIContainer(..) for more info)
var uiContainer =
module.uiContainer = function(func){
func.__container__ = true
return func
}
// Make a container constructor wrapper...
//
// This will:
// - mark the action as a container
//
// The container will:
// - trigger the client's close event on close
//
// XXX not sure how the click is handled here...
// XXX pass options???
var makeUIContainer =
module.makeUIContainer = function(make){
return uiContainer(function(){
var that = this
var o = make.apply(this, arguments)
o
// notify the client that we are closing...
.close(function(evt, mode){ o.client.trigger('close', mode) })
.client
// NOTE: strictly this is the responsibility of the client
// but it is less error prone to just in case also do
// this here...
.on('close', function(evt){ evt.stopPropagation() })
// Compensate for click focusing the parent dialog when
// a child is created...
// XXX is this the right way to go???
.on('click', function(evt){
that.modal && that.modal.focus() })
return o
})
}
// Mark action as a dialog...
//
var uiDialog =
module.uiDialog = function(func){
func.__dialog__ = true
return func
}
// Make a dialog constructor wrapper...
//
// Make a dialog action...
// makeUIDialog(constructor)
// makeUIDialog(constructor, ...)
// -> dialog
//
// Make a dialog action with a specific default container...
// makeUIDialog(container, constructor)
// makeUIDialog(container, constructor, ...)
// -> dialog
//
//
// This dialog will:
// - consume the first action argument if it's a container name to
// override the default container...
// - if no container defined explicitly the default container is used
//
//
// NOTE: arguments after the constructor will be passed to the container.
//
// XXX do we need a means to reuse containers, e.g. ???
var makeUIDialog =
module.makeUIDialog = function(a, b){
var args = [].slice.call(arguments)
// container name (optional)...
var dfl = typeof(args[0]) == typeof('str') ?
args.shift()
: null
// constructor...
var make = args.shift()
// rest of the args to be passed to the container...
var cargs = args
return uiDialog(function(){
var args = [].slice.call(arguments)
// see if the first arg is a container spec...
var container = this.isUIContainer(args[0]) ?
args.shift()
: (dfl || this.config['ui-default-container'] || 'Overlay')
var dialog = make.apply(this, args)
if(!dialog){
return dialog
}
return this[container].apply(this,
[dialog].concat(cargs))
.client
})
}
var makeDrawer = function(direction){
return makeUIContainer(function(dialog, options){
var that = this
options = options || {}
var parent = options.parentElement
parent = parent ? $(parent) : this.ribbons.viewer
options.direction = direction || 'bottom'
var d = drawer.Drawer(parent, dialog, options)
// focus top modal on exit...
.on('close', function(){
var o = that.modal
o && o.focus()
})
// we need to clear other ui elements, like the status bar...
// XXX is this the right way to go???
d.dom.css({
'z-index': 5000,
})
return d
})
}
//---------------------------------------------------------------------
var DialogsActions = actions.Actions({
config: {
'ui-default-container': 'Overlay',
'ui-overlay-blur': 'on',
// used by UI to set the user confirm action timeout...
'ui-confirm-timeout': 2000,
},
// introspection...
get uiContainers(){
return this.actions.filter(this.isUIContainer.bind(this)) },
get uiDialogs(){
return this.actions.filter(this.isUIDialog.bind(this)) },
get uiElements(){
return this.actions.filter(this.isUIElement.bind(this)) },
// XXX this knows about action priority and shortcut marker...
// XXX should these be more like .getDoc(..) and support lists of actions???
getDocPath: ['- Interface/',
function(action, clean, join){
clean = clean == null ? true : clean
join = join == null ? '/' : join
var path = (this.getDoc(action)[action].shift() || action)
path = clean ? path.replace(/^- /, '') : path
path = path
.split(/[\\\/]/g)
// remove priority...
.map(function(e){
return clean ?
e
.replace(/^[-+]?[0-9]+:\s*/, '')
.replace(/\$(\w)/g, '$1')
: e })
return join ? path.join('/') : path
}],
getDocBaseDir: ['- Interface/',
function(action, clean, join){
clean = clean == null ? true : clean
join = join == null ? '/' : join
var path = this.getDocPath(action, clean, false)
// drop the title...
.slice(0, -1)
return join ? path.join('/') : path
}],
getDocTitle: ['- Interface/',
function(action, clean){
clean = clean == null ? true : clean
return this.getDocPath(action, clean, false).pop()
}],
// Get modal container...
//
// Protocol:
// - get the last (top) modal widgets (CSS selector: .modal-widget)
// - return one of the following:
// .data('widget-controller')
// element
// null
get modal(){
var modal = this.ribbons.viewer
.find('.modal-widget')
.last()
return modal.data('widget-controller')
|| (modal.length > 0 && modal)
|| null
},
// testers...
isUIContainer: ['- Interface/',
actions.doWithRootAction(function(action){
return action != null
&& action.__container__ == true })],
isUIDialog: ['- Interface/',
actions.doWithRootAction(function(action){
return action != null
&& action.__dialog__ == true })],
isUIElement: ['- Interface/',
actions.doWithRootAction(function(action){
return action != null
&& (action.__dialog__ == true || action.__container__ == true) })],
// container constructors...
Overlay: ['- Interface/',
makeUIContainer(function(dialog, options){
var that = this
return overlay.Overlay(this.ribbons.viewer, dialog, options)
// focus top modal on exit...
.on('close', function(){
var o = that.modal
o && o.focus()
})
})],
Drawer: ['- Interface/',
makeDrawer('bottom')],
BottomDrawer: ['- Interface/',
makeDrawer('bottom')],
TopDrawer: ['- Interface/',
makeDrawer('top')],
// like panel but drop down from mouse location or specified position
DropDown: ['- Interface/',
makeUIContainer(function(dialog, options){
// XXX
console.error('Not yet implemented.')
})],
// XXX STUB -- need a real panel with real docking and closing
// ability...
// XXX need to:
// - dock panels
// - save panel state (position, collapse, dock, ...)
// - restore panel state
Panel: ['- Interface/',
makeUIContainer(function(dialog, options){
// XXX
//console.error('Not yet implemented.')
// minimal container...
var panel = {
client: dialog,
dom: $('<div>')
.append(dialog.dom || dialog)
.appendTo(this.ribbons.viewer)
.draggable(),
close: function(func){
if(func){
this.dom.on('close', func)
} else {
this.dom.trigger('close', 'reject')
this.dom.remove()
}
return this
},
}
dialog.on('blur', function(){
panel.close('reject')
})
return panel
})],
// Helper for creating lists fast...
showList: ['- Interface/',
core.doc`Show list dialog...
.showList(<list>, <options>)
-> dialog
See browse.makeList(..) / browse.Items.List(..) for more info.
`,
makeUIDialog(function(list, options){
return browse.makeList(null, list, options) })],
showActionList: ['- Interface/',
core.doc`Show list of actions dialog...
.showActionList(<list>, <options>)
-> dialog
Like .showList(..) but understands keyboard.parseActionCall(..) syntax,
Options format:
{
// arguments and what to replace them with, this is used
// to define templates in the list and pass real values
// via the dict.
args_dict: {
<arg>: <value>,
...
},
// Same format .showList(..) understands...
...
}
`,
makeUIDialog(function(list, options){
var that = this
list = list instanceof Function ? list.call(this) : list
options = options || {}
var args_dict = options.args_dict || {}
var loaders = {}
list.forEach(function(m){
var a = keyboard.parseActionCall(m)
if(a.action in that){
var args = a.arguments
.map(function(a){
return args_dict[a] !== undefined ?
args_dict[a]
: a })
// the callback...
loaders[a.doc != '' ?
a.doc
: that.getDocTitle(a.action)] =
function(){
return that[a.action].apply(that, args) }
// non-actions...
} else {
loaders[m] = null
}
})
return browse.makeList(null, loaders, options)
})],
// Show doc for action...
//
// XXX STUB...
// XXX this needs to:
// - be a widget
// - handle focus
// - handle keyboard
// - handle search...
// - format action links/references...
// - markdown???
// - ...
// XXX use pWiki???
// XXX should we have navigation???
// ...i.e. opening links is done in the viewer and we have
// ability to go back and forth...
showDoc: ['Help/Action help...',
makeUIDialog(function(actions){
var that = this
actions = actions || this.actions.sort()
actions = actions instanceof Array ? actions : [actions]
var doc = this.getDoc(actions)
var res = $('<div>')
.addClass('help-dialog')
actions.forEach(function(action){
res.append($('<div class="action">')
.prop('tabindex', true)
.append($('<h2>')
.text(doc[action][2]))
.append($('<i>')
.text(doc[action][0]))
.append($('<div>')
.text('Features: '
+ that.getHandlerSourceTags(action)
.join(', ')))
.append($('<hr>'))
// parse the action doc...
.append($('<pre>')
.html((doc[action][1] || '')
// html stuff...
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
// normalize tabs -- convert tabs and tabbed
// spaces into 4 spaces...
// NOTE: the code internally uses only tabs,
// but this will help make the view
// consistent.
.replace(/ {0,3}\t/g, ' ')
// comments...
.replace(/(\/\/.*)\n/g, '<span class="comment">$1</span>\n')
// notes...
.replace(/NOTE:/g, '<b>NOTE:</b>')
.replace(/XXX/g, '<span class="warning">XXX</span>')
// action links...
.replace(/(\s)(\.([\w_]+[\w\d_]*)\([^)]*\))/g,
function(match, a, b, c){
return c == action ?
`${a}<i>${b}</i>`
: `${a}<a href="#" onclick="ig.showDoc('${c}')">${b}</a>`
})
)))
})
return res
})],
listDialogs: ['Interface/Dialog/Dialog list...',
makeUIDialog(function(){
var actions = this
return browse.makeLister(null, function(path, make){
var that = this
actions.uiDialogs.forEach(function(dialog){
var doc = actions.getDoc(dialog)[dialog][0]
var txt = ((doc
.split(/[\\\/]/g)
.pop() || ('.'+ dialog +'(..)'))
// mark item as disabled...
+ (/^- .*$/.test(doc) ? ' (disabled)' : ''))
.replace(/^-?[0-9]+\s*:\s*/, '')
.trim()
make(txt)
.on('open', function(){
actions[dialog]()
})
})
make.done()
})
})],
toggleOverlayBlur: ['Interface/Dialog overlay blur',
toggler.CSSClassToggler(
function(){ return this.ribbons.viewer },
'overlay-blur-enabled',
function(state){ this.config['ui-overlay-blur'] = state }) ],
})
var Dialogs =
module.Dialogs = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-dialogs',
depends: [
'ui',
],
actions: DialogsActions,
handlers: [
['start',
function(){
this.config['ui-overlay-blur']
&& this.toggleOverlayBlur(this.config['ui-overlay-blur'])
}],
['__call__',
function(res, action){
//if(res instanceof jQuery || res instanceof widget.Widget){
// var elem = (res.dom || res)
if(res instanceof widget.Widget){
var elem = res.dom
!elem.attr('keep-dialog-title')
&& !this.getActionAttr(action, 'keepDialogTitle')
&& elem.attr('dialog-title', this.getDocTitle(action))
}
}],
],
})
/*********************************************************************/
// NOTE: yes, this is a funny name ;)
//
// XXX should we also add a hide-path config feature???
var BrowseActionsActions = actions.Actions({
config: {
'action-category-order': [
'99:$File',
// NOTE: we can order any sub-tree we want in the same
// manner as the root...
'File/-80:Clear viewer',
'File/-90:Close viewer',
// NOTE: non existing elements will not get drawn...
//'File/-99:moo',
'80:$Edit',
'70:$Navigate',
'60:$Image',
'50:$Ribbon',
'40:$Crop',
'Crop/80:Crop $marked images',
'Crop/80:Crop $bookmarked images',
// NOTE: we can also add separators here...
//'Crop/70:---',
'Crop/60:$Crop',
'Crop/50:$Flatten',
// ...
'Crop/-80:Uncrop and keep crop image order',
'Crop/-81:Uncrop all',
'Crop/-82:$Uncrop',
// ...
'-40:Interface',
'-50:$Workspace',
'-60:System',
'-70:$Help',
'-80:---',
'-90:Development',
'-90:Test',
],
'browse-actions-settings': {
showDisabled: true,
showHidden: false,
showEmpty: false,
},
'browse-actions-keys': true,
'browse-actions-shortcut-marker': '\\$(\\w)',
},
// Browse actions dialog...
//
// This uses action definition to build and present an action tree.
//
// This supports the following element syntax:
// - leading '- ' in path to indicate a hidden/disabled element.
// Example:
// '- Path/To/Element' (disabled/hidden)
// 'Path/To/Other element' (enabled)
//
// - leading path element number followed by colon to indicate
// element priority on level.
// Example:
// 'Path/99: To/50:Element'
// NOTE: multiple path elements may have multiple priorities.
// NOTE: an item with positive priority will be above and item
// with less or no priority.
// NOTE: an item with negative priority will be below any item
// with greater or no priority.
//
//
// Action mode (disabled/hidden) and also be controlled dynamically:
// - .browseMode() action method is called with actions as base.
// Example:
// someAction: ['Path/To/Some action',
// {browseMode: function(){ ... }},
// function(){
// ...
// }],
// someOtherAction: ['Path/To/Some action',
// // alias
// {browseMode: 'someAction'},
// function(){
// ...
// }],
//
// .browseMode can be:
// <function> - action method.
// <action-name> - alias, name of action to get the
// method from.
//
// .browseMode() can return:
// 'disabled' - item will be disabled.
// 'hidden' - item will be both hidden and disabled.
//
// NOTE: disabling in path has priority over .browseMode(), thus
// it is possible to hide/disable an enabled item but not
// possible to enable a disabled by default path.
// NOTE: .browseMode() can be defined in any action in chain,
// though only the last one is called...
//
//
// options format:
// {
// callback: <function>,
// no_disabled: false,
// no_hidden: false,
// }
//
//
// NOTE: if the action returns an instance of overlay.Overlay this
// will not close right away but rather bind to:
// overlay.close -> self.focus()
// overlay.client.open -> self.close()
// NOTE: we are not using the browse.PathList(..) here as we need
// custom controls and special path handling...
// NOTE: this will keep the first instance title it encounters, this
// if a later instance includes a priority, it will be ignored.
// This may happen if several actions are in the same path and
// each one set a different priority in that path...
// ...to avoid this use .config['action-category-order'] to set
// base order/priorities...
//
// XXX can we do a deep search on '/' -- find any nested action???
browseActions: ['Interface/Dialog/Actions...',
makeUIDialog(function(path, options){
var actions = this
var priority = /^(-?[0-9]+)\s*:\s*/
var marker = RegExp(this.config['browse-actions-shortcut-marker'], 'g')
marker = marker || RegExp(marker, 'g')
var dialog
options = options || {}
// prepare the config...
var cfg = {
cls: 'browse-actions',
path: path,
flat: false,
traversable: true,
pathPrefix: '/',
fullPathEdit: true,
item_shortcut_marker: marker,
}
cfg.__proto__ = this.config['browse-actions-settings']
// get keys for each action...
var keys = this.getKeysForAction ? this.getKeysForAction() : {}
// Get keys for action...
var getKeys = function(action){
return (keys[action] || []).join(' / ') }
// Get item from tree level taking into account additional
// syntax like prioority...
// returns:
// [<existing-text>, <new-level>]
var getItem = function(level, text){
// direct match...
if(text in level){
return [text, level[text]]
// check if it's a priority path...
} else {
for(var e in level){
var n = e.replace(priority, '')
n = (marker ? n.replace(marker, '$1') : n).trim()
if(n == text){
return [e, level[e]]
}
}
}
return []
}
// Get action browse mode (disabled or hidden)...
var getMode = function(action){
var m = action
var visited = [m]
// handle aliases...
do {
m = actions.getActionAttr(m, 'browseMode')
// check for loops...
if(m && visited[m] != null){
m = null
break
}
visited.push(m)
} while(typeof(m) == typeof('str'))
return m ? m.call(actions) : undefined
}
// Wait for dialog...
var waitFor = (function(child){
// we got a widget, wait for it to close...
if(child instanceof widget.Widget){
child
.on('close', function(evt, reason){
reason != 'reject'
&& dialog.close(reason) })
// if it's not a dialog, don't wait...
} else {
dialog.close()
}
return child
}).bind(this)
// Tree builder...
// XXX normalize actions -- whitespace, '!', args...
var buildTree = function(path, leaf, action, mode, tree){
path = path.slice()
// build leaf...
if(path.length == 0){
leaf.split(/\|/g)
.forEach(function(leaf){
var l = getItem(tree, leaf)[0]
tree[l || leaf] = action != null ? [action, mode] : action
})
return
}
// build alternative paths...
var p = path.shift() || ''
p.split(/\|/g)
.forEach(function(e){
// build branch element...
var branch = getItem(tree, e)
branch = tree[branch[0] || e] = branch[1] || {}
// build sub-branch...
buildTree(path, leaf, action, mode, branch)
})
}
// Action tree...
//
// Format:
// {
// <name>: <tree>,
//
// <name>: [
// <action-name>,
// // mode...
// 'disabled' | 'hidden',
// ],
//
// ...
// }
//
// NOTE: this is created once per call, so to refresh the
// actions tree we'll need to re-open the dialog...
var tree = {}
// pre-order the main categories...
// NOTE: pre_order can be a list of long paths...
var pre_order = this.config['action-category-order'] || []
pre_order.forEach(function(key){
var path = key.split(/[\\\/]/g)
var leaf = path.pop()
buildTree(path, leaf, null, null, tree)
})
// build the tree...
var paths = this.getPath()
Object.keys(paths).forEach(function(key){
// handle mode flag...
var action = paths[key][0]
var mode = key.split(/^- /)
var path = mode.pop()
mode = mode.length > 0 ? 'hidden' : null
path = path.split(/[\\\/]/g)
var leaf = path.pop()
buildTree(path, leaf, action, mode, tree)
})
//console.log('!!!!', tree)
// now for the dialog...
dialog = browse.makeLister(null, function(path, make){
var that = this
var cur = tree
// get level...
// NOTE: we need to get the level till first '*'...
// NOTE: this needs to account for leading priority of
// an element...
var rest = path.slice()
while(rest.length > 0 && !('*' in cur)){
cur = getItem(cur, rest.shift()).pop() || {}
}
// render current level...
// NOTE: we can be at one of several level types, each
// is rendered in a different way...
// Level: toggler states -- get states and list them...
if(cur instanceof Array
&& actions.isToggler && actions.isToggler(cur[0])){
var action = cur[0]
var mode = cur[1]
// handle live modes...
mode = mode || getMode(action)
var cur_state = actions[action]('?')
var states = actions[action]('??')
// handle on/off togglers...
// XXX should the toggler directly return 'on'/'off'???
if(states.length == 2
&& states.indexOf('none') >= 0
&& (cur_state == 'on' || cur_state == 'off')){
states = ['on', 'off']
}
// build toggler states...
states.forEach(function(state){
make(state, {
// NOTE: if something is hidden
// it is also disabled...
// ...this is by design.
disabled: options.no_disabled ?
false
: (mode == 'hidden' || mode == 'disabled'),
hidden: options.no_hidden ?
false
: mode == 'hidden',
})
// XXX need to normalize state -- comments, whitespace, etc...
.attr('keys', getKeys(action +': "'+ state +'"'))
.addClass([
state == cur_state ? 'selected highlighted' : '',
mode == 'hidden' ? mode : ''
].join(' '))
.on('open', function(){
options.callback ?
options.callback.call(actions, action)
: actions[action](state)
that.pop()
})
})
// Level: lister -- hand control to lister...
// NOTE: path might be a partial path, the rest of it is
// handled by the lister...
} else if('*' in cur){
actions[cur['*'][0]](path, make)
// Level: normal -- list actions...
} else {
var level = Object.keys(cur)
level
.slice()
// sort according to item priority: 'NN: <text>'
// NN > 0 - is sorted above the non-prioritized
// elements, the greater the number
// the higher the element
// NN < 0 - is sorted below the non-prioritized
// elements, the lower the number
// the lower the element
.sort(function(a, b){
var ai = priority.exec(a)
ai = ai ? ai.pop()*1 : null
ai = ai > 0 ? -ai
: ai < 0 ? -ai + level.length
: level.indexOf(a)
var bi = priority.exec(b)
bi = bi ? bi.pop()*1 : null
bi = bi > 0 ? -bi
: bi < 0 ? -bi + level.length
: level.indexOf(b)
return ai - bi
})
.forEach(function(key){
// remove the order...
var text = key.replace(priority, '').trim()
// Item: action...
if(cur[key] instanceof Array){
var action = cur[key][0]
var mode = cur[key][1]
// handle live modes...
mode = mode || getMode(action)
// Action: toggler -> add toggle button...
if(actions.isToggler && actions.isToggler(action)){
make(text + '/', {
// NOTE: if something is hidden
// it is also disabled...
// ...this is by design.
disabled: options.no_disabled ?
false
: (mode == 'hidden' || mode == 'disabled'),
hidden: options.no_hidden ?
false
: mode == 'hidden',
buttons: [
[actions[action]('?'),
function(){
actions[action]()
that.update()
that.select('"'+ text +'"')
}],
//[getKeys(action)],
]})
.attr({
keys: getKeys(action),
action: action,
})
.addClass(mode == 'hidden' ? mode : '')
.on('open', function(){
options.callback ?
options.callback.call(actions, action)
: actions[action]()
that.update()
that.select('"'+ text +'"')
})
// Action: normal...
} else {
make(text, {
// NOTE: if something is hidden
// it is also disabled...
// ...this is by design.
disabled: options.no_disabled ?
false
: (mode == 'hidden' || mode == 'disabled'),
hidden: options.no_hidden ?
false
: mode == 'hidden',
})
.attr({
keys: getKeys(action),
action: action,
})
.on('open', function(){
options.callback ?
options.callback.call(actions, action)
: waitFor(actions[action]())
})
}
// Item: dir...
} else if(actions.config['browse-actions-settings'].showEmpty
|| (cur[key] != null
&& Object.keys(cur[key]).length > 0)){
var p = '/'+ path.concat([text]).join('/') +'/'
p = marker ? p.replace(marker, '$1') : p
make(text + '/', { push_on_open: true })
.attr({
keys: [
getKeys('browseActions: "'+ p +'"'),
getKeys('browseActions!: "'+ p +'"'),
].filter(function(e){ return e.trim() != '' }).join(' / '),
})
// item: line...
} else if(text == '---'){
make(text)
}
})
}
},
cfg)
// save show disabled state to .config...
.on('close', function(){
var config = actions.config['browse-actions-settings']
config.showDisabled = dialog.options.showDisabled
config.showHidden = dialog.options.showHidden
})
this.config['browse-actions-keys']
&& dialog.dom.addClass('show-keys')
// handle '?' button to browse path...
dialog.showDoc = function(){
var action = dialog.select('!').attr('action')
action
&& actions.showDoc(action)
}
dialog.keyboard.handler('General', '?', 'showDoc')
return dialog
})],
toggleBrowseActionKeys: ['Interface/Show keys in menu',
core.makeConfigToggler(
'browse-actions-keys',
[true, false],
function(state){
this.modal.client.dom.hasClass('browse-actions')
&& this.modal.client.dom[state ? 'addClass' : 'removeClass']('show-keys')
})],
})
var BrowseActions =
module.BrowseActions = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-browse-actions',
depends: [
'ui',
'ui-dialogs',
],
suggested: [
'keyboard',
],
actions: BrowseActionsActions,
})
//---------------------------------------------------------------------
var ContextActionMenu =
module.ContextActionMenu = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-context-action-menu',
depends: [
'ui-browse-actions',
],
handlers: [
['updateImage',
function(){
var that = this
var img = this.ribbons.getImage(gid)
!img.data('context-menu')
&& img
.data('context-menu', true)
.on('contextmenu', function(){
event.preventDefault()
event.stopPropagation()
that.browseActions('/Image/')
})
}],
['load',
function(){
var that = this
var viewer = this.ribbons.viewer
!viewer.data('context-menu')
&& viewer
.data('context-menu', true)
.on('contextmenu', function(){
event.preventDefault()
event.stopPropagation()
that.browseActions()
})
}],
],
})
//---------------------------------------------------------------------
var ButtonsActions = actions.Actions({
config: {
'main-buttons-state': 'on',
'main-buttons': {
'&#x2630;': ['menu', 'browseActions -- Action menu...'],
'C<sub/>': ['crop', 'browseActions: "Crop/" -- Crop menu...'],
//'M': ['marks', 'browseActions: "Mark/" -- Mark menu...'],
//'<i>ImageGrid.Viewer</i>': ['title', ''],
//'t': ['touch', 'toggleSideButtons -- Toggle touch ui'],
//'&#9965;': ['ui-settings', 'browseActions: "Interface/" -- Interface settings...'],
},
// XXX not sure about these yet...
'secondary-buttons-state': 'off',
'secondary-buttons': {
//'Z<sub/>': ['zoom', 'browseActions: "Zoom/" -- Zoom menu...'],
//'+': ['zoom-in', 'zoomIn -- Zoom in'],
//'-': ['zoom-out', 'zoomOut -- Zoom out'],
//'&#9965;': ['ui-settings', 'browseActions: "Interface/" -- Interface settings...'],
},
'app-buttons': {
'&#9965;': ['ui-settings', 'browseActions: "Interface/" -- Interface settings...'],
},
'side-buttons-state': 'off',
'side-buttons-left': {
'-': ['zoom-out', 'zoomOut -- Zoom out'],
'&#8613;': ['up', 'shiftImageUp -- Shift image up'],
'&#10633;': ['left', 'prevImage -- Previous image'],
'&#8615;': ['down', 'shiftImageDown -- Shift image down'],
},
'side-buttons-right': {
'+': ['zoom-in', 'zoomIn -- Zoom in'],
'&#8613;': ['up', 'shiftImageUp -- Shift image up'],
'&#10634;': ['right', 'nextImage -- Next image'],
'&#8615;': ['down', 'shiftImageDown -- Shift image down'],
},
},
toggleMainButtons: ['Interface/Main buttons',
makeButtonControlsToggler('main-buttons')],
toggleSecondaryButtons: ['Interface/Secondary buttons',
makeButtonControlsToggler('secondary-buttons')],
toggleAppButtons: ['Interface/App buttons',
makeButtonControlsToggler('app-buttons')],
toggleSideButtons: ['Interface/Side buttons',
(function(){
var left = makeButtonControlsToggler('side-buttons-left')
var right = makeButtonControlsToggler('side-buttons-right')
return core.makeConfigToggler('side-buttons-state',
['on', 'off'],
function(){
left.apply(this, arguments)
right.apply(this, arguments)
})
})()],
})
var Buttons =
module.Buttons = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-buttons',
depends: [
'ui',
],
suggested: [
// needed for reporting info in .makeButtonControls(..)
'ui-status-bar',
],
actions: ButtonsActions,
handlers: [
['start.pre',
function(){
this.toggleAppButtons('on')
}],
// NOTE: these need to be loaded AFTER the .config has been loaded...
['start',
function(){
this.toggleMainButtons(this.config['main-buttons-state'] || 'on')
this.toggleSecondaryButtons(this.config['secondary-buttons-state'] || 'on')
this.toggleSideButtons(this.config['side-buttons-state'] || 'on')
}],
// update crop button status...
['load clear reload',
function(){
$('.main-buttons.buttons .crop.button sub')
.text(this.crop_stack ? this.crop_stack.length : '') }],
// update zoom button status...
['setScale',
function(){
$('.secondary-buttons.buttons .zoom.button sub')
.text(Math.round(this.screenwidth)) }],
],
})
//---------------------------------------------------------------------
// XXX make this not applicable to production...
var WidgetTestActions = actions.Actions({
testAction: ['Test/Test action',
function(){
console.log('>>>', [].slice.call(arguments))
return function(){
console.log('<<<', [].slice.call(arguments)) }}],
// Usage Examples:
// .testDrawer() - show html in base drawer...
// .testDrawer('Header', 'paragraph') - show html with custom text...
// .testDrawer('Overlay') - show html in overlay...
// .testDrawer('Overlay', 'Header', 'paragraph')
// - show html in overlay with
// custom text...
testDrawer: ['Test/99: D$rawer widget test...',
makeUIDialog('Drawer',
function(h, txt){
return $('<div>')
.css({
position: 'relative',
background: 'white',
height: '300px',
padding: '20px',
})
.append($('<h1>')
.text(h || 'Drawer test...'))
.append($('<p>')
.text(txt || 'With some text.'))
},
// pass custom configuration to container...
{
background: 'white',
focusable: true,
})],
// XXX show new features...
testBrowse: ['Test/-99: Demo $new style dialog...',
makeUIDialog(function(){
var actions = this
console.log('>>> args:', [].slice.call(arguments))
return browse.makeLister(null, function(path, make){
var that = this
make('select last')
.on('open', function(){
that.select(-1)
})
make('do nothing')
.addClass('selected')
make('nested dialog...',
{
shortcut_key: 'n',
})
.on('open', function(){
actions.testBrowse()
})
make('---')
make('$close parent')
.on('open', function(){
that.parent.close()
})
make('...')
// NOTE: the dialog's .parent is not yet set at this point...
// This will finalize the dialog...
//
// NOTE: this is not needed here as the dialog is drawn
// on sync, but for async dialogs this will align
// the selected field correctly.
make.done()
})
// NOTE: this is not a dialog event, it is defined by the
// container to notify us that we are closing...
.on('close', function(){
console.log('Dialog closing...')
})
})],
testBrowseCloud: ['Test/Demo $cloud dialog...',
makeUIDialog(function(){
var actions = this
console.log('>>> args:', [].slice.call(arguments))
return browse.makeLister(null, function(path, make){
var that = this
var words = 'Lorem ipsum dolor sit amet, audiam sensibus '
+'an mea. Accusam blandit ius in, te magna dolorum '
+'moderatius pro, sit id dicant imperdiet definiebas. '
+'Ad duo quod mediocrem, movet laudem discere te mel, '
+'sea ipsum habemus gloriatur at. Sonet prodesset '
+'democritum in vis, brute vitae recusabo pri ad, '
+'--- '
+'latine civibus efficiantur at his. At duo lorem '
+'legimus, errem constituam contentiones sed ne, '
+'cu has corpora definitionem.'
var res = []
words
.split(/\s+/g)
.unique()
.forEach(function(c){
var e = make(c)
// toggle opacity...
.on('open', function(){
var e = $(this).find('.text')
e.css('opacity',
e.css('opacity') == 0.3 ? '' : 0.3)
})
res.push(e[0])
})
$(res).parent()
.append($('<div>')
.sortable()
.append($(res)))
make.done()
},
// make the dialog a cloud...
{ cloudView: true })
// NOTE: this is not a dialog event, it is defined by the
// container to notify us that we are closing...
.on('close', function(){
console.log('Dialog closing...')
})
})],
testBrowsrItems: ['Test/-99: Demo browse $items...',
makeUIDialog(function(){
var actions = this
var editable_list = ['x', 'y', 'z']
return browse.makeLister(null, function(path, make){
var that = this
make.Heading('Heading:', {
doc: 'Heading doc string...',
})
make.Group([
make('Normal item'),
// this is the same as make('...')
make.Separator(),
make.Editable('Editable (Select to edit)'),
make.Editable('Editable (Enter to edit, cleared)...', {
start_on: 'open',
clear_on_edit: true,
}),
])
make.Heading('List:')
make.List(['a', 'b', 'c'])
make.Heading(' Editable list:')
make.EditableList(editable_list)
make.Heading('More:')
make.Action('Editable list demos...')
.on('open', function(){ actions.testList() })
make.Action('Pinned list demo...')
.on('open', function(){ actions.testPinnedList() })
// NOTE: the dialog's .parent is not yet set at this point...
// This will finalize the dialog...
//
// NOTE: this is not needed here as the dialog is drawn
// on sync, but for async dialogs this will align
// the selected field correctly.
make.done()
})
// NOTE: this is not a dialog event, it is defined by the
// container to notify us that we are closing...
.on('close', function(){
})
})],
testList: ['Test/-99: Demo $lists editors in dialog...',
makeUIDialog(function(){
var actions = this
// NOTE: passing things other than strings into a list editor
// is not supported...
var numbers = ['1', '2', '3', '4']
var letters = ['a', 'b', 'c', 'd']
return browse.makeLister(null, function(path, make){
var that = this
make.Heading('Numbers:', {
doc: 'List editor with all the buttons enabled...',
})
make.EditableList(numbers, {
list_id: 'numbers',
item_order_buttons: true,
to_top_button: true,
to_bottom_button: true,
})
make.Heading('Letters:', {
doc: 'Sortable list, use sort handle to the right to sort...'
})
make.EditableList(letters, {
list_id: 'letters',
sortable: 'y',
})
// NOTE: the dialog's .parent is not yet set at this point...
// This will finalize the dialog...
//
// NOTE: this is not needed here as the dialog is drawn
// on sync, but for async dialogs this will align
// the selected field correctly.
make.done()
})
// NOTE: this is not a dialog event, it is defined by the
// container to notify us that we are closing...
.on('close', function(){
console.log(core.doc`Lists:
- Numbers: ${numbers.join(', ')}
- Letters: ${letters.join(', ')}`)
})
})],
testPinnedList: ['Test/-99: Demo $pinned lists in dialog...',
makeUIDialog(function(){
var actions = this
// NOTE: passing things other than strings into a list editor
// is not supported...
var pins = ['b', 'a']
var letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
return browse.makeLister(null, function(path, make){
var that = this
make.Heading('Numbers:', {
doc: 'List editor with all the buttons enabled...',
})
make.EditablePinnedList(letters, pins, {
list_id: 'letters',
//pins_sortable: false,
buttons: [
'UP',
'TO_BOTTOM',
],
})
// NOTE: the dialog's .parent is not yet set at this point...
// This will finalize the dialog...
//
// NOTE: this is not needed here as the dialog is drawn
// on sync, but for async dialogs this will align
// the selected field correctly.
make.done()
})
// NOTE: this is not a dialog event, it is defined by the
// container to notify us that we are closing...
.on('close', function(){
console.log(core.doc`Lists:
- Pins: ${pins.join(', ')}
- Letters: ${letters.join(', ')}`)
})
})],
testProgress: ['Test/Demo $progress bar...',
function(text){
var done = 0
var max = 10
var text = text || 'Progress bar demo'
var that = this
this.showProgress(text)
var step = function(){
that.showProgress(text, done++, max)
max = done < 8 ? max + 5
: max <= 50 && done < 30 ? max + 2
: done > 30 ? max - 3
: max
// NOTE: we add 10 here to compensate for changing max value...
done < max+10
&& setTimeout(step, 200)
}
setTimeout(step, 1000)
}],
// XXX make this a toggler....
partitionByMonth: ['Test/',
function(){
var that = this
this.toggleImageSort('?') != 'Date' && this.sortImages('Date')
this.on('updateImage', function(_, gid){ this.placeMonthPartition(gid) })
}],
// XXX this should be .updateImage(..) in a real feature...
placeMonthPartition: ['Test/',
function(image){
var month = [
'January', 'February', 'March', 'April',
'May', 'June', 'July', 'August',
'September', 'October', 'November', 'December'
]
var gid = this.data.getImage(image)
var next = this.data.getImage(gid, 'next')
cur = this.images[gid]
next = this.images[next]
if(cur && next && cur.birthtime.getMonth() != next.birthtime.getMonth()){
this.ribbons.getImageMarks(gid).filter('.partition').remove()
this.ribbons.getImage(gid)
.after(this.ribbons.setElemGID($('<div class="mark partition">'), gid)
.attr('text', month[next.birthtime.getMonth()]))
}
}],
// XXX this is just a test...
embededListerTest: ['Test/50: Lister test (embeded)/*',
function(path, make){
make('a/')
make('b/')
make('c/')
}],
floatingListerTest: ['Test/50:Lister test (floating)...',
function(path){
// we got an argument and can exit...
if(path){
console.log('PATH:', path)
return
}
// load the UI...
var that = this
var list = function(path, make){
make('a/')
make('b/')
make('c/')
}
var o = overlay.Overlay(this.ribbons.viewer,
browse.makePathList(null, {
'a/*': list,
'b/*': list,
'c/*': list,
})
.open(function(evt, path){
o.close()
that.floatingListerTest(path)
}))
return o
}],
// XXX migrate to the dialog framework...
// XXX use this.ribbons.viewer as base...
// XXX BUG: when using this.ribbons.viewer as base some actions leak
// between the two viewers...
showTaggedInDrawer: ['- Test/Show tagged in drawer',
function(tag){
tag = tag || 'bookmark'
var that = this
var H = '200px'
var viewer = $('<div class="viewer">')
.css({
height: H,
background: 'black',
})
// XXX use this.ribbons.viewer as base...
// XXX when using viewer zoom and other stuff get leaked...
var widget = drawer.Drawer($('body'),
$('<div>')
.css({
position: 'relative',
height: H,
})
.append(viewer),
{
focusable: true,
})
var data = this.data.crop(this.data.getTaggedByAll(tag), true)
var b = new core.ImageGrid()
// used switch experimental actions on (set to true) or off (unset or false)...
//a.experimental = true
// setup actions...
core.ImageGridFeatures.setup(b, [
'viewer-testing',
])
// setup the viewer...
// XXX for some reason if we load this with data and images
// the images will not show up...
b.load({
viewer: viewer,
})
// load some testing data...
// NOTE: we can (and do) load this in parts...
b
.load({
data: data,
images: this.images,
})
// this is needed when loading legacy sources that do not have tags
// synced...
// do not do for actual data...
//.syncTags()
.fitImage(1)
// link navigation...
.on('focusImage', function(){
that.focusImage(this.current)
})
// XXX setup keyboard...
var keyboard = require('lib/keyboard')
// XXX move this to the .config...
var kb = {
'Basic Control': {
pattern: '*',
Home: {
default: 'firstImage!',
},
End: {
default: 'lastImage!',
},
Left: {
default: 'prevImage!',
ctrl: 'prevScreen!',
// XXX need to prevent default on mac + browser...
meta: 'prevScreen!',
},
PgUp: 'prevScreen!',
PgDown: 'nextScreen!',
Right: {
default: 'nextImage!',
ctrl: 'nextScreen!',
// XXX need to prevent default on mac + browser...
meta: 'nextScreen!',
},
}
}
widget.dom
// XXX
.keydown(
keyboard.dropRepeatingkeys(
keyboard.makeKeyboardHandler(
kb,
function(k){
window.DEBUG && console.log(k)
},
b),
function(){
return that.config['max-key-repeat-rate']
}))
// XXX STUB
window.b = b
return b
}],
showBookmarkedInDrawer: ['Test/Show bookmarked in drawer',
function(){ this.showTaggedInDrawer('bookmark') }],
showSelectedInDrawer: ['Test/Show selected in drawer',
function(){ this.showTaggedInDrawer('selected') }],
makePartitionAfter: ['Test/Make Partition after image',
function(image, text){
var gid = this.data.getImage(image || 'current')
var attrs = {
gid: gid
}
if(text){
attrs.text = text
}
this.ribbons.getImage(gid)
.after($('<span>')
.addClass('mark partition')
.attr(attrs))
}],
})
var WidgetTest =
module.WidgetTest = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-widget-test',
depends: [
'ui-browse-actions',
],
actions: WidgetTestActions,
})
/**********************************************************************
* vim:set ts=4 sw=4 : */ return module })