ImageGrid/ui (gen4)/features/ui-widgets.js
Alex A. Naanou a2c75dd5be more refactoring and cleanup...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2016-04-30 18:39:14 +03:00

945 lines
23 KiB
JavaScript
Executable File

/**********************************************************************
*
*
*
**********************************************************************/
define(function(require){ var module = {}
//var DEBUG = DEBUG != null ? DEBUG : true
var keyboard = require('lib/keyboard')
var actions = require('lib/actions')
var features = require('lib/features')
var data = require('data')
var images = require('images')
var ribbons = require('ribbons')
var core = require('features/core')
var base = require('features/base')
// widgets...
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')
/*********************************************************************/
// XXX make the selector more accurate...
// ...at this point this will select the first elem with text which
// can be a different elem...
var makeEditableItem =
module.makeEditableItem =
function(list, item, elem, callback, options){
return elem
.makeEditable({
clear_on_edit: false,
})
.on('edit-done', callback || function(){})
.on('edit-aborted edit-done', 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(item.text()) })
})
}
//
// Options format:
// {
// new_button: <text>|<bool>,
//
// length_limit: <number>,
//
// // check input value...
// check: function(value){ ... },
//
// // if true only unique values will be stored...
// // if a function this will be used to normalize the values before
// // uniqueness check is performed...
// unique: <bool>|function(value){ ... },
//
// // if true sort values...
// // if function will be used as cmp for sorting...
// sort: <bool> || function(a, b){ ... },
//
// // this is called when a new value is added via new_button but
// // list length limit is reached...
// callback: function(selected){ ... },
//
// // see: itemButtons doc in browse.js for more info...
// itemButtons: [..]
// }
//
// XXX add sort buttons: up/down/top/bottom...
// XXX make this more generic...
// XXX currently using this also requires the use of makeUIDialog(..),
// can this be simpler???
var makeConfigListEditor =
module.makeConfigListEditor =
function(actions, list_key, options){
options = options || {}
var new_button = options.new_button
new_button = new_button === true ? 'New...' : new_button
var _makeEditable = function(elem){
return $(elem).find('.text')
.makeEditable()
.on('edit-aborted', function(){
list.update()
})
.on('edit-done', function(evt, text){
var txt = $(this).text()
// invalid format...
if(options.check && !options.check(txt)){
list.update()
return
}
// list length limit
if(options.length_limit
&& (lst.length >= options.length_limit)){
options.callback && options.callback.call(list, txt)
return
}
// prevent editing non-arrays...
if(!(actions.config[list_key] instanceof Array)){
return
}
// save the new version...
actions.config[list_key] = actions.config[list_key].slice()
// add new value and sort list...
actions.config[list_key]
.push(txt)
// unique...
if(options.unique == null || options.unique === true){
actions.config[list_key] = actions.config[list_key]
.unique()
// unique normalized...
} else if( typeof(options.unique) == typeof(function(){})){
actions.config[list_key] = actions.config[list_key]
.unique(options.unique)
}
// sort...
if(options.sort){
actions.config[list_key] = actions.config[list_key]
.sort(typeof(options.sort) == typeof(function(){}) ?
options.sort
: undefined)
}
// update the list data...
list.options.data
= actions.config[list_key]
.concat(new_button ? [ new_button ] : [])
// update list and select new value...
list.update()
.done(function(){
list.select('"'+txt+'"')
})
})
}
var to_remove = []
var lst = actions.config[list_key]
lst = lst instanceof Array ? lst : Object.keys(lst)
var list = browse.makeList( null,
lst.concat(new_button ? [ new_button ] : []),
{itemButtons: options.itemButtons || [
// mark for removal...
['&times;',
function(p){
var e = this.filter('"'+p+'"', false)
.toggleClass('strike-out')
if(e.hasClass('strike-out')){
to_remove.indexOf(p) < 0
&& to_remove.push(p)
} else {
var i = to_remove.indexOf(p)
if(i >= 0){
to_remove.splice(i, 1)
}
}
}],
// XXX add shift up/down/top/bottom and other buttons (optional)...
]})
// select the new_button item...
.on('select', function(evt, elem){
if(new_button && $(elem).find('.text').text() == new_button){
_makeEditable(elem)
}
})
// restore striked-out items...
.on('update', function(){
to_remove.forEach(function(e){
list.filter('"'+ e +'"')
.toggleClass('strike-out')
})
})
.open(function(evt, path){
// we clicked the 'New' button -- select it...
if(new_button && (path == new_button || path == '')){
list.select(new_button)
} else {
options.callback && options.callback.call(list, path)
}
})
.on('close', function(){
// prevent editing non-arrays...
if(!(actions.config[list_key] instanceof Array)){
return
}
// remove striked items...
to_remove.forEach(function(e){
var lst = actions.config[list_key].slice()
lst.splice(lst.indexOf(e), 1)
actions.config[list_key] = lst
})
// sort...
if(options.sort){
actions.config[list_key] = actions.config[list_key]
.sort(options.sort !== true ? options.sort : undefined)
}
})
new_button && list.dom.addClass('tail-action')
return list
}
// XXX should this be more generic...
// XXX currently using this also requires the use of makeUIDialog(..),
// can this be simpler???
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 = {
new_button: 'New...',
length_limit: 10,
// NOTE: this is called when adding a new value and
// list maximum length is reached...
callback: function(value){
if(typeof(value_key) == typeof(function(){})){
value_key(value)
} else {
actions.config[value_key] = value
}
o.parent.close()
},
}
options.__proto__ = dfl_options
var o = makeConfigListEditor(actions, list_key, options)
// update slideshow menu...
o.open(function(){
list.update()
list.select(txt)
})
actions.Overlay(o)
setTimeout(function(){
if(typeof(value_key) == typeof(function(){})){
o.select(value_key())
} else {
o.select(actions.config[value_key])
}
}, 0)
}
}
/*********************************************************************/
// 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:
// - stop the client's close event from propagating up
// - trigger the client's close event on close
//
// XXX pass options???
var makeUIContainer =
module.makeUIContainer = function(make){
return uiContainer(function(){
var o = make.apply(this, arguments)
// prevent the client event from bubbling up...
// XXX is this the right way to go???
o.client.on('close', function(evt){ evt.stopPropagation() })
// notify the client that we are closing...
o.close(function(){ o.client.trigger('close') })
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.uiContainers.indexOf(args[0]) >= 0 ?
args.shift()
: (dfl || this.config['ui-default-container'] || 'Overlay')
return this[container].apply(this,
[make.apply(this, args)].concat(cargs))
.client
})
}
//---------------------------------------------------------------------
var DialogsActions = actions.Actions({
config: {
'ui-default-container': 'Overlay',
},
// a bit of 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)) },
// get top overlay and overlay client...
get overlay(){
return overlay.getOverlay(this.viewer) },
// testers...
isUIContainer: ['- Interface/',
actions.doWithRootAction(function(action){
return action.__container__ == true })],
isUIDialog: ['- Interface/',
actions.doWithRootAction(function(action){
return action.__dialog__ == true })],
isUIElement: ['- Interface/',
actions.doWithRootAction(function(action){
return 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)
// XXX focus parent on exit...
.on('close', function(){
var o = that.overlay
o && o.focus()
})
})],
// XXX should this use .ribbons.viewer as base???
Drawer: ['- Interface/',
makeUIContainer(function(dialog, options){
return drawer.Drawer($('body'), dialog, options) })],
// XXX need to:
// - dock panels
// - save panel state (position, collapse, dock, ...)
// - restore panel state
Panel: ['- Interface/',
makeUIContainer(function(dialog, options){
// XXX
console.error('Panels are not yet implemented.')
})],
listDialogs: ['Interface/List dialogs...',
makeUIDialog(function(){
var actions = this
return browse.makeLister(null, function(path, make){
var that = this
actions.uiDialogs.forEach(function(dialog){
make(actions.getDoc(dialog)[dialog][0]
// mark item as disabled...
.replace(/^- (.*)$/, '$1 (disabled)'))
.on('open', function(){
actions[dialog]()
})
})
})
})],
})
var Dialogs =
module.Dialogs = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-dialogs',
depends: [
'ui',
],
actions: DialogsActions,
})
/*********************************************************************/
// 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()
// XXX revise this...
var makeActionLister = function(list, filter, pre_order){
pre_order = typeof(filter) == typeof(true) ? filter : pre_order
filter = typeof(filter) == typeof(true) ? null : filter
return makeUIDialog(function(path, inline_state){
inline_state = inline_state == null ?
this.config['actions-list-show-toggler-state-inline']
: inline_state
var that = this
var paths = this.getPath()
var actions = {}
var d
// pre-order the main categories...
if(pre_order){
this.config['action-category-order'].forEach(function(k){
actions[k] = null
})
}
var closingPrevented = false
// build the action list...
Object.keys(paths).forEach(function(k){
var n = paths[k][0]
var k = filter ? filter(k, n) : k
// prepare for toggler stuff...
var isToggler = that.isToggler && that.isToggler(n) || false
if(isToggler){
var cur_state = that[n]('?')
k = k +(inline_state ? (' ('+ cur_state +')') : '')
}
// XXX this expects that .client will trigger an open event...
var waitFor = function(child){
// we got a widget, wait for it to close...
if(child instanceof overlay.Overlay){
closingPrevented = true
child
.on('close', function(){ d.parent.focus() })
.client
.on('open', function(){ d.parent.close() })
}
return child
}
// pass args to listers...
if(k.slice(-1) == '*'){
actions[k] = function(){ return waitFor(a[n].apply(a, arguments)) }
// ignore args of actions...
} else {
actions[k] = function(){ return waitFor(a[n]()) }
}
// toggler -- add state list...
if(isToggler){
var states = that[n]('??')
// bool toggler...
if(cur_state == 'on' || cur_state == 'off'){
states = ['off', 'on']
}
states.forEach(function(state){
actions[k +'/'+ state + (cur_state == state ? ' *': '')] =
function(){
that[n](state)
// XXX this works but is not yet usable...
// reason: not being able to update path
// components without reconstructing
// the whole list...
/*
closingPrevented = true
// XXX need to re-render the overlay paths...
that.overlay.client
.pop()
*/
}
})
}
})
var config = Object.create(that.config['browse-actions-settings'] || {})
config.path = path
d = list(null, actions, config)
.open(function(evt){
if(!closingPrevented){
d.parent.close()
}
closingPrevented = false
})
// save show disabled state to .config...
.on('close', function(){
var config = that.config['browse-actions-settings']
config.showDisabled = d.options.showDisabled
})
return d
})
}
// NOTE: yes, this is a funny name ;)
var BrowseActionsActions = actions.Actions({
config: {
// NOTE: the slashes at the end are significant, of they are not
// present the .toggleNonTraversableDrawing(..) will hide
// these paths before they can get any content...
// XXX not sure if this is a bug or not...
'action-category-order': [
'File/',
'Edit/',
'Navigate/',
],
'actions-list-show-toggler-state-inline': true,
'browse-actions-settings': {
showDisabled: false,
},
},
browseActions: ['Interface/Browse actions...',
makeActionLister(browse.makePathList, true)],
listActions:['Interface/List actions...',
makeActionLister(browse.makeList,
// format the doc to: <name> (<category>, ..)
// NOTE: this a bit naive...
function(k){
var l = k.split(/[\\\/\|]/)
var a = l.pop()
return a +' ('+ l.join(', ') +')'
})],
})
var BrowseActions =
module.BrowseActions = core.ImageGridFeatures.Feature({
title: '',
doc: '',
tag: 'ui-browse-actions',
depends: [
'ui',
'ui-dialogs',
],
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()
})
}],
],
})
//---------------------------------------------------------------------
// XXX make this not applicable to production...
var WidgetTestActions = actions.Actions({
// 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/Drawer 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,
})],
testBrowse: ['Test/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')
make('nested dialog...')
.on('open', function(){
actions.testBrowse()
})
make('---')
make('close parent')
.on('open', function(){
that.parent.close()
})
// XXX the parent is not yet set at this point...
//console.log('>>>', that.parent)
})
// 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...')
})
})],
// XXX this is just a test...
embededListerTest: ['Test/Lister test (embeded)/*',
function(path, make){
make('a/')
make('b/')
make('c/')
}],
floatingListerTest: ['Test/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 needs cleanup...
// XXX need a clean constructor strategy -- this and ui.js are a mess...
// 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(a.data.getTaggedByAll(tag), true)
var b = actions.Actions()
// 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()
.setEmptyMsg('No images bookmarked...')
.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') }],
})
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 })