2015-12-17 03:34:20 +03:00
/ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
*
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /
2016-08-21 02:19:24 +03:00
( ( typeof define ) [ 0 ] == 'u' ? function ( f ) { module . exports = f ( require ) } : define )
( function ( require ) { var module = { } // make module AMD/node compatible...
2016-08-20 22:49:36 +03:00
/*********************************************************************/
2015-12-17 03:34:20 +03:00
2016-04-14 18:31:10 +03:00
var keyboard = require ( 'lib/keyboard' )
2016-11-08 17:27:27 +03:00
var toggler = require ( 'lib/toggler' )
2015-12-17 03:34:20 +03:00
var actions = require ( 'lib/actions' )
var features = require ( 'lib/features' )
2016-06-01 16:12:10 +03:00
var data = require ( 'imagegrid/data' )
var images = require ( 'imagegrid/images' )
var ribbons = require ( 'imagegrid/ribbons' )
2015-12-17 03:34:20 +03:00
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' )
2016-01-05 04:48:24 +03:00
var browseWalk = require ( 'lib/widget/browse-walk' )
2015-12-17 03:34:20 +03:00
2016-04-14 18:31:10 +03:00
/*********************************************************************/
2016-11-08 21:16:33 +03:00
// Format:
// {
// <button-text>: [
// <class>, // optional
// <info>, // optional
// <code>,
// ],
2017-09-06 16:02:29 +03:00
//
// <button-text>: [
// <class>, // optional
// <info>, // optional
// [
// // primary action (click / tap)...
// <primary>,
// // secondary action (contextmenu -- right-clock / long-tap)...
// <secondary>,
// ]
// ],
2016-11-08 21:16:33 +03:00
// ...
// }
var makeButtonControls =
module . makeButtonControls =
function ( context , cls , data ) {
2016-11-10 05:18:44 +03:00
cls = cls instanceof Array ? cls : cls . split ( /\s+/g )
2016-11-08 21:16:33 +03:00
// remove old versions...
2017-05-16 00:26:37 +03:00
context . dom . find ( '.' + cls . join ( '.' ) ) . remove ( )
2016-11-08 21:16:33 +03:00
// make container...
var controls = $ ( '<div>' )
2016-11-10 05:18:44 +03:00
. addClass ( 'buttons ' + cls . join ( '.' ) )
2018-03-19 01:42:36 +03:00
. on ( 'mouseover' , function ( evt ) {
evt = window . event || evt
var t = $ ( evt . target )
2016-11-08 21:16:33 +03:00
var info = t . attr ( 'info' ) || t . parents ( '[info]' ) . attr ( 'info' ) || ''
2016-11-09 04:53:42 +03:00
context . showStatusBarInfo
&& context . showStatusBarInfo ( info )
2016-11-08 21:16:33 +03:00
} )
2016-11-23 03:16:17 +03:00
. on ( 'mouseout' , function ( ) {
2016-11-09 04:53:42 +03:00
context . showStatusBarInfo
&& context . showStatusBarInfo ( )
2016-11-08 21:16:33 +03:00
} )
// make buttons...
Object . keys ( data ) . forEach ( function ( k ) {
2016-11-16 04:57:31 +03:00
// spacer...
if ( typeof ( data [ k ] ) == typeof ( 'str' )
&& /--+/ . test ( data [ k ] ) ) {
k = ' '
var cls = 'spacer'
var doc = ''
2017-09-06 16:02:29 +03:00
var click = function ( ) { }
var menu = function ( ) { }
2016-11-16 04:57:31 +03:00
// normal element...
} else {
var e = data [ k ] . slice ( )
2017-09-06 16:02:29 +03:00
var primary = e . pop ( )
2018-01-15 03:59:53 +03:00
primary = primary instanceof Array ? primary . slice ( ) : primary
2017-09-06 16:02:29 +03:00
var secondary = ( primary instanceof Array && primary . length > 1 ) ?
primary . pop ( )
: null
secondary = typeof ( secondary ) == typeof ( 'str' ) ?
2017-11-19 01:01:44 +03:00
keyboard . parseActionCall ( secondary , context )
2017-09-06 16:02:29 +03:00
: secondary
primary = primary instanceof Array ? primary . shift ( ) : primary
primary = typeof ( primary ) == typeof ( 'str' ) ?
2017-11-19 01:01:44 +03:00
keyboard . parseActionCall ( primary , context )
2017-09-06 16:02:29 +03:00
: primary
var click = primary instanceof Function ?
primary
: function ( evt ) {
evt . stopPropagation ( )
evt . preventDefault ( )
context [ primary . action ] . apply ( context , primary . arguments ) }
var menu = secondary instanceof Function ?
secondary
: secondary ?
function ( evt ) {
evt . stopPropagation ( )
evt . preventDefault ( )
context [ secondary . action ] . apply ( context , secondary . arguments ) }
: click
var cls = e [ 0 ]
|| primary . action
|| ''
var doc = e [ 1 ]
|| ( primary . doc
+ ( secondary ? ' / ' + secondary . doc : '' ) )
|| e [ 0 ]
|| ''
2016-11-16 04:57:31 +03:00
}
2016-11-08 21:16:33 +03:00
controls
. append ( $ ( '<div>' )
. addClass ( 'button ' + cls )
. html ( k )
. attr ( 'info' , doc )
2016-11-23 03:16:17 +03:00
. click ( 'click' , function ( ) {
context . showStatusBarInfo
&& context . showStatusBarInfo ( )
} )
2017-09-06 16:02:29 +03:00
. click ( click )
. on ( 'contextmenu' , menu ) )
2016-11-08 21:16:33 +03:00
} )
controls
2017-05-16 00:26:37 +03:00
. appendTo ( context . dom )
2016-11-08 21:16:33 +03:00
}
2016-11-10 05:34:15 +03:00
// 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)
2016-11-10 05:18:44 +03:00
var makeButtonControlsToggler =
module . makeButtonControlsToggler =
2016-11-10 05:34:15 +03:00
function ( cls , cfg , parent ) {
2016-11-10 05:18:44 +03:00
cls = cls instanceof Array ? cls : cls . split ( /\s+/g )
cfg = cfg || cls [ 0 ]
return toggler . Toggler ( null ,
function ( ) {
2017-05-16 00:26:37 +03:00
parent = parent == null ? this . dom
2016-11-10 05:34:15 +03:00
: parent instanceof Function ? parent . call ( this )
: parent
2017-03-28 07:54:24 +03:00
return parent . find ( '.' + cls . join ( '.' ) ) . length > 0 ? 'on' : 'off'
} ,
2016-11-10 05:18:44 +03:00
[ 'off' , 'on' ] ,
function ( state ) {
if ( state == 'on' ) {
var config = this . config [ cfg ]
config
&& makeButtonControls ( this , cls , config )
} else {
2017-05-16 00:26:37 +03:00
this . dom . find ( '.' + cls . join ( '.' ) ) . remove ( )
2016-11-10 05:18:44 +03:00
}
2019-11-08 21:23:50 +03:00
} ) }
2016-11-10 05:18:44 +03:00
2016-11-08 21:16:33 +03:00
2016-04-17 05:02:37 +03:00
// XXX make the selector more accurate...
// ...at this point this will select the first elem with text which
// can be a different elem...
2017-01-15 00:49:19 +03:00
var editItem =
module . editItem =
function ( list , elem , callback , options ) {
2016-04-17 05:02:37 +03:00
return elem
2017-01-15 00:49:19 +03:00
. makeEditable ( options
|| {
activate : true ,
clear _on _edit : true ,
blur _on _abort : false ,
blur _on _commit : false ,
} )
2017-01-25 22:22:33 +03:00
. on ( 'edit-commit' , callback || function ( ) { } )
. on ( 'edit-abort edit-commit' , function ( _ , text ) {
2016-04-17 05:02:37 +03:00
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...
2017-01-15 00:49:19 +03:00
. then ( function ( ) { list . select ( elem . text ( ) ) } )
2019-11-08 21:23:50 +03:00
} ) }
2016-04-17 05:02:37 +03:00
2017-01-15 00:49:19 +03:00
//---------------------------------------------------------------------
2017-01-25 22:22:33 +03:00
// Edit list in .config...
//
// This will update value_path in .config with the opened item value.
//
2017-01-15 00:49:19 +03:00
var makeConfigListEditor =
module . makeConfigListEditor =
2017-11-14 00:13:47 +03:00
function ( actions , path , value _path , options , setup ) {
2017-01-15 00:49:19 +03:00
path = path . split ( '.' )
var key = path . pop ( )
2017-01-25 22:22:33 +03:00
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 ( )
2017-01-15 00:49:19 +03:00
var target = actions . config
path . forEach ( function ( p ) {
target = target [ p ] = target [ p ] || { }
} )
2017-01-25 22:22:33 +03:00
if ( value ) {
target [ key ] = value
2017-01-15 00:49:19 +03:00
} else {
2017-01-25 22:22:33 +03:00
return target [ key ]
2017-01-15 00:49:19 +03:00
}
2017-01-25 22:22:33 +03:00
}
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 )
} )
2017-11-14 00:13:47 +03:00
setup
&& setup . call ( dialog , dialog )
2017-01-25 22:22:33 +03:00
return dialog
2016-04-14 18:31:10 +03:00
}
2017-01-25 22:22:33 +03:00
// 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...
2016-04-16 03:41:45 +03:00
var makeNestedConfigListEditor =
module . makeNestedConfigListEditor =
2017-11-14 00:13:47 +03:00
function ( actions , list , list _key , value _key , options , setup ) {
2016-04-18 03:05:48 +03:00
options = options || { }
2016-04-16 03:41:45 +03:00
return function ( ) {
var txt = $ ( this ) . find ( '.text' ) . first ( ) . text ( )
var dfl _options = {
2017-01-25 22:22:33 +03:00
path : value _key instanceof Function ?
value _key ( )
: actions . config [ value _key ] ,
2016-04-16 03:41:45 +03:00
// NOTE: this is called when adding a new value and
// list maximum length is reached...
2017-01-25 22:22:33 +03:00
overflow : 'save' ,
2016-04-16 03:41:45 +03:00
}
options . _ _proto _ _ = dfl _options
2017-11-14 00:13:47 +03:00
var o = makeConfigListEditor ( actions , list _key , value _key , options , setup )
2017-01-25 22:22:33 +03:00
// update parent menu...
. open ( function ( ) {
list
&& list . update ( )
. then ( function ( ) {
txt != ''
&& list . select ( txt )
} )
} )
2016-06-06 18:46:23 +03:00
actions . Overlay ( o )
2017-01-25 22:22:33 +03:00
return o
2019-11-08 21:23:50 +03:00
} }
2016-04-16 03:41:45 +03:00
2016-04-14 18:31:10 +03:00
2016-04-30 03:38:52 +03:00
/*********************************************************************/
// Dialogs and containers...
2016-04-30 16:58:00 +03:00
// 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
2019-11-08 21:23:50 +03:00
return func }
2016-04-30 16:58:00 +03:00
// Make a container constructor wrapper...
//
// This will:
// - mark the action as a container
//
// The container will:
2019-10-10 16:54:50 +03:00
// - trigger client's 'attached' event when attached to container
// - trigger client's 'close' event on close
2016-04-30 16:58:00 +03:00
//
2016-05-14 22:50:26 +03:00
// XXX not sure how the click is handled here...
2016-04-30 16:58:00 +03:00
// XXX pass options???
2016-04-30 03:38:52 +03:00
var makeUIContainer =
module . makeUIContainer = function ( make ) {
2016-04-30 16:58:00 +03:00
return uiContainer ( function ( ) {
2016-05-14 22:50:26 +03:00
var that = this
2019-04-12 01:23:22 +03:00
// trigger the general modal open event...
that . modal
// XXX do we need to pass anything here????
|| that . firstModalOpen ( )
2016-04-30 16:58:00 +03:00
var o = make . apply ( this , arguments )
2016-04-30 03:38:52 +03:00
2016-04-30 20:14:39 +03:00
o
// notify the client that we are closing...
2017-01-30 05:37:55 +03:00
. close ( function ( evt , mode ) { o . client . trigger ( 'close' , mode ) } )
2016-04-30 20:14:39 +03:00
. client
// NOTE: strictly this is the responsibility of the client
// but it is less error prone to just in case also do
// this here...
2017-05-11 16:36:38 +03:00
. on ( 'close' , function ( evt ) {
evt . stopPropagation ( )
that . modal ?
that . modal . focus ( )
// NOTE: this fixes a bug where the UI loses focus
// and keys are no longer tracked...
// XXX is this the right way to go???
// To reproduce:
2017-05-11 17:37:44 +03:00
// - comment this line and .focus() in return...
// - alt-F
// - /load -> serach
// - Enter -> loads demo data but the viewer
// is in a state where the window
// is in focus but keys are not
// tracked...
2017-05-16 00:26:37 +03:00
: that . dom . focus ( )
2019-04-12 01:23:22 +03:00
// trigger the general modal close event...
that . modal
// XXX do we need to pass anything here????
|| that . lastModalClose ( )
2017-05-11 16:36:38 +03:00
} )
2016-05-14 22:50:26 +03:00
// Compensate for click focusing the parent dialog when
// a child is created...
// XXX is this the right way to go???
2016-06-08 18:10:39 +03:00
. on ( 'click' , function ( evt ) {
that . modal && that . modal . focus ( ) } )
2019-10-10 16:54:50 +03:00
. trigger ( 'attached' , o )
2016-04-30 03:38:52 +03:00
return o
2017-05-11 16:36:38 +03:00
// focus the new dialog...
// NOTE: fixes the same bug as .client.on('close', ...) above,
// see note for that...
. focus ( )
2019-11-08 21:23:50 +03:00
} ) }
2016-04-30 03:38:52 +03:00
2016-04-30 16:58:00 +03:00
// Mark action as a dialog...
//
var uiDialog =
module . uiDialog = function ( func ) {
func . _ _dialog _ _ = true
2019-11-08 21:23:50 +03:00
return func }
2016-04-30 16:58:00 +03:00
// 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. ???
2017-12-26 05:50:29 +03:00
// XXX need to revise this API as passing a container title ONLY works
// for actions explicitly created with makeUIDialog(..) and not
// extended/overloaded...
2016-04-30 03:38:52 +03:00
var makeUIDialog =
2016-04-30 16:58:00 +03:00
module . makeUIDialog = function ( a , b ) {
2018-11-12 23:04:00 +03:00
var args = [ ... arguments ]
2016-04-30 16:58:00 +03:00
// 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 ( ) {
2018-11-12 23:04:00 +03:00
var args = [ ... arguments ]
2016-04-30 03:38:52 +03:00
2019-11-14 03:29:30 +03:00
// we passed a make(..) function...
// XXX revise...
if ( args [ 0 ] instanceof Function && args [ 0 ] . constructor === browse . Make ) {
return actions . ASIS ( make . call ( this , ... args ) ) }
2016-04-30 16:58:00 +03:00
// see if the first arg is a container spec...
2017-07-09 16:46:11 +03:00
var container = ! ( args [ 0 ] instanceof Array ) && this . isUIContainer ( args [ 0 ] ) ?
2016-04-30 16:58:00 +03:00
args . shift ( )
: ( dfl || this . config [ 'ui-default-container' ] || 'Overlay' )
2016-04-30 07:02:20 +03:00
2017-01-26 04:53:17 +03:00
var dialog = make . apply ( this , args )
if ( ! dialog ) {
return dialog
}
2016-04-30 16:58:00 +03:00
return this [ container ] . apply ( this ,
2017-01-26 04:53:17 +03:00
[ dialog ] . concat ( cargs ) )
2016-04-30 16:58:00 +03:00
. client
2019-11-08 21:23:50 +03:00
} ) }
2016-04-30 03:38:52 +03:00
2016-05-07 16:15:18 +03:00
var makeDrawer = function ( direction ) {
return makeUIContainer ( function ( dialog , options ) {
2016-05-08 15:58:22 +03:00
var that = this
2017-01-13 06:55:43 +03:00
options = options || { }
var parent = options . parentElement
2017-05-16 00:26:37 +03:00
parent = parent ? $ ( parent ) : this . dom
2016-05-07 16:15:18 +03:00
options . direction = direction || 'bottom'
2016-05-08 14:43:13 +03:00
var d = drawer . Drawer ( parent , dialog , options )
// focus top modal on exit...
. on ( 'close' , function ( ) {
var o = that . modal
o && o . focus ( )
} )
2016-05-07 16:15:18 +03:00
// 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
2019-11-08 21:23:50 +03:00
} ) }
2016-05-07 16:15:18 +03:00
2017-12-09 01:39:06 +03:00
2017-09-09 04:46:59 +03:00
//---------------------------------------------------------------------
// Higher level dialog action constructors...
// Make list editor dialog...
//
// makeListEditorDialog(list[, options])
// -> action
//
// makeListEditorDialog(function[, options])
// -> action
//
//
// Example:
// someAction: [
// makeListEditorDialog(
// // list of items to edit or list getter function...
// // NOTE: this is edited in place...
// [ 'item', .. ] | function(){ .. },
// // options compatible with browse's Items.EditableList(..)
// { .. })],
//
// XXX should these replace the makeConfigListEditor/makeNestedConfigListEditor???
var makeListEditorDialog =
module . makeListEditorDialog =
2017-09-16 18:11:07 +03:00
function makeListEditorDialog ( list , options ) {
2017-09-09 04:46:59 +03:00
options = options || { }
return makeUIDialog ( function ( ) {
var lst = list instanceof Function ?
list . call ( this )
: list
// NOTE: this will edit the list in place...
return browse . makeLister ( null ,
function ( _ , make ) {
make . EditableList ( lst , options )
} , {
cls : options . cls ,
2019-11-22 16:09:25 +03:00
} ) } ) }
2017-09-09 04:46:59 +03:00
// Make .config list editor dialog...
//
// makeConfigListEditorDialog(path[, options])
// -> action
//
//
// Example:
// someAction: [
// makeConfigListEditorDialog(
// // path to list in .config
// 'path.to.list',
// // options compatible with browse's Items.EditableList(..)
// { .. })],
//
// NOTE: see collections.editDefaultCollections(..) for a live example.
var makeConfigListEditorDialog =
module . makeConfigListEditorDialog =
function makeConfigListEditorDialog ( path , options ) {
path = path . split ( '.' )
var key = path . pop ( )
return makeListEditorDialog ( function ( ) {
var p = path . slice ( )
// get the path...
var cur = this . config
while ( p . length > 0 ) {
var k = p . shift ( )
cur = cur [ k ] = cur [ k ] || { }
}
// the actual list we'll be editing...
var list =
cur [ key ] =
( cur [ key ] || [ ] ) . slice ( )
return list
2019-11-08 21:23:50 +03:00
} , options ) }
2017-09-09 04:46:59 +03:00
2016-05-07 16:15:18 +03:00
2016-04-30 16:58:00 +03:00
2017-12-09 01:39:06 +03:00
//---------------------------------------------------------------------
2016-04-30 03:38:52 +03:00
var DialogsActions = actions . Actions ( {
config : {
'ui-default-container' : 'Overlay' ,
2016-11-08 17:27:27 +03:00
'ui-overlay-blur' : 'on' ,
2017-01-20 01:12:48 +03:00
// used by UI to set the user confirm action timeout...
'ui-confirm-timeout' : 2000 ,
2016-04-30 03:38:52 +03:00
} ,
2016-12-12 16:29:32 +03:00
// introspection...
2017-01-05 23:00:49 +03:00
get uiContainers ( ) {
2018-01-20 01:14:59 +03:00
return this . cache ( 'uiContainers' , function ( d ) {
return d instanceof Array ?
d . slice ( )
: this . actions . filter ( this . isUIContainer . bind ( this ) ) } ) } ,
2017-01-05 23:00:49 +03:00
get uiDialogs ( ) {
2018-01-20 01:14:59 +03:00
return this . cache ( 'uiDialogs' , function ( d ) {
return d instanceof Array ?
d . slice ( )
: this . actions . filter ( this . isUIDialog . bind ( this ) ) } ) } ,
2017-01-05 23:00:49 +03:00
get uiElements ( ) {
2018-01-20 01:14:59 +03:00
return this . cache ( 'uiElements' , function ( d ) {
return d instanceof Array ?
d . slice ( )
: this . actions . filter ( this . isUIElement . bind ( this ) ) } ) } ,
2017-01-05 23:00:49 +03:00
2017-01-30 05:01:50 +03:00
// XXX this knows about action priority and shortcut marker...
2016-12-12 16:29:32 +03:00
// XXX should these be more like .getDoc(..) and support lists of actions???
2017-07-08 00:08:33 +03:00
// XXX should these be here or someplace in base (base-introspection)???
2016-12-12 16:29:32 +03:00
getDocPath : [ '- Interface/' ,
function ( action , clean , join ) {
clean = clean == null ? true : clean
join = join == null ? '/' : join
var path = ( this . getDoc ( action ) [ action ] . shift ( ) || action )
2017-01-22 01:39:46 +03:00
path = clean ? path . replace ( /^- / , '' ) : path
path = path
2016-12-12 16:29:32 +03:00
. split ( /[\\\/]/g )
// remove priority...
. map ( function ( e ) {
2017-01-22 01:39:46 +03:00
return clean ?
2017-01-30 05:01:50 +03:00
e
. replace ( /^[-+]?[0-9]+:\s*/ , '' )
. replace ( /\$(\w)/g , '$1' )
2017-01-22 01:39:46 +03:00
: e } )
2016-12-12 16:29:32 +03:00
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 ( )
} ] ,
2016-05-08 14:30:35 +03:00
// Get modal container...
//
// Protocol:
2017-01-27 06:48:24 +03:00
// - get the last (top) modal widgets (CSS selector: .modal-widget)
2016-05-08 14:30:35 +03:00
// - return one of the following:
// .data('widget-controller')
// element
// null
get modal ( ) {
2017-05-16 00:26:37 +03:00
var modal = this . dom
2016-05-08 14:43:13 +03:00
. find ( '.modal-widget' )
2016-05-08 14:30:35 +03:00
. last ( )
return modal . data ( 'widget-controller' )
|| ( modal . length > 0 && modal )
2019-12-08 02:45:33 +03:00
|| null } ,
2016-04-30 03:38:52 +03:00
// testers...
2017-12-24 06:48:59 +03:00
//
2017-12-26 05:50:29 +03:00
// ui elements...
2018-03-05 00:39:13 +03:00
isUIContainer : function ( action ) {
return ! ! this . getActionAttr ( action , '__container__' ) } ,
isUIDialog : function ( action ) {
return ! ! this . getActionAttr ( action , '__dialog__' ) } ,
isUIElement : function ( action ) {
return this . isUIDialog ( action ) || this . isUIContainer ( action ) } ,
2017-12-26 05:50:29 +03:00
// extended ui elements
// ...first defined as a non-ui action and extended to a ui element.
2018-03-05 00:39:13 +03:00
isUIExtendedContainer :
2017-12-26 05:50:29 +03:00
actions . doWithRootAction ( function ( action , name ) {
return action != null
&& ! action . _ _container _ _
2018-03-05 00:39:13 +03:00
&& this . isUIContainer ( name ) } ) ,
isUIExtendedDialog :
2017-12-26 05:50:29 +03:00
actions . doWithRootAction ( function ( action , name ) {
return action != null
&& ! action . _ _dialog _ _
2018-03-05 00:39:13 +03:00
&& this . isUIDialog ( name ) } ) ,
isUIExtendedElement :
2017-12-26 05:50:29 +03:00
actions . doWithRootAction ( function ( action , name ) {
return action != null
&& ! action . _ _dialog _ _
&& ! action . _ _container _ _
2018-03-05 00:39:13 +03:00
&& this . isUIElement ( name ) } ) ,
2016-04-30 03:38:52 +03:00
// container constructors...
Overlay : [ '- Interface/' ,
2016-04-30 16:58:00 +03:00
makeUIContainer ( function ( dialog , options ) {
2016-04-30 03:38:52 +03:00
var that = this
2017-05-16 00:26:37 +03:00
return overlay . Overlay ( this . dom , dialog , options )
2016-05-08 14:43:13 +03:00
// focus top modal on exit...
2016-04-30 03:38:52 +03:00
. on ( 'close' , function ( ) {
2016-05-08 14:43:13 +03:00
var o = that . modal
2016-04-30 03:38:52 +03:00
o && o . focus ( )
2019-11-08 21:23:50 +03:00
} ) } ) ] ,
2016-04-30 16:58:00 +03:00
Drawer : [ '- Interface/' ,
2016-05-07 16:15:18 +03:00
makeDrawer ( 'bottom' ) ] ,
2016-05-02 03:49:34 +03:00
BottomDrawer : [ '- Interface/' ,
2016-05-07 16:15:18 +03:00
makeDrawer ( 'bottom' ) ] ,
2016-05-08 14:30:35 +03:00
TopDrawer : [ '- Interface/' ,
makeDrawer ( 'top' ) ] ,
2016-05-03 01:43:43 +03:00
// 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...
2016-04-30 18:39:14 +03:00
// XXX need to:
// - dock panels
// - save panel state (position, collapse, dock, ...)
// - restore panel state
2016-04-30 03:38:52 +03:00
Panel : [ '- Interface/' ,
2016-04-30 16:58:00 +03:00
makeUIContainer ( function ( dialog , options ) {
2016-04-30 03:38:52 +03:00
// XXX
2016-05-03 01:43:43 +03:00
//console.error('Not yet implemented.')
2016-05-08 14:30:35 +03:00
// minimal container...
2016-05-03 01:43:43 +03:00
var panel = {
client : dialog ,
dom : $ ( '<div>' )
. append ( dialog . dom || dialog )
2017-05-16 00:26:37 +03:00
. appendTo ( this . dom )
2016-05-03 01:43:43 +03:00
. draggable ( ) ,
close : function ( func ) {
2017-12-26 05:50:29 +03:00
if ( func instanceof Function ) {
2016-05-03 01:43:43 +03:00
this . dom . on ( 'close' , func )
} else {
2017-01-24 00:14:31 +03:00
this . dom . trigger ( 'close' , 'reject' )
2016-05-03 01:43:43 +03:00
this . dom . remove ( )
}
return this
} ,
2017-12-26 05:50:29 +03:00
focus : function ( ) {
} ,
2016-05-03 01:43:43 +03:00
}
dialog . on ( 'blur' , function ( ) {
2017-01-24 00:14:31 +03:00
panel . close ( 'reject' )
2016-05-03 01:43:43 +03:00
} )
return panel
2016-04-30 03:38:52 +03:00
} ) ] ,
2019-04-12 01:23:22 +03:00
// Events...
firstModalOpen : [ '- Interface/' ,
core . Event ( function ( gid ) {
// Triggered when the first modal container is opened.
//
// Not for direct use.
} ) ] ,
// XXX due to that .close() can be called a couple of times this can
// also be called a couple of times...
lastModalClose : [ '- Interface/' ,
core . Event ( function ( gid ) {
// Triggered when the last modal container is closed.
//
// Not for direct use.
} ) ] ,
2017-01-21 23:39:41 +03:00
2017-01-22 01:39:46 +03:00
// Helper for creating lists fast...
showList : [ '- Interface/' ,
2017-01-31 02:51:06 +03:00
core . doc ` Show list dialog...
. showList ( < list > , < options > )
- > dialog
See browse . makeList ( . . ) / browse . Items . List ( . . ) for more info .
` ,
2017-01-21 23:39:41 +03:00
makeUIDialog ( function ( list , options ) {
2017-01-22 01:39:46 +03:00
return browse . makeList ( null , list , options ) } ) ] ,
2018-12-14 03:44:39 +03:00
showTree : [ '- Interface/' ,
makeUIDialog ( function ( list , options ) {
return browse . makePathList ( null ,
list ,
Object . assign ( {
/ *
cls : 'browse-actions' ,
//path: '/',
flat : false ,
traversable : true ,
pathPrefix : '/' ,
//fullPathEdit: true,
//*/
} , options || { } ) ) } ) ] ,
2018-12-15 18:48:25 +03:00
// XXX
showCloud : [ '- Interface/' ,
makeUIDialog ( function ( list , options ) {
throw new Error ( '.showCloud(..): not implemented.' ) } ) ] ,
2018-12-14 03:44:39 +03:00
2017-09-16 18:11:07 +03:00
// XXX do we need to split the options???
showEditableList : [ '- Interface/' ,
core . doc ` Show editable list dialog...
. showEditableList ( < list > , < options > )
- > dialog
See browse . Items . EditableList ( . . ) for more info .
2017-09-16 20:45:30 +03:00
NOTE : this passes the same options to the list item and the
dielog .
XXX this may change in the future ...
2017-09-16 18:11:07 +03:00
` ,
makeUIDialog ( function ( list , options ) {
2017-09-16 20:45:30 +03:00
options = Object . create ( options || { } )
// defaults...
options . sortable = options . sortable === undefined ?
true
: options . sortable
2017-09-16 18:11:07 +03:00
return browse . makeLister ( null ,
function ( path , make ) {
make . EditableList ( list , options )
} ,
options ) } ) ] ,
2017-01-31 02:51:06 +03:00
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 ) {
2017-11-19 01:01:44 +03:00
var a = keyboard . parseActionCall ( m , that )
2017-01-31 02:51:06 +03:00
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 )
} ) ] ,
2017-01-24 05:34:15 +03:00
2018-03-09 17:51:27 +03:00
listDialogs : [ 'Interface|System/Dialog/Dialog list...' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2017-07-02 16:42:28 +03:00
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 ( )
2017-12-24 07:33:31 +03:00
make ( txt == '*' ? ` ${ dialog } ( ${ txt } ) ` : txt )
2017-07-02 16:42:28 +03:00
. on ( 'open' , function ( ) {
actions [ dialog ] ( )
} )
} )
make . done ( )
} )
} ) ] ,
toggleOverlayBlur : [ 'Interface/Dialog overlay blur' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2017-07-02 16:42:28 +03:00
toggler . CSSClassToggler (
function ( ) { return this . dom } ,
'overlay-blur-enabled' ,
function ( state ) { this . config [ 'ui-overlay-blur' ] = state } ) ] ,
} )
var Dialogs =
module . Dialogs = core . ImageGridFeatures . Feature ( {
title : '' ,
doc : '' ,
tag : 'ui-dialogs' ,
depends : [
2018-01-18 09:16:46 +03:00
'cache' ,
2017-07-02 16:42:28 +03:00
'ui' ,
] ,
actions : DialogsActions ,
handlers : [
[ 'start' ,
function ( ) {
this . config [ 'ui-overlay-blur' ]
&& this . toggleOverlayBlur ( this . config [ 'ui-overlay-blur' ] )
} ] ,
[ '__call__' ,
2018-11-08 21:10:58 +03:00
function ( res , action , args ) {
2017-07-02 16:42:28 +03:00
//if(res instanceof jQuery || res instanceof widget.Widget){
// var elem = (res.dom || res)
if ( res instanceof widget . Widget ) {
var elem = res . dom
var title = this . getActionAttr ( action , 'dialogTitle' )
title ?
2018-11-08 21:10:58 +03:00
elem . attr ( 'dialog-title' ,
title instanceof Function ?
title . call ( this , action , args )
: title )
2017-07-02 16:42:28 +03:00
: ! elem . attr ( 'keep-dialog-title' )
&& ! this . getActionAttr ( action , 'keepDialogTitle' )
&& elem . attr ( 'dialog-title' , this . getDocTitle ( action ) )
}
} ] ,
] ,
} )
2019-11-08 21:23:50 +03:00
//---------------------------------------------------------------------
2019-11-15 02:43:19 +03:00
// Universal editor...
2019-11-08 21:23:50 +03:00
2019-11-18 05:22:57 +03:00
2019-12-01 18:00:41 +03:00
// XXX EXPERIMENTAL...
//
2019-12-07 01:12:15 +03:00
// Make a nested context...
//
// Make a nested context object...
// .makeSubContext(name[, obj])
// -> context
//
// Make a nested context function...
// .makeSubContext(name, func[, obj])
// -> context
//
//
// The context inherits from .items / make(..)
//
// If the context is callable it will be called in the context of make(..)
//
// If the context is constructed recursively it will return self
2019-12-01 18:00:41 +03:00
//
//
2019-12-12 23:08:30 +03:00
// XXX move this to browse.js/browse2.js???
2019-12-05 01:40:51 +03:00
// ...there seems to be no way to make this generic...
2019-12-13 16:08:50 +03:00
// XXX think of a better name... (???)
2019-12-22 04:01:14 +03:00
// XXX should the client be able to override shorthands???
2019-12-07 01:12:15 +03:00
browse . items . makeSubContext = function ( name , obj ) {
// arse args...
var args = [ ... arguments ] . slice ( 1 )
var func = args [ 0 ] instanceof Function ?
args . shift ( )
: null
obj = args . shift ( )
var n = '__' + name
Object . defineProperty ( this , name , {
get : function ( ) {
var that = this
if ( ! this . hasOwnProperty ( n ) ) {
// build the context object...
var nested =
func ?
// NOTE: we always call func(..) in the root context...
function ( ) {
2019-12-22 04:01:14 +03:00
// XXX should the client be able to override shorthands???
var shorthands = ( that . dialog . options || { } ) . elementShorthand || { }
return arguments [ 0 ] in shorthands ?
that . call ( that , ... arguments )
: func . call ( that , ... arguments ) }
//return func.call(that, ...arguments) }
2019-12-07 01:12:15 +03:00
: this instanceof Function ?
function ( ) {
2019-12-22 04:01:14 +03:00
return that . call ( this , ... arguments ) }
2019-12-07 01:12:15 +03:00
: { }
nested . _ _proto _ _ = this
// mixin parent/obj...
Object . assign ( nested ,
this [ n ] || obj || { } )
// NOTE: this will prevent constructing a nested context
// (see test above)...
this [ n ] = nested [ n ] = nested
}
return this [ n ] } ,
} )
return this [ name ] }
2019-12-01 18:00:41 +03:00
2019-11-18 05:22:57 +03:00
// XXX EXPERIMENT...
2019-12-23 19:11:45 +03:00
//
// .field(title[, options])
// .field(title, value[, options])
//
//
2019-12-24 19:39:33 +03:00
// NOTE: essentially make.field(..) is almost identical to make(..), the
// later is needed to provide context for field items and a transparent
// fallback for make(..) calls from within their context...
//
2019-12-09 04:45:38 +03:00
// XXX Q: should we add an ImageGrid context to make(..)???
// ...something like .app for making it generic-ish for example...
2019-12-10 15:09:25 +03:00
// ....a different approach to this would be to create a list editor
// within the current dialog independently of the outer context...
// ...this could either be done as:
// - a popup/modal sub dialog
2020-01-21 22:20:06 +03:00
// ...problematic as the wrapper is external to the browser...
2019-12-10 15:09:25 +03:00
// - as a sub-path...
// ...this is hard without side-effects...
2019-12-07 01:12:15 +03:00
browse . items . makeSubContext ( 'field' ,
2019-12-01 18:00:41 +03:00
function ( title , value , options ) {
2019-12-23 19:11:45 +03:00
// parse arguments...
var args = [ ... arguments ] . slice ( 1 )
value = ( args [ 0 ] instanceof Function
|| ! ( args [ 0 ] instanceof Object ) ) ?
args . shift ( )
: undefined
options = args . shift ( ) || { }
value = value || options . value
2019-12-01 18:00:41 +03:00
Object . assign (
options ,
{
title ,
value ,
} )
return this ( [
2019-11-23 16:40:08 +03:00
title ,
2019-12-01 18:00:41 +03:00
options . value instanceof Function ?
options . value ( this )
: options . value
] , options ) } )
2020-01-01 23:55:30 +03:00
// Toggler field...
2019-12-08 02:45:33 +03:00
//
2019-12-10 15:09:25 +03:00
// .field.Toggle(title, value[, options])
2019-12-08 02:45:33 +03:00
// .field.Toggle(title, options)
//
2020-02-10 15:42:10 +03:00
//
2019-12-11 16:49:26 +03:00
// XXX need to open a list (ro/editable) dialog (currently context is used)...
2019-11-24 02:21:17 +03:00
// ...this can be set via options.list but would be nice to provide
// a reasonable default...
2019-12-11 16:49:26 +03:00
// there are several ways this can be done:
// - generic dialogs in browse.js
2019-12-16 16:27:48 +03:00
// ...the quiestion with this approach is that we need the
// resulting dialogs to get wrapped in the same way as the
// parent...
// ...this can be done via inlining or temporarily redrawing....
2019-12-11 16:49:26 +03:00
// - a way to define defaults -- global options?
// - access to the .app -- should be configurable...
2020-02-11 15:39:16 +03:00
// ...it would be quite logical to add .app on init to all
2020-02-12 16:12:34 +03:00
// dialogs created via ImageGrid -- this is not trivial as we directly calk browse.* most of the time... (refactoring this might be a good excuse to migrate to browse2.js)
2019-12-15 23:06:18 +03:00
// - default methods .showEditableList(..) / .showList(..) on make(..)
2020-01-15 02:31:55 +03:00
// XXX currently if a user defines options.open it will fully override
// the default open behavior...
2019-12-01 18:00:41 +03:00
browse . items . field . Toggle =
2019-12-08 02:45:33 +03:00
function ( title , options ) {
2019-11-23 16:40:08 +03:00
var that = this
2019-12-08 02:45:33 +03:00
// parse args...
var args = [ ... arguments ] . slice ( 1 )
var value = args [ 0 ] instanceof Object ?
( args [ 0 ] . value
|| ( args [ 0 ] . values || [ ] ) [ 0 ]
|| 'off' )
: args . shift ( )
options = args . shift ( ) || { }
2019-12-01 18:00:41 +03:00
return this . field ( title , value ,
2019-11-23 16:40:08 +03:00
Object . assign (
options ,
2020-01-15 02:31:55 +03:00
options . _ _toggle _setup ?
{ }
: {
_ _toggler _setup : true ,
2020-01-12 10:11:10 +03:00
2020-01-15 02:31:55 +03:00
// XXX do we need a .type ???
//type: options.type || 'toggle',
2019-12-10 15:09:25 +03:00
2020-01-15 02:31:55 +03:00
open : function ( evt ) {
// XXX CONTEXT...
var actions = options . app || that . app
2020-01-14 21:29:50 +03:00
2020-01-15 02:31:55 +03:00
var getValues = function ( ) {
return options . values instanceof Function ?
options . values . call ( actions )
: options . values ?
options . values
: [ 'off' , 'on' ] }
var set = function ( v ) {
// get current value...
v = arguments . length > 0 ?
v
: options . value instanceof Function ?
options . value . call ( actions )
: options . value
// normalize...
// NOTE: we are re-getting the values here
// as it can get updated in options.list(..)
// or via options.values(..)...
if ( ! options . nonstrict ) {
var values = getValues ( )
v = values . includes ( v ) ?
v
: values [ 0 ] }
// update the value...
// NOTE: we update the local value iff set(..)
// got an explicit value argument...
// calling set(..) will not store anything,
// just update the current state, either to
// the already stored value or to the output
// of .value(..)...
arguments . length > 0
&& ( options . value instanceof Function ?
( v = options . value . call ( actions , v ) )
: ( options . value = v ) )
elem . text ( v )
// update dialog...
options . doNotAutoUpdateDialog
|| that . dialog . update ( ) }
var elem = $ ( this ) . find ( '.text' ) . last ( )
var current = elem . text ( )
var values = getValues ( )
// editable list or more than 2 values -> show value list...
if ( options . list _editable
|| ( values . length > 2
&& options . list !== false ) ) {
// call options.list(..)
if ( options . list instanceof Function ) {
options . list . call ( actions , current , set )
// normal list...
} else {
// XXX where do we get these when context in make(..)
// XXX mark the current value???
var o = actions [
options . list _editable ?
'showEditableList'
: 'showList' ] (
values ,
Object . assign ( {
path : current ,
open : function ( v ) {
// update value...
// XXX current is [[value]], check
// the upstream if this is correct...
current = v [ 0 ] [ 0 ]
// NOTE: this is done first
// to update values...
o . close ( )
// update callable values...
options . list _editable
&& options . values instanceof Function
&& options . values . call ( actions , values ) } ,
close : function ( ) {
// NOTE: set(..) should be
// called after all the
// dialog stuff is done...
setTimeout ( function ( ) { set ( current ) } ) } ,
} ,
options . list !== true ?
options . list
: { } ) ) }
// directly toggle next value...
2019-11-23 16:40:08 +03:00
} else {
2020-01-15 02:31:55 +03:00
// XXX should we be able to toggle values back???
set ( values [ ( values . indexOf ( current ) + 1 ) % values . length ] ) }
} } ,
2019-11-23 16:40:08 +03:00
options
// normalize value...
. run ( function ( ) {
2019-12-18 18:28:00 +03:00
// XXX CONTEXT...
2019-12-17 23:50:33 +03:00
var actions = options . app || that . app
2019-12-10 15:09:25 +03:00
2019-11-23 16:40:08 +03:00
if ( ! ( this . value instanceof Function ) ) {
var values = options . values instanceof Function ?
options . values . call ( actions )
: options . values ?
options . values
: [ 'off' , 'on' ]
this . value =
this . value === undefined ?
values [ 0 ]
: values . includes ( this . value ) ?
this . value
: this . value ?
'on'
: 'off' } } ) ) ) }
2019-11-18 05:22:57 +03:00
2020-02-06 15:37:18 +03:00
// XXX docs!!!
// ...do not forget to document the callback(..)...
2019-12-19 18:44:52 +03:00
browse . items . batch =
2019-11-24 02:21:17 +03:00
function ( spec , callback ) {
2019-12-19 18:44:52 +03:00
var that = this
// build the fields...
2020-01-14 21:29:50 +03:00
spec
2019-12-19 18:44:52 +03:00
. forEach ( function ( field ) {
// array...
field instanceof Array ?
2019-12-20 16:56:24 +03:00
that ( ... field )
2019-12-19 18:44:52 +03:00
// spec...
: field instanceof Object ?
2019-12-20 16:56:24 +03:00
( field . type || 'field' )
// handle field paths...
. split ( '.' )
. reduce ( function ( res , cur ) {
that = res
return res [ cur ] } , that )
2019-12-22 02:26:36 +03:00
. call ( that , field . title || field . id , field )
2019-12-19 18:44:52 +03:00
// other...
2019-12-20 16:56:24 +03:00
: that ( field ) } )
2019-12-19 18:44:52 +03:00
// batch callback...
2020-01-24 18:10:53 +03:00
var cb
2019-12-19 18:44:52 +03:00
callback
&& this . dialog
2020-02-04 19:28:12 +03:00
// XXX STUB .one(..) vs. .on(..) get's us around the close
// event getting triggered multiple times...
2020-01-25 03:21:45 +03:00
// ...change to .close(..) when fixed...
2020-01-24 18:10:53 +03:00
. one ( 'close' , cb = function ( mode ) {
2019-12-22 02:26:36 +03:00
callback (
// get the field-value pairs...
spec . reduce ( function ( res , e ) {
var id = e . id || e . title
id != undefined
&& ( res [ id ] = e . value instanceof Function ?
e . value . call ( that )
: e . value )
return res } , { } ) ,
// full spec...
// NOTE: technically we do not need to pass this
// through as we are mutating the data inside
// but passing it here is cleaner than forcing
// the user to get it via closure...
spec ,
2020-01-14 18:41:22 +03:00
mode ) } )
2020-01-24 18:10:53 +03:00
// reset the callback on update...
. one ( 'update' , function ( ) {
2020-02-02 05:38:03 +03:00
// NOTE: we need to skip the initial update or it will
// .off(..) the handler right after it got bound...
// ...this will effectively shift the .off(..) stage
// by one iteration...
2020-02-03 23:47:27 +03:00
// XXX feels hacky -- revise...
2020-02-02 05:38:03 +03:00
this . one ( 'update' , function ( ) {
this . off ( 'close' , cb ) } ) } )
2019-12-20 16:56:24 +03:00
return this }
2019-11-24 02:21:17 +03:00
2019-11-18 05:22:57 +03:00
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2019-11-08 21:23:50 +03:00
var EditorActions = actions . Actions ( {
2019-11-09 03:37:13 +03:00
// format:
// {
// <type>: function(id, make, options){},
// ...
// }
//
2019-11-11 04:18:04 +03:00
// NOTE: we are not supporting aliases here as we need to pass strings
// as-is into .makeEditorBlock(..)'s spec to be able to create things
// like '---' -> <hr> and other stuff...
2019-11-14 06:36:14 +03:00
//
// XXX should we support dialog.close(..)'s reject mode???
2019-11-09 03:37:13 +03:00
_ _editor _fields _ _ : {
2019-11-14 00:18:24 +03:00
// Generic field...
2019-11-09 03:37:13 +03:00
//
// options format:
// {
2019-11-14 06:36:14 +03:00
// type: <type>,
//
2019-11-09 03:37:13 +03:00
// // NOTE: if this is not set then the id is used...
// title: <str>,
//
2019-11-13 22:23:21 +03:00
// // value...
// //
// value: <value> | <func([value])>,
//
// // XXX not implemented...
2019-11-09 03:37:13 +03:00
// doc: <str> | <func>,
//
// ...
// }
//
field : function ( actions , make , options ) {
2019-11-14 03:29:30 +03:00
return make ( [
2019-11-13 22:23:21 +03:00
options . title ,
options . value instanceof Function ?
options . value . call ( actions )
// NOTE: when .field(..) is called indirectly via one of
// the other field constructors this will not affect
// the actual .value as options is cloned at this
// point.
// This is an intended side-effect as setup should
// not have any effect on the value...
// XXX revise...
: options . value
2019-11-14 03:29:30 +03:00
] , options ) } ,
2019-11-09 03:37:13 +03:00
2019-11-14 00:18:24 +03:00
// Editable field...
//
2019-11-13 22:23:21 +03:00
// XXX need to set .value...
2019-11-14 00:18:24 +03:00
//editable: function(actions, make, options){},
2019-11-13 22:23:21 +03:00
2019-11-14 00:18:24 +03:00
// value toggle...
//
// options format:
// {
// values: <array> | <func([values])>,
//
2019-11-14 06:36:14 +03:00
// // if true this will only alow setting .value from .values...
// nonstrict: <bool>,
//
2019-11-14 00:18:24 +03:00
// // XXX not implemented...
// value_editable: <bool>,
//
//
// // value list dialog...
// //
// // NOTE: <opts> is a .showList(..) / .showEditableList(..)
// // compatible options object...
// list: false | <opts> | <func(cur, callback(val))>,
//
// list_editable: <bool>,
//
// // XXX not implemented...
// list_button: <str>,
//
//
// // if true will not call make.dialog.update() on value
// // update...
// // XXX revise...
// doNotAutoUpdateDialog: <bool>,
//
2019-11-14 03:29:30 +03:00
// ...
2019-11-14 00:18:24 +03:00
// }
//
2019-11-14 03:29:30 +03:00
//
// NOTE: this extends .filed(..)
2019-11-13 22:23:21 +03:00
toggle : function ( actions , make , options ) {
2019-11-14 03:29:30 +03:00
return this . field ( actions , make ,
2019-11-09 03:37:13 +03:00
Object . assign (
2019-11-14 00:18:24 +03:00
options ,
2019-11-09 03:37:13 +03:00
{
2019-11-13 22:23:21 +03:00
type : 'toggle' ,
open : function ( evt ) {
2019-11-14 06:36:14 +03:00
var getValues = function ( ) {
return options . values instanceof Function ?
2019-11-13 22:23:21 +03:00
options . values . call ( actions )
: options . values ?
options . values
2019-11-14 06:36:14 +03:00
: [ 'off' , 'on' ] }
2019-11-13 22:23:21 +03:00
var set = function ( v ) {
2019-11-14 03:29:30 +03:00
// get current value...
v = arguments . length > 0 ?
v
: options . value instanceof Function ?
options . value . call ( actions )
: options . value
2019-11-13 22:23:21 +03:00
// normalize...
2019-11-14 06:36:14 +03:00
// NOTE: we are re-getting the values here
// as it can get updated in options.list(..)
// or via options.values(..)...
if ( ! options . nonstrict ) {
var values = getValues ( )
v = values . includes ( v ) ?
v
: values [ 0 ] }
2019-11-13 22:23:21 +03:00
// update the value...
2019-11-14 06:36:14 +03:00
// NOTE: we update the local value iff set(..)
// got an explicit value argument...
// calling set(..) will not store anything,
// just update the current state, either to
// the already stored value or to the output
// of .value(..)...
arguments . length > 0
&& ( options . value instanceof Function ?
( v = options . value . call ( actions , v ) )
: ( options . value = v ) )
2019-11-13 22:23:21 +03:00
elem . text ( v )
// update dialog...
options . doNotAutoUpdateDialog
|| make . dialog . update ( ) }
2019-11-14 06:36:14 +03:00
var elem = $ ( this ) . find ( '.text' ) . last ( )
var current = elem . text ( )
var values = getValues ( )
2019-11-13 22:23:21 +03:00
// editable list or more than 2 values -> show value list...
if ( options . list _editable
|| ( values . length > 2
&& options . list !== false ) ) {
// call options.list(..)
if ( options . list instanceof Function ) {
options . list . call ( actions , current , set )
// normal list...
} else {
// XXX mark the current value???
var o = actions [
options . list _editable ?
'showEditableList'
: 'showList' ] (
values ,
Object . assign ( {
path : current ,
open : function ( v ) {
// update value...
// XXX current is [[value]], check
// the upstream if this is correct...
current = v [ 0 ] [ 0 ]
// NOTE: this is done first
// to update values...
o . close ( )
// update callable values...
options . list _editable
&& options . values instanceof Function
&& options . values . call ( actions , values ) } ,
close : function ( ) {
// NOTE: set(..) should be
// called after all the
// dialog stuff is done...
setTimeout ( function ( ) { set ( current ) } ) } ,
} ,
options . list !== true ?
options . list
: { } ) ) }
// directly toggle next value...
} else {
// XXX should we be able to toggle values back???
set ( values [ ( values . indexOf ( current ) + 1 ) % values . length ] ) }
} ,
2019-11-09 03:37:13 +03:00
} ,
2019-11-13 22:23:21 +03:00
options
// normalize value...
. run ( function ( ) {
if ( ! ( this . value instanceof Function ) ) {
var values = options . values instanceof Function ?
options . values . call ( actions )
: options . values ?
options . values
: [ 'off' , 'on' ]
this . value =
this . value === undefined ?
values [ 0 ]
: values . includes ( this . value ) ?
this . value
: this . value ?
'on'
2019-11-14 03:29:30 +03:00
: 'off' } } ) ) ) } ,
2019-11-13 22:23:21 +03:00
2019-11-14 00:18:24 +03:00
// attribute value toggle...
//
2019-11-13 22:23:21 +03:00
// options format:
// {
2019-11-14 03:29:30 +03:00
// // object on which the attribute manipulations are done...
2019-11-14 00:18:24 +03:00
// obj: <obj> | <func>,
2019-11-14 03:29:30 +03:00
//
// // attribute name/key...
2019-11-13 22:23:21 +03:00
// key: <str>,
2019-11-14 00:18:24 +03:00
//
2019-11-14 03:29:30 +03:00
// // attribute values source attribute/key...
// values_key: <key>,
2019-11-14 00:18:24 +03:00
//
2019-11-14 03:29:30 +03:00
//
// // attribute value translation dict/func...
// value_translate:
// <func(value)>
// | {
// <key>: <value>,
// ...
// },
//
//
// // if true the update is made on value change...
2019-11-14 00:18:24 +03:00
// live_update: <bool>,
2019-11-14 03:29:30 +03:00
//
//
// // callback if set, called after an update is made...
2019-11-14 00:18:24 +03:00
// callback: <func(value, values)>,
2019-11-14 03:29:30 +03:00
//
//
// // if set this will not update the config...
// //
// // NOTE: callback(..) is still called so the user can take
// // care of updating manually...
2019-11-14 00:18:24 +03:00
// read_only: <bool>,
2019-11-13 22:23:21 +03:00
//
// ...
// }
//
2019-11-14 03:29:30 +03:00
//
// NOTE: this extends .toggle(..)
2019-11-14 00:18:24 +03:00
attrToggle : function ( actions , make , options ) {
var update = function ( ) {
if ( ! options . read _only ) {
var obj = options . obj instanceof Function ?
options . obj . call ( actions )
: options . obj
'__value' in options
&& ( obj [ options . key ] = options . _ _value )
'__values' in options
&& ( obj [ options . values _key ] = options . _ _values ) }
options . callback
&& options . callback . call ( actions , obj , options . _ _value , options . _ _values ) }
2019-11-14 03:29:30 +03:00
make . dialog
. close ( function ( ) {
options . live _update
|| update ( ) } )
2019-11-14 00:18:24 +03:00
2019-11-14 03:29:30 +03:00
return this . toggle ( actions , make ,
2019-11-11 04:18:04 +03:00
Object . assign (
2019-11-14 00:18:24 +03:00
options ,
2019-11-11 04:18:04 +03:00
{
2019-11-14 00:18:24 +03:00
//__value: null,
2019-11-13 22:23:21 +03:00
value : function ( value ) {
2019-11-14 00:18:24 +03:00
var obj = options . obj instanceof Function ?
options . obj . call ( actions )
: options . obj
2019-11-14 03:29:30 +03:00
var d = options . value _translate
2019-11-14 00:18:24 +03:00
// get...
value = arguments . length > 0 ?
value
: '__value' in options ?
options . _ _value
2019-11-14 03:29:30 +03:00
: d instanceof Function ?
d . call ( actions , obj [ options . key ] )
2019-11-14 00:18:24 +03:00
: d ?
d [ obj [ options . key ] ]
: obj [ options . key ]
// set...
arguments . length != 0
&& ( options . _ _value = value )
// live mode...
&& options . live _update
&& update ( )
2019-11-13 22:23:21 +03:00
return value } ,
2019-11-14 03:29:30 +03:00
2019-11-14 00:18:24 +03:00
//__values: null,
2019-11-13 22:23:21 +03:00
values : function ( value ) {
2019-11-14 00:18:24 +03:00
var obj = options . obj instanceof Function ?
options . obj . call ( actions )
: options . obj
2019-11-13 22:23:21 +03:00
return arguments . length == 0 ?
2019-11-14 00:18:24 +03:00
( '__values' in options ?
options . _ _values
: obj [ options . values _key ] . slice ( ) )
: ( options . _ _values = value ) } ,
} ,
options ) ) } ,
2019-11-14 06:36:14 +03:00
// Toggler-based field...
2019-11-14 03:29:30 +03:00
//
// options format:
// {
// toggler: <toggler-name>,
//
// ...
// }
//
toggler : function ( actions , make , options ) {
var update = function ( ) {
'__value' in options
&& actions [ options . toggler ] ( options . _ _value ) }
make . dialog
. close ( function ( ) {
options . live _update
|| update ( ) } )
return this . toggle ( actions , make ,
Object . assign (
options ,
{
//__value: null,
value : function ( value ) {
// get...
value = arguments . length > 0 ?
value
: '__value' in options ?
options . _ _value
: actions [ options . toggler ] ( '?' )
// set...
arguments . length > 0
&& ( options . _ _value = value )
// live...
options . live _update
&& update ( )
return value } ,
values : function ( value ) {
return actions [ options . toggler ] ( '??' ) } ,
list _editable : false ,
} ,
options ) ) } ,
2019-11-14 00:18:24 +03:00
// Config editable value...
//
// XXX
//configEditable: function(){},
// Config value toggle...
//
2019-11-14 03:29:30 +03:00
// NOTE: this is the same as .attrToggle(..) but sets options.obj
// to actions.config...
2019-11-14 00:18:24 +03:00
configToggle : function ( actions , make , options ) {
2019-11-14 03:29:30 +03:00
return this . attrToggle ( actions , make ,
2019-11-14 00:18:24 +03:00
Object . assign (
options ,
2019-11-14 03:29:30 +03:00
{ obj : function ( ) {
return actions . config } } ,
2019-11-13 22:23:21 +03:00
options ) ) } ,
2019-11-09 03:37:13 +03:00
2019-11-14 00:18:24 +03:00
2019-11-09 03:37:13 +03:00
// XXX todo:
// - date
// - ...
2019-11-08 21:23:50 +03:00
} ,
2019-11-15 17:14:55 +03:00
showEditor : [ '- Interface/' ,
2019-11-12 01:24:22 +03:00
core . doc ` Make editor dialog or editor section...
Make an editor dialog ...
2019-11-15 17:14:55 +03:00
. showEditor ( spec )
. showEditor ( spec , callback )
2019-11-12 01:24:22 +03:00
- > dialog
Make an editor dialog section ...
2019-11-15 17:14:55 +03:00
. showEditor ( make , spec )
. showEditor ( make , spec , callback )
2019-11-12 01:24:22 +03:00
- > make
spec format :
[
// make a simple text element...
//
// same as: make(<text>)
< text > ,
[ < text > ] ,
// call make(..) with args...
//
// same as: make(...[ .. ])
//
// NOTE: to explicitly pass an array object to make wrap it
// in an array, e.g. [['text', 'value']]
[ . . ] ,
// make a field...
{
type : < type > ,
id : < str > ,
title : < str > ,
value : < str > ,
...
} ,
...
]
2019-11-14 15:06:34 +03:00
NOTE : for examples see : . exampleEditor ( . . ) and . exampleEmbededEditor ( . . )
of 'ui-action-examples' feature ...
2019-11-12 01:24:22 +03:00
` ,
2019-11-08 21:23:50 +03:00
makeUIDialog ( function ( spec , callback ) {
2019-11-13 22:23:21 +03:00
var that = this
2019-11-14 03:29:30 +03:00
var _build = function ( make , spec , cb ) {
2019-11-11 04:18:04 +03:00
var that = this
2019-11-14 03:29:30 +03:00
callback = cb
2019-11-11 04:18:04 +03:00
var fields = this . _ _editor _fields _ _
|| EditorActions . _ _editor _fields _ _
|| { }
; ( spec || [ ] )
. forEach ( function ( field ) {
// array...
field instanceof Array ?
make ( ... field )
// spec...
: field instanceof Object ?
2019-11-14 03:29:30 +03:00
fields [ field . type || 'field' ] ( that , make , field )
2019-11-11 04:18:04 +03:00
// other...
: make ( field ) } )
return make }
var _callback = callback
&& function ( spec ) {
return callback (
2019-11-12 01:24:22 +03:00
// get the field-value pairs...
2019-11-11 04:18:04 +03:00
spec . reduce ( function ( res , e ) {
var id = e . id || e . title
id != undefined
2019-11-14 00:18:24 +03:00
&& ( res [ id ] = e . value instanceof Function ?
e . value . call ( that )
: e . value )
2019-11-12 01:24:22 +03:00
return res } , { } ) ,
// NOTE: technically we do not need to pass this
// through as we are mutating the data inside
// but passing it here is cleaner than forcing
// the user to get it via closure...
spec ) }
2019-11-14 03:29:30 +03:00
return arguments [ 0 ] instanceof Function ?
2019-11-11 04:18:04 +03:00
// inline...
2019-11-14 03:29:30 +03:00
_build . call ( this , ... arguments )
2019-11-11 04:18:04 +03:00
// dialog...
: browse . makeLister ( null ,
function ( p , make ) {
2019-11-14 03:29:30 +03:00
_build . call ( that , make , spec , callback )
} , {
2019-11-11 04:18:04 +03:00
cls : 'table-view' ,
2019-11-14 03:29:30 +03:00
close : function ( ) {
_callback
&& _callback ( spec )
// prevent calling the callback more than once...
// XXX fixing a double .close() bug...
_callback = null
} ,
2019-11-14 00:18:24 +03:00
} ) } ) ] ,
2019-11-08 21:23:50 +03:00
} )
var Editor =
module . Editor = core . ImageGridFeatures . Feature ( {
title : '' ,
doc : '' ,
tag : 'ui-editor' ,
depends : [
'ui' ,
2019-11-15 17:14:55 +03:00
'ui-dialogs' ,
2019-11-08 21:23:50 +03:00
] ,
actions : EditorActions ,
} )
2017-07-02 16:42:28 +03:00
/*********************************************************************/
2017-07-11 01:05:39 +03:00
// XXX do not use the global ig for link click handling...
var action2lnk =
module . action2lnk =
function ( action ) {
return ` <a href="#" onclick="ig.showDoc(' ${ action } ')"> ${ action } </a> ` }
// XXX do not use the global ig for link click handling...
var feature2lnk =
module . feature2lnk =
function ( tag ) {
return ` <a href="#" onclick="ig.showFeatureDoc(' ${ tag } ')"> ${ tag } </a> ` }
2017-07-13 18:50:01 +03:00
// XXX needs more cleanup...
var features2lnk =
module . features2lnk =
function ( features , text ) {
features = new RegExp (
2017-07-14 04:26:46 +03:00
'(\\s)('
2017-07-13 18:50:01 +03:00
+ ( features
. sort ( function ( a , b ) { return b . length - a . length } )
. join ( '|' ) )
2017-07-14 04:26:46 +03:00
+ ')([,\\s]?)' ,
2017-07-13 18:50:01 +03:00
'g' )
return text
. replace ( features , function ( match , a , b , c ) {
2019-11-08 21:23:50 +03:00
return a + feature2lnk ( b ) + c } ) }
2017-07-13 18:50:01 +03:00
var js2html =
module . js2html =
2017-07-09 16:46:11 +03:00
function ( doc , skip _linking ) {
skip _linking = skip _linking || [ ]
return doc
// html stuff...
. replace ( /&/g , '&' )
. replace ( /</g , '<' )
. replace ( />/g , '>' )
// 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>' )
2019-11-08 21:23:50 +03:00
. replace ( /XXX/g , '<span class="warning">XXX</span>' ) }
2017-07-13 18:50:01 +03:00
// XXX do not use the global ig for link click handling...
var doc2html =
module . doc2html =
function ( doc , skip _linking ) {
skip _linking = skip _linking || [ ]
return js2html ( doc )
2017-07-09 16:46:11 +03:00
// action links...
. replace ( /(\s)(\.([\w_]+[\w\d_]*)\([^)]*\))/g ,
function ( match , a , b , c ) {
return ( skip _linking == '*' || skip _linking . indexOf ( c ) >= 0 ) ?
` ${ a } <i> ${ b } </i> `
2019-11-08 21:23:50 +03:00
: ` ${ a } <a href="#" onclick="ig.showDoc(' ${ c } ')"> ${ b } </a> ` } ) }
2017-07-09 16:46:11 +03:00
2017-07-02 16:42:28 +03:00
var UIIntrospectionActions = actions . Actions ( {
2017-01-24 06:14:38 +03:00
// Show doc for action...
//
2017-01-29 00:51:13 +03:00
// XXX STUB...
2018-02-11 02:55:28 +03:00
// XXX handle non-action methods...
2017-01-24 05:34:15 +03:00
// XXX this needs to:
// - be a widget
// - handle focus
// - handle keyboard
// - handle search...
2017-01-24 06:14:38 +03:00
// - format action links/references...
// - markdown???
2017-01-24 05:34:15 +03:00
// - ...
2017-01-24 06:14:38 +03:00
// 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...
2017-07-06 02:24:36 +03:00
// XXX might be a good idea to also show feature doc...
2017-01-24 06:14:38 +03:00
showDoc : [ 'Help/Action help...' ,
2017-01-24 05:34:15 +03:00
makeUIDialog ( function ( actions ) {
2017-01-25 23:34:01 +03:00
var that = this
2017-01-29 00:58:25 +03:00
actions = actions || this . actions . sort ( )
2017-01-24 05:34:15 +03:00
actions = actions instanceof Array ? actions : [ actions ]
var doc = this . getDoc ( actions )
2017-07-09 16:46:11 +03:00
2017-01-24 05:34:15 +03:00
var res = $ ( '<div>' )
. addClass ( 'help-dialog' )
actions . forEach ( function ( action ) {
2017-09-06 19:25:17 +03:00
var toggler = that . isToggler ( action )
2017-08-21 20:29:17 +03:00
res . append ( $ ( '<div class="action doc">' )
2017-01-24 05:34:15 +03:00
. prop ( 'tabindex' , true )
2017-01-24 06:14:38 +03:00
. append ( $ ( '<h2>' )
. text ( doc [ action ] [ 2 ] ) )
. append ( $ ( '<i>' )
. text ( doc [ action ] [ 0 ] ) )
2017-01-25 23:34:01 +03:00
. append ( $ ( '<div>' )
2017-09-06 19:25:17 +03:00
. html (
// features...
'Features: ' + that . getHandlerSourceTags ( action )
2017-07-11 01:05:39 +03:00
. map ( feature2lnk )
2017-09-06 19:25:17 +03:00
. join ( ', ' )
// toggler states...
+ ( toggler ?
( '<br>Toggler states: ' + that [ action ] ( '??' ) . join ( ', ' ) )
: '' ) ) )
2017-01-24 05:34:15 +03:00
. append ( $ ( '<hr>' ) )
2017-01-25 23:45:12 +03:00
// parse the action doc...
2017-01-24 06:14:38 +03:00
. append ( $ ( '<pre>' )
2017-07-09 16:46:11 +03:00
. html ( doc2html ( doc [ action ] [ 1 ] || '' , [ action ] ) ) )
// NOTE: we are quoting action in an array here to prevent
// dialog actions from messing up the call...
. append ( $ ( ` <a href="#" onclick="ig.showCode([' ${ action } '])">code...</a> ` ) ) )
} )
return res
} ) ] ,
2017-07-13 18:50:01 +03:00
// XXX make hypertext...
2018-10-31 01:41:42 +03:00
// XXX add specific action doc if available....
2017-07-10 02:48:39 +03:00
showCode : [ '- Help/Show action code...' ,
2017-07-09 16:46:11 +03:00
makeUIDialog ( function ( action ) {
action = action instanceof Array ? action [ 0 ] : action
2017-07-13 18:50:01 +03:00
var features = this . features . FeatureSet . features
|| this . features . features
|| [ ]
2017-07-09 16:46:11 +03:00
return $ ( '<div>' )
. addClass ( 'help-dialog' )
. append ( $ ( '<div class="action">' )
. append ( $ ( '<pre>' )
2017-07-13 18:50:01 +03:00
//.text(this.getHandlerDocStr(action))) )
. html ( features2lnk ( features , js2html ( this . getHandlerDocStr ( action ) ) ) ) ) )
2017-07-09 16:46:11 +03:00
} ) ] ,
showFeatureDoc : [ 'Help/Feature help...' ,
makeUIDialog ( function ( features ) {
features = features || this . features . features
features = features == '*' ? this . features . FeatureSet . features
: features instanceof Array ? features
: [ features ]
var that = this
var featureset = this . features . FeatureSet
var res = $ ( '<div>' )
. addClass ( 'help-dialog' )
var tag2lnk = function ( tag ) {
2017-07-11 01:05:39 +03:00
return tag != '-' ? feature2lnk ( tag ) : '-' }
2017-07-09 16:46:11 +03:00
features . forEach ( function ( tag ) {
var feature = featureset [ tag . startsWith ( '-' ) ? tag . slice ( 1 ) : tag ]
// skip unknown tags...
if ( feature == null ) {
return
}
2017-10-14 14:00:57 +03:00
var exclusive = feature . exclusive
exclusive = exclusive
&& ( exclusive instanceof Array ?
exclusive
: [ exclusive ] )
2017-07-09 16:46:11 +03:00
res . append ( $ ( '<div class="feature">' )
. prop ( 'tabindex' , true )
. append ( $ ( '<h2>' )
. text ( feature . title || tag ) )
. append ( $ ( '<i>' )
. html ( that . features . features . indexOf ( tag ) < 0 ?
'not loaded'
: 'loaded' ) )
. append ( $ ( '<div>' )
. html ( 'Tag: ' + tag2lnk ( tag ) ) )
2017-07-11 01:05:39 +03:00
2017-07-09 16:46:11 +03:00
. append ( $ ( '<div>' )
. html ( 'Priority: ' + ( feature . getPriority ?
feature . getPriority ( true )
: ( feature . priority || 'normal' ) ) ) )
// list exclusive features...
. append ( $ ( '<div>' )
. html ( 'Exclusive tag: '
2017-10-14 14:00:57 +03:00
+ ( exclusive || [ '-' ] )
2017-07-09 16:46:11 +03:00
. map ( function ( tag ) {
if ( tag == '-' ) {
return tag
}
var tags = featureset . getExclusive ( tag ) [ tag ] . join ( '\', \'' )
return ` <a href="#" onclick="ig.showFeatureDoc([' ${ tags } '])"> ${ tag } </a> `
2017-01-25 23:45:12 +03:00
} )
2017-07-09 16:46:11 +03:00
. join ( ', ' ) ) )
. append ( $ ( '<div>' )
. html ( 'Depends: '
+ ( feature . depends || [ '-' ] )
. map ( tag2lnk )
. join ( ', ' ) ) )
. append ( $ ( '<div>' )
. html ( 'Suggests: '
+ ( feature . suggested || [ '-' ] )
. map ( tag2lnk )
. join ( ', ' ) ) )
2017-07-11 01:05:39 +03:00
// list actions, props and handlers...
. append ( $ ( '<hr>' ) )
. append ( $ ( '<div>' )
. html ( 'Props: <i>not implemented</i>' ) )
. append ( $ ( '<div>' )
. html ( 'Actions: '
+ Object . keys ( feature . actions || { '-' : null } )
. filter ( function ( n ) {
return n == '-'
|| ( Object . getOwnPropertyDescriptor ( feature . actions , n ) || { } ) . value instanceof actions . Action } )
. map ( function ( n ) {
return n == '-' ? n : action2lnk ( n ) } )
. join ( ', ' ) ) )
. append ( $ ( '<div>' )
. html ( 'Handlers: '
+ ( feature . handlers || [ [ '-' ] ] )
. map ( function ( h ) { return h [ 0 ] instanceof Array ? h [ 0 ] : [ h [ 0 ] ] } )
2018-11-15 00:42:16 +03:00
. flat ( )
2017-07-11 01:05:39 +03:00
. unique ( )
. map ( function ( n ) {
return n == '-' ? n : action2lnk ( n ) } )
. join ( ', ' ) ) )
2017-07-09 16:46:11 +03:00
// doc...
. append ( $ ( '<hr>' ) )
. append ( $ ( '<pre>' )
. html ( doc2html ( feature . doc || '' ) ) ) )
2017-01-24 05:34:15 +03:00
} )
return res
} ) ] ,
2017-01-21 23:39:41 +03:00
2017-07-06 02:24:36 +03:00
// XXX might be a good idea to add feature doc/help browser like showDoc(..)
2017-07-12 16:51:33 +03:00
// XXX show more info about features...
2017-07-02 16:42:28 +03:00
// .title
2017-07-12 16:51:33 +03:00
// .doc (short)
2017-07-06 02:24:36 +03:00
// XXX might be nice to load/unload features from here...
// this can be done by add explicitly to input (with or without
// the '-' prefix and) and reloading (re-running setup(..))...
// XXX not sure where to put this -- help or system?
// ...if we add feature doc browsing it's help, of feature
// loading/unloading then system...
// ...might be a good idea to split the two functions, like the
// keyboard help/edit UI's...
showFeatures : [ 'Help|System/Features...' ,
2017-07-02 16:42:28 +03:00
core . doc ` Show feature load information... ` ,
2016-04-30 03:38:52 +03:00
makeUIDialog ( function ( ) {
2017-07-02 16:42:28 +03:00
var that = this
2017-07-10 02:48:39 +03:00
2017-07-11 01:05:39 +03:00
return browse
. makeLister ( null , function ( path , make ) {
var features = that . features || { }
// XXX get feature doc...
var draw = function ( heading , list ) {
make . Heading ( heading )
; ( list || [ ] )
. forEach ( function ( tag ) {
2017-12-29 02:33:22 +03:00
make ( tag , {
attrs : {
feature : tag ,
root : no _deps . indexOf ( tag ) >= 0 ? 'true' : '' ,
} ,
open : function ( ) { that . showFeatureDoc ( tag ) } ,
} )
2017-07-11 01:05:39 +03:00
} ) }
2017-12-29 02:33:22 +03:00
// features that have no direct dependencies...
var no _deps = that . features . features . filter ( function ( f ) {
return ( that . features . depends [ f ] || [ ] ) . length == 0 } )
2017-07-11 01:05:39 +03:00
draw ( 'Loaded (in order)' , that . features . features )
draw ( 'Excluded' , that . features . excluded )
draw ( 'Disabled' , that . features . disabled )
draw ( 'Not applicable' , that . features . unapplicable )
if ( features . error ) {
var error = features . error
error . missing _suggested && error . missing _suggested . length > 0
&& draw ( 'Missing (non-critical)' , error . missing _suggested )
error . missing && error . missing . length > 0
&& draw ( 'Missing (critical)' , error . missing )
// XXX loops...
// XXX conflicts...
}
2017-12-29 02:33:22 +03:00
} , {
cls : 'feature-list' ,
2017-07-11 01:05:39 +03:00
} )
. run ( function ( ) {
// handle '?' button to browse path...
this . showDoc = function ( ) {
var feature = this . select ( '!' ) . attr ( 'feature' )
feature
&& that . showFeatureDoc ( feature )
}
this . keyboard . handler ( 'General' , '?' , 'showDoc' )
} )
2016-04-30 03:38:52 +03:00
} ) ] ,
2016-11-08 17:30:40 +03:00
2017-07-02 16:42:28 +03:00
// XXX is this the right way to go???
// XXX should this pe a separate feature???
about : [ 'Help/$About...' ,
{ 'dialogTitle' : 'ImageGrid.Viewer' } ,
makeUIDialog ( function ( path , options ) {
return browse . makeList (
null ,
[
// XXX add basic description (About)...
2018-01-12 21:59:08 +03:00
[ 'Version:' , this . version ] ,
2017-07-02 16:42:28 +03:00
// XXX
[ 'Build:' , '-' ] ,
'---' ,
// XXX load the license file...
[ 'License:' , 'Pre Release' ] ,
// XXX include other lib list and license info...
// XXX
// XXX include nw credits.html...
// XXX
] , {
cls : 'table-view'
} )
} ) ] ,
2017-07-08 00:08:33 +03:00
// XXX EXPERIMENTAL...
featureGraph : [ '- Help/Generate feature graph (graphviz format)' ,
2017-07-09 16:46:11 +03:00
core . doc ` Generate feature dependency graph in the graphviz format. ` ,
2017-07-08 00:08:33 +03:00
function ( ) {
return this . features . FeatureSet . gvGraph ( this . features . features ) } ] ,
2016-04-30 03:38:52 +03:00
} )
2017-07-02 16:42:28 +03:00
var UIIntrospection =
module . UIIntrospection = core . ImageGridFeatures . Feature ( {
2016-04-30 03:38:52 +03:00
title : '' ,
doc : '' ,
2017-07-02 16:42:28 +03:00
tag : 'ui-introspection' ,
2016-04-30 03:38:52 +03:00
depends : [
'ui' ,
2017-07-02 16:42:28 +03:00
'ui-dialogs' ,
2016-04-30 03:38:52 +03:00
] ,
2017-07-02 16:42:28 +03:00
actions : UIIntrospectionActions ,
2016-04-30 03:38:52 +03:00
} )
2017-07-02 16:42:28 +03:00
//---------------------------------------------------------------------
2016-04-30 03:38:52 +03:00
// NOTE: yes, this is a funny name ;)
2016-05-15 03:19:38 +03:00
//
// XXX should we also add a hide-path config feature???
2015-12-17 03:44:07 +03:00
var BrowseActionsActions = actions . Actions ( {
2015-12-17 03:34:20 +03:00
config : {
2018-12-01 14:38:11 +03:00
// XXX need to define an interface verb/keyword language and use
// it to sort an prioritize stuff...
2015-12-17 03:34:20 +03:00
'action-category-order' : [
2017-01-28 01:09:05 +03:00
'99:$File' ,
2017-08-23 19:52:17 +03:00
// We can order any sub-tree we want in the same manner
// as the root...
2016-05-14 22:50:26 +03:00
'File/-80:Clear viewer' ,
'File/-90:Close viewer' ,
2017-08-23 19:52:17 +03:00
// Non existing elements will not get drawn...
2016-05-15 03:19:38 +03:00
//'File/-99:moo',
2018-12-01 14:38:11 +03:00
// XXX this seems over-crowded -- revise!!!
2017-09-06 07:20:31 +03:00
'99:$Edit' ,
2018-12-01 14:38:11 +03:00
'Edit/90:Undo' ,
'Edit/90:Redo' ,
'Edit/85:.*base.*' ,
'Edit/80:.*sort.*' ,
'Edit/80:.*order.*' ,
'Edit/75:.*group.*' ,
'Edit/70:.*shift.*marked.*' ,
'Edit/70:.*shift.*' ,
'Edit/60:.*rotate.*' ,
'Edit/50:.*flip.*' ,
2017-09-06 07:20:31 +03:00
'$Navigate' ,
2018-12-01 14:38:11 +03:00
'Navigate/90:.*image.*' ,
'Navigate/80:.*screen.*' ,
'Navigate/70:.*ribbon.*' ,
2017-09-06 07:20:31 +03:00
'$Image' ,
2018-12-01 14:38:11 +03:00
'Image/98:.*editor.*' ,
'Image/98:.*folder.*' ,
'Image/95:.*metadata.*' ,
'Image/90:.*image mark.*' ,
'Image/85:.*image bookmark.*' ,
'Image/80:.*tags.*' ,
'Image/75:.*image.*collection.*' ,
'Image/70:.*shift.*marked.*' ,
'Image/65:.*shift.*' ,
'Image/60:.*rotate.*' ,
'Image/55:.*flip.*' ,
2017-09-09 01:40:31 +03:00
'Image/-70:---' ,
'Image/-70:.*remove.*' ,
2019-10-12 06:38:48 +03:00
'$Virtual block' ,
2019-10-25 01:25:48 +03:00
'Virtual block/90:.*add.*' ,
'Virtual block/80:.*clone.*' ,
'Virtual block/70:.*edit.*' ,
'Virtual block/60:.*mark.*' ,
'Virtual block/50:---' ,
'Virtual block/40:.*crop.*' ,
2017-09-06 07:20:31 +03:00
'$Ribbon' ,
2017-09-09 01:40:31 +03:00
'Ribbon/-70:---' ,
'Ribbon/-70:.*remove.*' ,
2017-09-06 07:20:31 +03:00
'$Crop' ,
2017-01-30 00:11:57 +03:00
'Crop/80:Crop $marked images' ,
'Crop/80:Crop $bookmarked images' ,
2017-08-23 20:11:42 +03:00
'Crop/70:$Crop' ,
'Crop/70:$Flatten' ,
2017-08-23 19:52:17 +03:00
// Path patterns...
//
// Patters must contain ".*" and are case-insensitive...
//
// NOTE: patterns are used to override priorities of all
// the matching paths...
2017-08-23 20:11:42 +03:00
// NOTE: intersecting patterns are handled in order of
// occurrence thus a more general pattern may
// "shadow" all the compatible but less general
// patterns after it...
// XXX this may get fixed in the future, but currently
// this is not a bug...
2017-08-23 19:52:17 +03:00
'Crop/60:crop .*ribbon.*' ,
2018-11-16 04:08:00 +03:00
'Crop/60:.*tag.*' ,
2017-08-23 19:52:17 +03:00
// The rest of the elements in the path will get added
// between the positive and negative prioritized items...
2016-12-29 23:23:05 +03:00
// ...
2017-08-23 19:57:27 +03:00
2017-09-06 07:20:31 +03:00
/*/ We can also add separators here ...
2017-08-23 19:57:27 +03:00
// NOTE: the separator is the only element in a level
// that can be used multiple times.
// ...any other elements with identical text will
// get overwritten by the last occurrence...
'Crop/-50:---' ,
'Crop/-60:.*collection.*' ,
'Crop/-70:---' ,
2017-09-06 07:20:31 +03:00
//*/
2017-08-23 19:52:17 +03:00
2018-11-16 04:08:00 +03:00
'Crop/-50:---' ,
'Crop/-60:Remove from crop' ,
'Crop/-70:Remove ribbon.*' ,
'Crop/-71:Remove marked.*' ,
'Crop/-72:.*remove.*' ,
'Crop/-75:---' ,
2017-09-08 22:29:45 +03:00
2018-11-16 04:08:00 +03:00
'Crop/-80:Uncrop keeping image order' ,
2016-12-29 23:23:05 +03:00
'Crop/-81:Uncrop all' ,
2017-01-30 00:11:57 +03:00
'Crop/-82:$Uncrop' ,
2018-11-09 05:39:51 +03:00
'Co$llections' ,
2017-12-25 05:00:46 +03:00
'Collections/-50:.*exit.*' ,
2017-12-12 17:50:11 +03:00
'Collections/-60:.*edit.*' ,
2017-09-09 01:22:30 +03:00
'Collections/-70:---' ,
2017-09-09 01:40:31 +03:00
'Collections/-70:.*remove.*' ,
2018-11-09 05:39:51 +03:00
'$Tag' ,
// XXX revise...
'Tag/-80:---' ,
'Tag/-90:.*remove.*' ,
2017-04-23 16:11:23 +03:00
'$Mark' ,
2017-12-23 01:08:49 +03:00
'Mark/-75:.*collection...' ,
2017-09-09 13:47:33 +03:00
'Mark/-80:---' ,
'Mark/-80:.*remove.*' ,
'Mark/-90:.*unmark.*' ,
2017-04-23 16:11:23 +03:00
'$Bookmark' ,
2017-09-09 13:47:33 +03:00
'Bookmark/-80:---' ,
'Bookmark/-80:.*remove.*' ,
2017-04-23 16:11:23 +03:00
2017-01-30 05:01:50 +03:00
// ...
2017-04-23 16:11:23 +03:00
2017-01-11 22:32:16 +03:00
'-40:Interface' ,
2019-12-30 00:41:35 +03:00
'Interface/90:Theme' ,
2017-01-28 01:09:05 +03:00
'-50:$Workspace' ,
2017-01-11 22:32:16 +03:00
'-60:System' ,
2017-01-28 01:09:05 +03:00
'-70:$Help' ,
2016-12-30 04:24:38 +03:00
'-80:---' ,
'-90:Development' ,
2018-04-12 01:40:26 +03:00
'-90:Experimental' ,
2016-05-14 03:59:06 +03:00
'-90:Test' ,
2015-12-17 03:34:20 +03:00
] ,
'browse-actions-settings' : {
2016-12-30 03:21:09 +03:00
showDisabled : true ,
showHidden : false ,
2016-05-14 03:59:06 +03:00
showEmpty : false ,
2015-12-17 03:34:20 +03:00
} ,
2017-01-03 02:55:25 +03:00
2017-04-25 17:10:40 +03:00
'browse-actions-keys' : 'on' ,
2017-01-28 01:09:05 +03:00
'browse-actions-shortcut-marker' : '\\$(\\w)' ,
2019-12-31 04:26:55 +03:00
//'browse-advanced-mode': undefined,
2015-12-17 03:34:20 +03:00
} ,
2017-08-21 20:29:17 +03:00
// Hide .alias(..) action from the browser...
//
// NOTE: we need to do this as .alias(..) is defined in actions and
// has no concept of the naming protocols used in ImageGrid.Viewer
2018-03-24 16:00:06 +03:00
// NOTE: this essentially defines and empty alias and puts it in
// 'System/' hidden...
2017-08-10 03:28:10 +03:00
alias : [ '- System/' , '' ] ,
2018-04-09 04:58:26 +03:00
// NOTE: we are avoiding handling the lister actions here (action
2018-03-25 12:33:48 +03:00
// paths ending with '*') as they are active while .getActions(..)
// should be as independent as possible and never trigger any
// side-effects...
// ...the same can be said about handling visibility tests.
2018-04-01 12:57:21 +03:00
// XXX REVISE:
// ...considering that listers should have no side-effects
// (on list), not listing here may be too "defensive"...
// ...on the other hand this could be done via an extra
// action/function that would expand active stuff (renaming
// this to .getActionsPassive(..) and that to .getActionsActive(..))
2018-03-25 00:14:01 +03:00
getActions : [ '- System/' ,
2018-03-24 16:00:06 +03:00
core . doc ` List actions in action tree...
2017-08-10 03:28:10 +03:00
2018-03-24 16:00:06 +03:00
Build tree and return it ...
2018-03-25 00:14:01 +03:00
. getActions ( 'raw' [ , tree ] )
2018-03-24 16:00:06 +03:00
- > tree
2017-08-23 19:52:17 +03:00
2018-03-24 16:00:06 +03:00
Get sup - tree / action at path ...
2018-03-25 00:14:01 +03:00
. getActions ( path [ , tree ] )
2018-03-24 16:00:06 +03:00
- > sub - tree
- > action
2017-01-04 19:05:19 +03:00
2018-03-24 16:00:06 +03:00
This is used by . browseActions ( . . ) to list the actions to be
drawn in the action menu .
2017-01-28 01:09:05 +03:00
2018-03-24 16:00:06 +03:00
Action tree format :
{
// sub-tree...
< name > : < tree > ,
// action...
< name > : [
< action - name > ,
// mode...
'disabled' | 'hidden' ,
] ,
...
2017-01-04 19:05:19 +03:00
}
2018-03-24 16:00:06 +03:00
` ,
function ( path , tree ) {
var actions = this
2017-01-04 19:05:19 +03:00
2018-03-24 16:00:06 +03:00
var PRIORITY = /^(-?[0-9]+)\s*:\s*/
var MARKER = RegExp ( this . config [ 'browse-actions-shortcut-marker' ] , 'g' )
2017-01-03 02:55:25 +03:00
2018-03-24 19:13:59 +03:00
// Sort tree level in-place...
//
2018-03-25 01:48:20 +03:00
// NOTE: this will remove the priority unless raw_keys is set...
2018-03-25 12:33:48 +03:00
var sortTree = function ( tree , raw _keys ) {
2018-03-24 19:13:59 +03:00
var level = Object . keys ( tree )
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
// other - keep order
. sort ( function ( a , b ) {
var ai = PRIORITY . exec ( a )
ai = ai ? ai . pop ( ) * 1 : null
ai = ai > 0 ? - ai
: ai < 0 ? - ai + level . length
: 0
var bi = PRIORITY . exec ( b )
bi = bi ? bi . pop ( ) * 1 : null
bi = bi > 0 ? - bi
: bi < 0 ? - bi + level . length
: 0
return ai == bi ?
level . indexOf ( a ) - level . indexOf ( b )
: ai - bi
} )
. forEach ( function ( key ) {
var text = ! raw _keys ?
key . replace ( PRIORITY , '' ) . trim ( )
: key
2018-03-25 00:14:01 +03:00
// remove the key form old position...
2018-03-24 19:13:59 +03:00
var value = tree [ key ]
delete tree [ key ]
2018-03-25 00:14:01 +03:00
// skip patterns...
if ( ! raw _keys && /\.\*/ . test ( key ) ) {
return
}
// place the key in correct order...
2018-03-24 19:13:59 +03:00
tree [ text ] = value
// go down the tree...
2018-03-25 12:33:48 +03:00
value
2018-03-24 19:13:59 +03:00
&& ! ( value instanceof Array )
2018-03-25 12:33:48 +03:00
&& sortTree ( value , raw _keys )
2018-03-24 19:13:59 +03:00
} )
return tree
}
2016-05-14 22:50:26 +03:00
// Get item from tree level taking into account additional
// syntax like prioority...
2018-03-24 19:13:59 +03:00
//
2016-05-14 03:59:06 +03:00
// returns:
// [<existing-text>, <new-level>]
var getItem = function ( level , text ) {
// direct match...
if ( text in level ) {
return [ text , level [ text ] ]
2017-08-23 19:52:17 +03:00
// check if it's a priority path or a pattern...
2016-05-14 03:59:06 +03:00
} else {
2017-08-23 19:52:17 +03:00
var t = text . replace ( PRIORITY , '' )
t = ( MARKER ? t . replace ( MARKER , '$1' ) : t ) . trim ( )
2017-02-09 16:44:09 +03:00
2016-05-14 03:59:06 +03:00
for ( var e in level ) {
2017-08-23 19:52:17 +03:00
var n = e . replace ( PRIORITY , '' )
n = ( MARKER ? n . replace ( MARKER , '$1' ) : n ) . trim ( )
2017-01-28 01:09:05 +03:00
2017-02-09 16:44:09 +03:00
if ( n == t ) {
2016-05-14 03:59:06 +03:00
return [ e , level [ e ] ]
}
2017-08-23 19:52:17 +03:00
// check pattern...
var p = /\.\*/ . test ( n ) ? new RegExp ( '^' + n + '$' , 'i' ) : null
if ( p && p . test ( t ) ) {
// override item priority from pattern...
var pr = PRIORITY . exec ( e )
pr = pr ? pr . pop ( ) + ':' : ''
return [ pr + text . replace ( PRIORITY , '' ) , level [ e ] ]
}
2016-05-14 03:59:06 +03:00
}
}
return [ ]
}
2016-05-14 22:50:26 +03:00
2018-03-24 16:00:06 +03:00
// Tree builder...
2018-03-24 19:13:59 +03:00
//
2018-03-24 16:00:06 +03:00
var buildTree = function ( path , leaf , action , mode , tree ) {
path = path . slice ( )
// build leaf...
if ( path . length == 0 ) {
// handle "|" in leavs...
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 )
} )
}
// if no tree is given, build one...
if ( tree == null ) {
tree = { }
// pre-order the main categories...
// NOTE: pre_order can be a list of long paths...
var s = ''
var pre _order = ( this . config [ 'action-category-order' ] || [ ] )
. map ( function ( p , i ) {
// make all separators unique...
// ...this will prevent us from losing or merging them.
if ( p . trimRight ( ) . endsWith ( '---' ) ) {
s += '-'
p = p . trimRight ( ) + s
}
return p
} )
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 ( /^-\s*/ )
var path = mode . pop ( )
mode = mode . length > 0 ? 'hidden' : null
path = path . split ( /[\\\/]/g )
var leaf = path . pop ( )
buildTree ( path , leaf , action , mode , tree )
} )
2018-03-24 19:13:59 +03:00
// sort the tree...
2018-03-25 01:48:20 +03:00
sortTree ( tree , path == 'raw' )
2018-03-24 16:00:06 +03:00
}
// return the raw tree...
if ( path == 'raw' ) {
return tree
}
// prepare path...
path = path || '/'
path = ( path instanceof Array ? path : path . split ( /[\\\/]/g ) )
. filter ( function ( e ) { return e . trim ( ) != '' } )
// get the tree node...
var cur = tree
var rest = path . slice ( )
while ( rest . length > 0 && ! ( '*' in cur ) ) {
cur = getItem ( cur , rest . shift ( ) ) . pop ( ) || { }
}
return cur
} ] ,
// XXX can we do a deep search on '/' -- find any nested action???
// ...or rather a search from this level and down...
// XXX can this also do a flat mode???
// ...this would help with the (global) search -- switch to
// flat if searching in root mode...
2019-12-30 00:41:35 +03:00
browseActions : [ 'Interface/Dialog/Actions...' ,
{ browseMode : 'toggleBrowseActionKeys' } ,
2018-03-24 16:00:06 +03:00
core . doc ` Browse actions dialog...
This uses action definition to build and present an action tree .
This supports the following element ( action doc ) syntax :
- '/' separated action path ( action short doc ) to indicate the
path to action .
- 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 .
- leading '-' in path to indicate a hidden / disabled element .
Example :
'- Path/To/Element' ( disabled / hidden )
'- 99:Path/To/Element' ( disabled / hidden )
'Path/To/Other element' ( enabled )
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 ,
2018-03-25 00:14:01 +03:00
// if true then the action tree will get rebuilt live on
// each list navigation...
2018-03-30 14:50:22 +03:00
live _tree : true ,
2018-03-24 16:00:06 +03:00
}
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 ...
` ,
makeUIDialog ( function ( path , options ) {
var actions = this
2018-03-30 14:50:22 +03:00
options = Object . assign ( {
// defaults...
no _disabled : false ,
no _hidden : false ,
live _tree : true ,
} , options || { } )
2018-03-24 16:00:06 +03:00
var MARKER = RegExp ( this . config [ 'browse-actions-shortcut-marker' ] , 'g' )
// 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 ( ' / ' ) }
2017-01-03 02:55:25 +03:00
// Get action browse mode (disabled or hidden)...
2018-03-26 13:28:25 +03:00
//
// NOTE: this will cache and reuse action's browseMode, this
// will make things faster when lots of actions use the
// same mode test (alias)...
2018-03-25 12:33:48 +03:00
var mode _cache = { }
2016-12-31 23:30:14 +03:00
var getMode = function ( action ) {
var m = action
var visited = [ m ]
2018-03-25 12:33:48 +03:00
var last
2016-12-31 23:30:14 +03:00
2018-03-26 13:28:25 +03:00
// check cache...
if ( m in ( mode _cache || { } ) ) {
return mode _cache [ m ]
}
2016-12-31 23:30:14 +03:00
// handle aliases...
do {
2018-03-25 12:33:48 +03:00
last = m
2017-01-03 02:55:25 +03:00
m = actions . getActionAttr ( m , 'browseMode' )
2018-03-26 13:28:25 +03:00
// check cache...
if ( m in ( mode _cache || { } ) ) {
return mode _cache [ m ]
}
2016-12-31 23:30:14 +03:00
// check for loops...
if ( m && visited [ m ] != null ) {
m = null
break
}
visited . push ( m )
} while ( typeof ( m ) == typeof ( 'str' ) )
2018-03-25 12:33:48 +03:00
//return m ? m.call(actions) : undefined
return m ?
2018-03-26 13:28:25 +03:00
// no cache...
2018-03-25 12:33:48 +03:00
( mode _cache == null ?
m . call ( actions )
2018-03-26 13:28:25 +03:00
// cache hit...
2018-03-25 12:33:48 +03:00
: last in mode _cache ?
mode _cache [ last ]
2018-03-26 13:28:25 +03:00
// call check and populate cache...
: ( mode _cache [ action ] =
mode _cache [ last ] =
m . call ( actions ) ) )
2018-03-25 12:33:48 +03:00
: undefined
2016-12-31 23:30:14 +03:00
}
2016-05-14 22:50:26 +03:00
// Wait for dialog...
2018-03-09 17:51:27 +03:00
var waitFor = function ( dialog , child ) {
2016-05-14 01:46:43 +03:00
// we got a widget, wait for it to close...
2016-05-14 03:59:06 +03:00
if ( child instanceof widget . Widget ) {
2016-05-14 01:46:43 +03:00
child
2017-01-24 00:14:31 +03:00
. on ( 'close' , function ( evt , reason ) {
reason != 'reject'
2017-01-24 04:07:13 +03:00
&& dialog . close ( reason ) } )
2016-05-14 03:59:06 +03:00
// if it's not a dialog, don't wait...
} else {
2017-01-22 01:39:46 +03:00
dialog . close ( )
2016-05-14 01:46:43 +03:00
}
2016-05-14 03:59:06 +03:00
2016-05-14 01:46:43 +03:00
return child
2018-03-09 17:51:27 +03:00
} . bind ( this )
2016-05-14 01:46:43 +03:00
2018-03-24 16:00:06 +03:00
// pre-cache the action tree...
2018-03-25 00:14:01 +03:00
var tree = ! options . live _tree ?
2018-03-25 01:48:20 +03:00
actions . getActions ( '/' )
2018-03-25 00:14:01 +03:00
: null
2016-05-14 03:59:06 +03:00
2016-05-14 01:46:43 +03:00
// now for the dialog...
2018-03-09 17:51:27 +03:00
return browse . makeLister ( null , function ( path , make ) {
2016-05-13 23:44:09 +03:00
var that = this
2018-03-25 00:14:01 +03:00
var cur = actions . getActions ( path . slice ( ) , tree )
2016-05-13 23:44:09 +03:00
2018-03-25 12:33:48 +03:00
// reset mode cache...
// NOTE: we reset the cache to allow state changes while
// navigating...
mode _cache = { }
2016-05-14 22:50:26 +03:00
// render current level...
// NOTE: we can be at one of several level types, each
// is rendered in a different way...
2016-05-13 23:44:09 +03:00
2016-05-14 22:50:26 +03:00
// Level: toggler states -- get states and list them...
2016-05-13 23:44:09 +03:00
if ( cur instanceof Array
&& actions . isToggler && actions . isToggler ( cur [ 0 ] ) ) {
var action = cur [ 0 ]
2016-12-30 03:21:09 +03:00
var mode = cur [ 1 ]
2016-12-29 23:23:05 +03:00
2016-12-30 03:21:09 +03:00
// handle live modes...
2016-12-31 23:30:14 +03:00
mode = mode || getMode ( action )
2016-12-29 23:23:05 +03:00
2016-05-13 23:44:09 +03:00
var cur _state = actions [ action ] ( '?' )
var states = actions [ action ] ( '??' )
// handle on/off togglers...
2016-05-14 01:46:43 +03:00
// XXX should the toggler directly return 'on'/'off'???
2016-05-13 23:44:09 +03:00
if ( states . length == 2
&& states . indexOf ( 'none' ) >= 0
&& ( cur _state == 'on' || cur _state == 'off' ) ) {
states = [ 'on' , 'off' ]
}
2017-01-22 01:39:46 +03:00
// build toggler states...
2016-05-13 23:44:09 +03:00
states . forEach ( function ( state ) {
2016-12-30 03:21:09 +03:00
make ( state , {
2017-11-13 23:38:16 +03:00
// 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' ,
cls : [
state == cur _state ? 'selected highlighted' : '' ,
mode == 'hidden' ? mode : ''
] . join ( ' ' ) ,
attrs : {
// XXX need to normalize state -- comments, whitespace, etc...
keys : getKeys ( action + ': "' + state + '"' ) ,
} ,
events : {
open : function ( ) {
options . callback ?
options . callback . call ( actions , action )
: actions [ action ] ( state )
that . pop ( )
} ,
} ,
} )
2016-05-13 23:44:09 +03:00
} )
2016-05-14 22:50:26 +03:00
// Level: lister -- hand control to lister...
// NOTE: path might be a partial path, the rest of it is
// handled by the lister...
2016-05-13 23:44:09 +03:00
} else if ( '*' in cur ) {
actions [ cur [ '*' ] [ 0 ] ] ( path , make )
2016-05-14 22:50:26 +03:00
// Level: normal -- list actions...
2016-05-13 23:44:09 +03:00
} else {
2018-03-25 00:14:01 +03:00
Object . keys ( cur )
2016-05-13 23:44:09 +03:00
. forEach ( function ( key ) {
2016-05-14 22:50:26 +03:00
// Item: action...
2016-05-13 23:44:09 +03:00
if ( cur [ key ] instanceof Array ) {
var action = cur [ key ] [ 0 ]
2016-12-30 03:21:09 +03:00
var mode = cur [ key ] [ 1 ]
2016-05-13 23:44:09 +03:00
2016-12-30 03:21:09 +03:00
// handle live modes...
2016-12-31 23:30:14 +03:00
mode = mode || getMode ( action )
2016-12-29 23:23:05 +03:00
2016-05-14 22:50:26 +03:00
// Action: toggler -> add toggle button...
2016-05-13 23:44:09 +03:00
if ( actions . isToggler && actions . isToggler ( action ) ) {
2018-03-25 00:14:01 +03:00
make ( key + '/' , {
2017-11-13 23:38:16 +03:00
cls : mode == 'hidden' ? mode : '' ,
2016-12-30 03:21:09 +03:00
// NOTE: if something is hidden
// it is also disabled...
// ...this is by design.
2017-01-22 01:39:46 +03:00
disabled : options . no _disabled ?
false
: ( mode == 'hidden' || mode == 'disabled' ) ,
hidden : options . no _hidden ?
false
: mode == 'hidden' ,
2017-11-13 23:38:16 +03:00
attrs : {
keys : getKeys ( action ) ,
action : action ,
} ,
2016-05-13 23:44:09 +03:00
buttons : [
[ actions [ action ] ( '?' ) ,
function ( ) {
actions [ action ] ( )
that . update ( )
2018-03-25 00:14:01 +03:00
that . select ( '"' + key + '"' )
2017-01-03 02:55:25 +03:00
} ] ,
//[getKeys(action)],
2017-11-13 23:38:16 +03:00
] ,
open : function ( ) {
2017-01-22 01:39:46 +03:00
options . callback ?
options . callback . call ( actions , action )
: actions [ action ] ( )
2016-05-14 01:46:43 +03:00
2016-05-13 23:44:09 +03:00
that . update ( )
2018-03-25 00:14:01 +03:00
that . select ( '"' + key + '"' )
2017-11-13 23:38:16 +03:00
} ,
} )
2016-05-13 23:44:09 +03:00
2016-05-14 22:50:26 +03:00
// Action: normal...
2016-05-13 23:44:09 +03:00
} else {
2018-03-25 00:14:01 +03:00
make ( key , {
2016-12-30 03:21:09 +03:00
// NOTE: if something is hidden
// it is also disabled...
// ...this is by design.
2017-01-22 01:39:46 +03:00
disabled : options . no _disabled ?
false
: ( mode == 'hidden' || mode == 'disabled' ) ,
hidden : options . no _hidden ?
false
: mode == 'hidden' ,
2017-11-13 23:38:16 +03:00
attrs : {
keys : getKeys ( action ) ,
action : action ,
} ,
open : function ( ) {
options . callback ?
options . callback . call ( actions , action )
2018-03-09 17:51:27 +03:00
: waitFor ( make . dialog , actions [ action ] ( ) )
2017-11-13 23:38:16 +03:00
} ,
2016-05-13 23:44:09 +03:00
} )
}
2016-05-14 22:50:26 +03:00
// Item: dir...
2018-03-25 12:33:48 +03:00
// XXX need to check if this is empty...
// ...do not draw if nothing will be visible inside...
// XXX this will hide non-empty dirs containing only hidden stuff
// ...should such dirs still be treated as empty???
2016-05-14 03:59:06 +03:00
} else if ( actions . config [ 'browse-actions-settings' ] . showEmpty
|| ( cur [ key ] != null
&& Object . keys ( cur [ key ] ) . length > 0 ) ) {
2018-03-25 00:14:01 +03:00
var p = '/' + path . concat ( [ key ] ) . join ( '/' ) + '/'
2017-08-23 19:52:17 +03:00
p = MARKER ? p . replace ( MARKER , '$1' ) : p
2018-03-25 00:14:01 +03:00
make ( key + '/' , {
2017-11-13 23:38:16 +03:00
push _on _open : true ,
attrs : {
2017-01-28 01:09:05 +03:00
keys : [
getKeys ( 'browseActions: "' + p + '"' ) ,
getKeys ( 'browseActions!: "' + p + '"' ) ,
] . filter ( function ( e ) { return e . trim ( ) != '' } ) . join ( ' / ' ) ,
2017-11-13 23:38:16 +03:00
} ,
2018-03-26 01:10:32 +03:00
// hide dirs containing only hidden stuff...
2018-03-25 12:33:48 +03:00
// XXX this will only check statically hidden stuff...
// ...the rest may still get dynamically hidden...
hidden : options . no _hidden ?
false
2018-03-26 01:10:32 +03:00
// hide dirs containing only (statically)
// hidden items...
// NOTE: we are not checking browseMode
// of other items actively here at
// this point to avoid side-effects...
2018-03-25 12:33:48 +03:00
: Object . keys ( cur [ key ] )
. filter ( function ( k ) {
return ( cur [ key ] [ k ] || [ ] ) [ 1 ] != 'hidden' } )
. length == 0 ,
2017-11-13 23:38:16 +03:00
} )
2016-12-30 04:24:38 +03:00
// item: line...
2018-03-25 00:14:01 +03:00
} else if ( /---+/ . test ( key ) ) {
2017-08-23 19:52:17 +03:00
make ( '---' )
2016-05-13 23:44:09 +03:00
}
} )
}
2017-01-04 19:05:19 +03:00
} ,
cfg )
2016-05-13 23:44:09 +03:00
// save show disabled state to .config...
. on ( 'close' , function ( ) {
var config = actions . config [ 'browse-actions-settings' ]
2018-03-09 17:51:27 +03:00
config . showDisabled = this . options . showDisabled
config . showHidden = this . options . showHidden
2016-05-13 23:44:09 +03:00
} )
2017-07-11 01:05:39 +03:00
. run ( function ( ) {
actions . config [ 'browse-actions-keys' ]
&& this . dom . addClass ( 'show-keys' )
// handle '?' button to browse path...
2017-09-09 19:04:34 +03:00
var showDoc = this . showDoc = function ( ) {
2017-07-11 01:05:39 +03:00
var action = this . select ( '!' ) . attr ( 'action' )
action
2017-07-23 16:38:03 +03:00
&& actions . showDoc ( action )
2017-07-11 01:05:39 +03:00
}
this . keyboard . handler ( 'General' , '?' , 'showDoc' )
2017-09-09 19:04:34 +03:00
this . menu ( showDoc . bind ( this ) )
2018-03-09 17:51:27 +03:00
} ) } ) ] ,
2017-01-03 02:55:25 +03:00
2019-12-30 01:55:34 +03:00
toggleBrowseAdvanced : [ 'System|Interface/-99: Advanced menu items' ,
2019-12-30 00:41:35 +03:00
core . makeConfigToggler (
'browse-advanced-mode' ,
[ 'off' , 'on' ] ) ] ,
2017-01-03 02:55:25 +03:00
toggleBrowseActionKeys : [ 'Interface/Show keys in menu' ,
2019-12-30 00:41:35 +03:00
{ browseMode : function ( ) {
2019-12-30 01:55:34 +03:00
return this . config [ 'browse-advanced-mode' ] != 'on' && 'hidden' } } ,
2017-01-03 02:55:25 +03:00
core . makeConfigToggler (
'browse-actions-keys' ,
2017-04-25 17:10:40 +03:00
[ 'on' , 'off' ] ,
2017-01-03 02:55:25 +03:00
function ( state ) {
this . modal . client . dom . hasClass ( 'browse-actions' )
2017-04-25 17:10:40 +03:00
&& this . modal . client . dom [ state == 'on' ? 'addClass' : 'removeClass' ] ( 'show-keys' )
2017-01-03 02:55:25 +03:00
} ) ] ,
2015-12-17 03:44:07 +03:00
} )
var BrowseActions =
module . BrowseActions = core . ImageGridFeatures . Feature ( {
title : '' ,
doc : '' ,
tag : 'ui-browse-actions' ,
depends : [
2016-04-30 03:38:52 +03:00
'ui' ,
'ui-dialogs' ,
2017-07-08 00:08:33 +03:00
'ui-introspection' ,
2015-12-17 03:44:07 +03:00
] ,
2017-01-03 02:55:25 +03:00
suggested : [
'keyboard' ,
] ,
2015-12-17 03:44:07 +03:00
actions : BrowseActionsActions ,
} )
2016-03-05 02:45:02 +03:00
//---------------------------------------------------------------------
2017-08-23 22:54:15 +03:00
// XXX use image instead of image block in single image mode...
2016-03-05 02:45:02 +03:00
var ContextActionMenu =
module . ContextActionMenu = core . ImageGridFeatures . Feature ( {
title : '' ,
doc : '' ,
tag : 'ui-context-action-menu' ,
depends : [
'ui-browse-actions' ,
] ,
2017-09-11 16:24:27 +03:00
actions : actions . Actions ( {
showContextMenu : [ 'Interface/Show context menu...' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2017-09-11 16:24:27 +03:00
uiDialog ( function ( ) {
return this . current ?
this . browseActions ( '/Image/' )
: this . browseActions ( ) } ) ] ,
} ) ,
2016-03-05 02:45:02 +03:00
handlers : [
2018-03-19 01:42:36 +03:00
// XXX FireFox: get actual event...
2017-08-23 22:54:15 +03:00
[ 'imageMenu.pre' ,
2017-08-25 22:31:46 +03:00
function ( gid ) {
2017-08-23 22:54:15 +03:00
event . preventDefault ( )
event . stopPropagation ( )
2016-03-05 02:45:02 +03:00
2017-08-23 22:54:15 +03:00
this
. focusImage ( gid )
. browseActions ( '/Image/' )
} ] ,
[ 'imageOuterBlockMenu.pre' ,
2017-08-31 17:12:59 +03:00
function ( gid ) {
2017-08-23 22:54:15 +03:00
// only show image menu in ribbon mode...
if ( this . toggleSingleImage && this . toggleSingleImage ( '?' ) == 'on' ) {
return
}
2016-03-05 02:45:02 +03:00
2017-08-23 22:54:15 +03:00
event . preventDefault ( )
event . stopPropagation ( )
2017-04-10 14:46:31 +03:00
2017-08-23 22:54:15 +03:00
this
. focusImage ( gid )
. browseActions ( '/Image/' )
2016-03-05 02:45:02 +03:00
} ] ,
2017-08-25 23:15:07 +03:00
// NOTE: we are using load here and not 'start' because at start
// there may be no viewer yet...
// XXX is this a bug???
2016-03-05 02:45:02 +03:00
[ 'load' ,
function ( ) {
var that = this
2017-05-16 00:26:37 +03:00
var viewer = this . dom
2016-03-05 02:45:02 +03:00
! viewer . data ( 'context-menu' )
&& viewer
. data ( 'context-menu' , true )
2018-03-19 01:42:36 +03:00
. on ( 'contextmenu' , function ( evt ) {
evt = window . event || evt
evt . preventDefault ( )
evt . stopPropagation ( )
2016-03-05 02:45:02 +03:00
2017-08-26 23:58:52 +03:00
that . browseActions ( )
2016-03-05 02:45:02 +03:00
} )
} ] ,
] ,
} )
2015-12-17 03:44:07 +03:00
//---------------------------------------------------------------------
2016-11-09 04:53:42 +03:00
2018-01-18 09:16:46 +03:00
// mac seems not to have the utf gear icon...
2018-01-18 07:21:19 +03:00
var SETTINGS _ICON =
typeof ( navigator ) == 'undefined' ? 'settings'
: navigator . platform == 'Win32' ? '⛭'
: '<span class="material-icons">settings</span>'
2017-09-06 16:02:29 +03:00
// XXX add context menu action to buttons...
2016-11-15 23:05:46 +03:00
var ButtonsActions = actions . Actions ( {
2016-11-08 18:57:11 +03:00
config : {
2016-11-15 22:15:14 +03:00
'main-buttons-state' : 'on' ,
2017-03-09 02:35:28 +03:00
// Format:
// {
// <html>: [
// <css-class>,
// // Button info (optional)
// <info>,
// <code>,
// ],
2017-09-06 16:02:29 +03:00
//
// <html>: [
// <css-class>,
// // Button info (optional)
// <info>,
// [
// <primary>,
// <secondary>,
// ]
// ],
2017-03-09 02:35:28 +03:00
// ...
// }
2017-09-06 16:02:29 +03:00
//
2016-11-15 22:15:14 +03:00
'main-buttons' : {
2016-11-16 04:57:31 +03:00
'☰' : [ 'menu' , 'browseActions -- Action menu...' ] ,
2017-09-06 16:02:29 +03:00
'◲<sub/><sup/>' : [ 'collections' , [
'browseCollections -- Collections...' ,
'browseActions: "/Collections/" -- Collection menu...' ,
] ] ,
2016-11-16 04:57:31 +03:00
'C<sub/>' : [ 'crop' , 'browseActions: "Crop/" -- Crop menu...' ] ,
2017-11-27 01:20:35 +03:00
'▷' : [ 'slideshow' , [
2019-08-01 18:45:29 +03:00
'slideshowButtonAction -- Slideshow' ,
2017-11-27 01:20:35 +03:00
'slideshowDialog -- Slideshow menu...' ,
] ] ,
2016-11-08 21:16:33 +03:00
} ,
2016-11-15 22:15:14 +03:00
// XXX not sure about these yet...
'secondary-buttons-state' : 'off' ,
'secondary-buttons' : {
2018-01-18 07:21:19 +03:00
//'<span/>': ['touch-controls', 'toggleSideButtons -- Toggle touch controls'],
2016-11-16 04:57:31 +03:00
//'Z<sub/>': ['zoom', 'browseActions: "Zoom/" -- Zoom menu...'],
//'+': ['zoom-in', 'zoomIn -- Zoom in'],
//'-': ['zoom-out', 'zoomOut -- Zoom out'],
//'⛭': ['ui-settings', 'browseActions: "Interface/" -- Interface settings...'],
} ,
'app-buttons' : {
2018-03-21 17:34:26 +03:00
[ SETTINGS _ICON ] : [ 'ui-settings always-shown' , [
2018-01-15 03:59:53 +03:00
'browseActions: "Interface/" -- Interface settings...' ,
'toggleSideButtons -- Toggle touch controls' ,
] ] ,
2016-11-15 22:15:14 +03:00
} ,
2016-11-15 23:05:46 +03:00
2016-11-16 00:14:09 +03:00
'side-buttons-state' : 'off' ,
2016-11-15 23:05:46 +03:00
'side-buttons-left' : {
'-' : [ 'zoom-out' , 'zoomOut -- Zoom out' ] ,
2016-11-16 00:14:09 +03:00
'↥' : [ 'up' , 'shiftImageUp -- Shift image up' ] ,
2016-11-16 04:57:31 +03:00
'⦉' : [ 'left' , 'prevImage -- Previous image' ] ,
2016-11-16 00:14:09 +03:00
'↧' : [ 'down' , 'shiftImageDown -- Shift image down' ] ,
2016-11-15 23:05:46 +03:00
} ,
'side-buttons-right' : {
'+' : [ 'zoom-in' , 'zoomIn -- Zoom in' ] ,
2016-11-16 00:14:09 +03:00
'↥' : [ 'up' , 'shiftImageUp -- Shift image up' ] ,
2016-11-16 04:57:31 +03:00
'⦊' : [ 'right' , 'nextImage -- Next image' ] ,
2016-11-16 00:14:09 +03:00
'↧' : [ 'down' , 'shiftImageDown -- Shift image down' ] ,
2016-11-15 23:05:46 +03:00
} ,
2017-12-05 05:48:22 +03:00
'button-highlight-color' : 'white' ,
'button-highlight-colors' : [
'white' ,
'yellow' ,
] ,
2016-11-08 18:57:11 +03:00
} ,
2016-04-30 03:38:52 +03:00
2017-01-05 03:06:06 +03:00
toggleMainButtons : [ 'Interface/Main buttons' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2016-11-15 22:15:14 +03:00
makeButtonControlsToggler ( 'main-buttons' ) ] ,
2017-01-05 03:06:06 +03:00
toggleSecondaryButtons : [ 'Interface/Secondary buttons' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2016-11-15 22:15:14 +03:00
makeButtonControlsToggler ( 'secondary-buttons' ) ] ,
2017-01-05 03:06:06 +03:00
toggleAppButtons : [ 'Interface/App buttons' ,
2019-12-30 00:41:35 +03:00
{ browseMode : 'toggleBrowseActionKeys' } ,
2016-11-16 04:57:31 +03:00
makeButtonControlsToggler ( 'app-buttons' ) ] ,
2019-12-31 04:26:55 +03:00
2019-12-30 00:41:35 +03:00
toggleSideButtons : [ 'Interface/70: Touch buttons' ,
2016-11-16 04:57:31 +03:00
( 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 )
} )
} ) ( ) ] ,
2017-12-05 05:48:22 +03:00
2019-12-30 00:41:35 +03:00
toggleButtonHighlightColor : [ 'Interface/Theme/Button highlight color' ,
{ browseMode : 'toggleBrowseActionKeys' } ,
2017-12-05 05:48:22 +03:00
core . makeConfigToggler (
'button-highlight-color' ,
function ( ) { return this . config [ 'button-highlight-colors' ] } ,
// update the buttons...
function ( ) { this . reload ( ) } ) ] ,
2016-11-09 04:53:42 +03:00
} )
2016-11-15 23:05:46 +03:00
var Buttons =
module . Buttons = core . ImageGridFeatures . Feature ( {
2016-11-09 04:53:42 +03:00
title : '' ,
doc : '' ,
2016-11-15 22:15:14 +03:00
tag : 'ui-buttons' ,
2016-11-09 04:53:42 +03:00
depends : [
'ui' ,
] ,
suggested : [
// needed for reporting info in .makeButtonControls(..)
'ui-status-bar' ,
] ,
2016-11-15 23:05:46 +03:00
actions : ButtonsActions ,
2016-11-09 04:53:42 +03:00
handlers : [
2016-11-16 04:57:31 +03:00
[ 'start.pre' ,
2016-11-20 01:11:30 +03:00
function ( ) {
this . toggleAppButtons ( 'on' )
} ] ,
// NOTE: these need to be loaded AFTER the .config has been loaded...
[ 'start' ,
2016-11-09 04:53:42 +03:00
function ( ) {
2016-11-15 22:15:14 +03:00
this . toggleMainButtons ( this . config [ 'main-buttons-state' ] || 'on' )
2016-11-16 00:14:09 +03:00
this . toggleSecondaryButtons ( this . config [ 'secondary-buttons-state' ] || 'on' )
this . toggleSideButtons ( this . config [ 'side-buttons-state' ] || 'on' )
} ] ,
2016-11-28 20:18:34 +03:00
// update crop button status...
2017-08-29 20:59:00 +03:00
[ [
'load' ,
'clear' ,
'reload' ,
] ,
2016-11-09 04:53:42 +03:00
function ( ) {
2017-12-05 05:48:22 +03:00
// XXX is this the right way to go???
$ ( '.main-buttons.buttons .crop.button' )
. css ( { 'color' : this . cropped ?
( this . config [ 'button-highlight-color' ] || 'white' )
: '' , } )
2017-08-29 20:59:00 +03:00
var l = ( this . crop _stack || [ ] ) . length
2016-11-15 22:15:14 +03:00
$ ( '.main-buttons.buttons .crop.button sub' )
2017-08-27 16:09:09 +03:00
// XXX should this be here or in CSS???
. css ( {
'display' : 'inline-block' ,
'width' : '0px' ,
'overflow' : 'visible' ,
} )
2017-08-29 20:59:00 +03:00
. text ( l == 0 ? ''
: l > 99 ? '99+'
: l )
2017-08-27 16:09:09 +03:00
} ] ,
// update collection button status...
2017-08-29 20:59:00 +03:00
[ [
'load' ,
'clear' ,
'reload' ,
'saveCollection' ,
2017-09-02 20:58:49 +03:00
'removeCollection' ,
2017-08-29 20:59:00 +03:00
'collectionLoaded' ,
'collectionUnloaded' ,
] ,
2017-08-27 16:09:09 +03:00
function ( ) {
2017-12-05 05:48:22 +03:00
// XXX is this the right way to go???
2017-08-29 20:59:00 +03:00
$ ( '.main-buttons.buttons .collections.button' )
2017-12-05 05:48:22 +03:00
. css ( { 'color' : this . collection ?
( this . config [ 'button-highlight-color' ] || 'white' )
: '' , } )
2017-08-29 20:59:00 +03:00
var l = this . collections _length
2017-09-02 20:58:49 +03:00
// current collection unsaved indicator...
$ ( '.main-buttons.buttons .collections.button sup' )
. css ( {
'display' : 'inline-block' ,
'position' : 'absolute' ,
'margin-top' : '-0.3em' ,
'overflow' : 'visible' ,
} )
. text ( ( this . collection && ! ( this . collection in this . collections ) ) ?
'*'
: '' )
// collection count...
2017-08-29 20:59:00 +03:00
$ ( '.main-buttons.buttons .collections.button sub' )
. css ( {
'display' : 'inline-block' ,
'width' : '0px' ,
'overflow' : 'visible' ,
} )
2019-08-01 18:45:29 +03:00
. text ( l > 99 ?
'99+'
: l == 0 ?
''
2017-08-29 20:59:00 +03:00
: l )
/ *
2017-08-27 16:09:09 +03:00
$ ( '.main-buttons.buttons .collections.button sub' )
// XXX should this be here or in CSS???
. css ( {
'display' : 'inline-block' ,
'width' : '0px' ,
'overflow' : 'visible' ,
'color' : 'yellow' ,
} )
. html ( this . collection ? '●' : '' )
2017-08-29 20:59:00 +03:00
//*/
2017-08-27 16:09:09 +03:00
} ] ,
2017-11-27 01:20:35 +03:00
// update slideshow status...
2019-08-01 18:45:29 +03:00
[ [ 'toggleSlideshow' , 'toggleSlideshowTimer' ] ,
2017-11-27 01:20:35 +03:00
function ( ) {
2019-08-01 18:45:29 +03:00
var mode = this . toggleSlideshow ( '?' )
mode = ( mode == 'on'
&& this . toggleSlideshowTimer ( '?' ) == 'paused' ) ?
'paused'
: mode
// update the button icon...
2017-11-27 01:20:35 +03:00
$ ( '.main-buttons.buttons .slideshow.button' )
2019-08-01 18:45:29 +03:00
. html ( mode == 'on' ?
'◼'
: mode == 'paused' ?
'❚❚'
2017-11-27 01:20:35 +03:00
//'◻'
2019-08-01 18:45:29 +03:00
: '▷' )
. run ( function ( ) {
mode == 'paused' ?
this . addClass ( 'visible' )
: this . removeClass ( 'visible' ) } ) } ] ,
2016-11-28 20:18:34 +03:00
// update zoom button status...
2017-05-16 00:26:37 +03:00
[ 'viewScale' ,
2016-11-15 22:15:14 +03:00
function ( ) {
$ ( '.secondary-buttons.buttons .zoom.button sub' )
. text ( Math . round ( this . screenwidth ) ) } ] ,
2016-11-09 04:53:42 +03:00
] ,
} )
2015-12-17 03:34:20 +03:00
/ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2016-08-20 22:49:36 +03:00
* vim : set ts = 4 sw = 4 : * / r e t u r n m o d u l e } )