mirror of
https://github.com/flynx/ImageGrid.git
synced 2025-10-31 19:30:07 +00:00
added .ready() lifecycle event and framework...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
4a4cb57eaf
commit
220939454b
@ -107,6 +107,10 @@ var AppControlActions = actions.Actions({
|
|||||||
if(cfg != null && cfg.fullscreen){
|
if(cfg != null && cfg.fullscreen){
|
||||||
that.toggleFullScreen('on')
|
that.toggleFullScreen('on')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// declare we are ready...
|
||||||
|
$(function(){ that.declareReady() })
|
||||||
|
|
||||||
}, this.config['window-delay-initial-display'] || 0)
|
}, this.config['window-delay-initial-display'] || 0)
|
||||||
}],
|
}],
|
||||||
|
|
||||||
@ -198,14 +202,14 @@ module.AppControl = core.ImageGridFeatures.Feature({
|
|||||||
|
|
||||||
// XXX show main window...
|
// XXX show main window...
|
||||||
handlers: [
|
handlers: [
|
||||||
|
['start.pre',
|
||||||
|
function(){
|
||||||
|
// we are going to declare ready ourselves...
|
||||||
|
this.requestReadyAnnounce()
|
||||||
|
}],
|
||||||
['start',
|
['start',
|
||||||
function(){
|
function(){
|
||||||
// XXX this messes up ribbon scale...
|
|
||||||
// ...to close/fast?
|
|
||||||
//this.toggleInterfaceScale('!')
|
|
||||||
|
|
||||||
this.restoreWindowGeometry()
|
this.restoreWindowGeometry()
|
||||||
|
|
||||||
}],
|
}],
|
||||||
[[
|
[[
|
||||||
'close.pre',
|
'close.pre',
|
||||||
|
|||||||
@ -201,152 +201,6 @@ if(typeof(process) != 'undefined'){
|
|||||||
|
|
||||||
|
|
||||||
/*********************************************************************/
|
/*********************************************************************/
|
||||||
// System life-cycle...
|
|
||||||
|
|
||||||
// XXX should this be a generic library thing???
|
|
||||||
// XXX should his have state???
|
|
||||||
// ...if so, should this be a toggler???
|
|
||||||
var LifeCycleActions = actions.Actions({
|
|
||||||
start: ['- System/',
|
|
||||||
function(){
|
|
||||||
var that = this
|
|
||||||
this.logger && this.logger.emit('start')
|
|
||||||
|
|
||||||
// NOTE: jQuery currently provides no way to check if an event
|
|
||||||
// is bound so we'll need to keep track manually...
|
|
||||||
if(this.__stop_handler == null){
|
|
||||||
var stop = this.__stop_handler = function(){ that.stop() }
|
|
||||||
|
|
||||||
} else {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// set the runtime...
|
|
||||||
var runtime = this.runtime = ImageGridFeatures.runtime
|
|
||||||
|
|
||||||
// nw.js...
|
|
||||||
if(runtime == 'nw'){
|
|
||||||
// this handles both reload and close...
|
|
||||||
$(window).on('beforeunload', stop)
|
|
||||||
|
|
||||||
// NOTE: we are using both events as some of them do not
|
|
||||||
// get triggered in specific conditions and some do,
|
|
||||||
// for example, this gets triggered when the window's
|
|
||||||
// 'X' is clicked while does not on reload...
|
|
||||||
this.__nw_stop_handler = function(){
|
|
||||||
var w = this
|
|
||||||
try{
|
|
||||||
that
|
|
||||||
// wait till ALL the handlers finish before
|
|
||||||
// exiting...
|
|
||||||
.on('stop.post', function(){
|
|
||||||
// XXX might be broken in nw13 -- test!!!
|
|
||||||
//w.close(true)
|
|
||||||
nw.App.quit()
|
|
||||||
})
|
|
||||||
.stop()
|
|
||||||
|
|
||||||
// in case something breaks exit...
|
|
||||||
// XXX not sure if this is correct...
|
|
||||||
} catch(e){
|
|
||||||
console.log('ERROR:', e)
|
|
||||||
|
|
||||||
DEBUG || nw.App.quit()
|
|
||||||
//this.close(true)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
nw.Window.get().on('close', this.__nw_stop_handler)
|
|
||||||
|
|
||||||
// node.js...
|
|
||||||
} else if(runtime == 'node'){
|
|
||||||
process.on('exit', stop)
|
|
||||||
|
|
||||||
// browser...
|
|
||||||
} else if(runtime == 'browser'){
|
|
||||||
$(window).on('beforeunload', stop)
|
|
||||||
|
|
||||||
// other...
|
|
||||||
} else {
|
|
||||||
// XXX
|
|
||||||
console.warn('Unknown runtime:', runtime)
|
|
||||||
}
|
|
||||||
}],
|
|
||||||
// unbind events...
|
|
||||||
stop: ['- System/',
|
|
||||||
function(){
|
|
||||||
// browser & nw...
|
|
||||||
if(this.__stop_handler
|
|
||||||
&& (this.runtime == 'browser' || this.runtime == 'nw')){
|
|
||||||
$(window).off('beforeunload', this.__stop_handler)
|
|
||||||
}
|
|
||||||
|
|
||||||
// nw...
|
|
||||||
if(this.__nw_stop_handler && this.runtime == 'nw'){
|
|
||||||
nw.Window.get().removeAllListeners('close')
|
|
||||||
delete this.__nw_stop_handler
|
|
||||||
}
|
|
||||||
|
|
||||||
// node...
|
|
||||||
if(this.__stop_handler && this.runtime == 'node'){
|
|
||||||
process.removeAllListeners('exit')
|
|
||||||
}
|
|
||||||
|
|
||||||
delete this.__stop_handler
|
|
||||||
|
|
||||||
this.logger && this.logger.emit('stop')
|
|
||||||
}],
|
|
||||||
|
|
||||||
/*
|
|
||||||
// XXX need a clear protocol for this...
|
|
||||||
// something like:
|
|
||||||
// - clear state
|
|
||||||
// - load state
|
|
||||||
reset: ['System/',
|
|
||||||
function(){
|
|
||||||
}],
|
|
||||||
*/
|
|
||||||
})
|
|
||||||
|
|
||||||
var LifeCycle =
|
|
||||||
module.LifeCycle = ImageGridFeatures.Feature({
|
|
||||||
title: '',
|
|
||||||
doc: '',
|
|
||||||
|
|
||||||
tag: 'lifecycle',
|
|
||||||
priority: 'high',
|
|
||||||
|
|
||||||
actions: LifeCycleActions,
|
|
||||||
})
|
|
||||||
|
|
||||||
|
|
||||||
//---------------------------------------------------------------------
|
|
||||||
|
|
||||||
var UtilActions = actions.Actions({
|
|
||||||
mergeConfig: ['- System/',
|
|
||||||
function(config){
|
|
||||||
config = config instanceof Function ? config.call(this)
|
|
||||||
: typeof(config) == typeof('str') ? this.config[config]
|
|
||||||
: config
|
|
||||||
var that = this
|
|
||||||
Object.keys(config).forEach(function(key){
|
|
||||||
that.config[key] = config[key]
|
|
||||||
})
|
|
||||||
}],
|
|
||||||
})
|
|
||||||
|
|
||||||
|
|
||||||
var Util =
|
|
||||||
module.Util = ImageGridFeatures.Feature({
|
|
||||||
title: '',
|
|
||||||
doc: '',
|
|
||||||
|
|
||||||
tag: 'util',
|
|
||||||
|
|
||||||
actions: UtilActions,
|
|
||||||
})
|
|
||||||
|
|
||||||
|
|
||||||
//---------------------------------------------------------------------
|
|
||||||
// Introspection...
|
// Introspection...
|
||||||
|
|
||||||
// Normalize doc strings...
|
// Normalize doc strings...
|
||||||
@ -435,6 +289,212 @@ module.Introspection = ImageGridFeatures.Feature({
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------
|
||||||
|
// System life-cycle...
|
||||||
|
|
||||||
|
// XXX should this be a generic library thing???
|
||||||
|
// XXX should his have state???
|
||||||
|
// ...if so, should this be a toggler???
|
||||||
|
var LifeCycleActions = actions.Actions({
|
||||||
|
start: ['- System/',
|
||||||
|
function(){
|
||||||
|
var that = this
|
||||||
|
this.logger && this.logger.emit('start')
|
||||||
|
|
||||||
|
// NOTE: jQuery currently provides no way to check if an event
|
||||||
|
// is bound so we'll need to keep track manually...
|
||||||
|
if(this.__stop_handler == null){
|
||||||
|
var stop = this.__stop_handler = function(){ that.stop() }
|
||||||
|
|
||||||
|
} else {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// set the runtime...
|
||||||
|
var runtime = this.runtime = ImageGridFeatures.runtime
|
||||||
|
|
||||||
|
// nw.js...
|
||||||
|
if(runtime == 'nw'){
|
||||||
|
// this handles both reload and close...
|
||||||
|
$(window).on('beforeunload', stop)
|
||||||
|
|
||||||
|
// NOTE: we are using both events as some of them do not
|
||||||
|
// get triggered in specific conditions and some do,
|
||||||
|
// for example, this gets triggered when the window's
|
||||||
|
// 'X' is clicked while does not on reload...
|
||||||
|
this.__nw_stop_handler = function(){
|
||||||
|
var w = this
|
||||||
|
try{
|
||||||
|
that
|
||||||
|
// wait till ALL the handlers finish before
|
||||||
|
// exiting...
|
||||||
|
.on('stop.post', function(){
|
||||||
|
// XXX might be broken in nw13 -- test!!!
|
||||||
|
//w.close(true)
|
||||||
|
nw.App.quit()
|
||||||
|
})
|
||||||
|
.stop()
|
||||||
|
|
||||||
|
// in case something breaks exit...
|
||||||
|
// XXX not sure if this is correct...
|
||||||
|
} catch(e){
|
||||||
|
console.log('ERROR:', e)
|
||||||
|
|
||||||
|
DEBUG || nw.App.quit()
|
||||||
|
//this.close(true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
nw.Window.get().on('close', this.__nw_stop_handler)
|
||||||
|
|
||||||
|
|
||||||
|
// node.js...
|
||||||
|
} else if(runtime == 'node'){
|
||||||
|
process.on('exit', stop)
|
||||||
|
|
||||||
|
// browser...
|
||||||
|
} else if(runtime == 'browser'){
|
||||||
|
$(window).on('beforeunload', stop)
|
||||||
|
|
||||||
|
// other...
|
||||||
|
} else {
|
||||||
|
// XXX
|
||||||
|
console.warn('Unknown runtime:', runtime)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handler ready event...
|
||||||
|
// ...if no one requested to do it.
|
||||||
|
if(this.__ready_announce_requested == null
|
||||||
|
|| this.__ready_announce_requested <= 0){
|
||||||
|
if(runtime == 'nw'){
|
||||||
|
$(function(){ that.declareReady() })
|
||||||
|
|
||||||
|
} else if(runtime == 'node'){
|
||||||
|
this.declareReady()
|
||||||
|
|
||||||
|
} else if(runtime == 'browser'){
|
||||||
|
$(function(){ that.declareReady() })
|
||||||
|
|
||||||
|
} else {
|
||||||
|
this.declareReady()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}],
|
||||||
|
|
||||||
|
ready: ['- System/System ready event',
|
||||||
|
doc`Ready protocol event
|
||||||
|
|
||||||
|
The ready event is fired right after start is done.
|
||||||
|
|
||||||
|
Any feature can request to announce 'ready' itself when it is
|
||||||
|
done by calling .requestReadyAnnounce().
|
||||||
|
If .requestReadyAnnounce() is called, then the caller is required
|
||||||
|
to also call .declareReady().
|
||||||
|
.ready() will actually be triggered only after when .declareReady()
|
||||||
|
is called the same number of times as .requestReadyAnnounce().
|
||||||
|
|
||||||
|
NOTE: at this point the system does not track the caller
|
||||||
|
"honesty", so it is the caller's responsibility to follow
|
||||||
|
the protocol.
|
||||||
|
`,
|
||||||
|
notUserCallable(function(){
|
||||||
|
// System ready event...
|
||||||
|
//
|
||||||
|
// Not intended for direct use, use .declareReady() to initiate.
|
||||||
|
this.logger && this.logger.emit('start')
|
||||||
|
})],
|
||||||
|
// NOTE: this calls .ready() once per session.
|
||||||
|
declareReady: ['- System/Declare system ready',
|
||||||
|
function(){
|
||||||
|
this.__ready_announce_requested
|
||||||
|
&& (this.__ready_announce_requested -= 1)
|
||||||
|
|
||||||
|
if(!this.__ready_announce_requested
|
||||||
|
|| this.__ready_announce_requested == 0){
|
||||||
|
this.__ready = this.__ready || !!this.ready()
|
||||||
|
delete this.__ready_announce_requested
|
||||||
|
}
|
||||||
|
}],
|
||||||
|
requestReadyAnnounce: ['- System/',
|
||||||
|
function(){
|
||||||
|
return this.__ready_announce_requested = (this.__ready_announce_requested || 0) + 1
|
||||||
|
}],
|
||||||
|
|
||||||
|
// unbind events...
|
||||||
|
stop: ['- System/',
|
||||||
|
function(){
|
||||||
|
// browser & nw...
|
||||||
|
if(this.__stop_handler
|
||||||
|
&& (this.runtime == 'browser' || this.runtime == 'nw')){
|
||||||
|
$(window).off('beforeunload', this.__stop_handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
// nw...
|
||||||
|
if(this.__nw_stop_handler && this.runtime == 'nw'){
|
||||||
|
nw.Window.get().removeAllListeners('close')
|
||||||
|
delete this.__nw_stop_handler
|
||||||
|
}
|
||||||
|
|
||||||
|
// node...
|
||||||
|
if(this.__stop_handler && this.runtime == 'node'){
|
||||||
|
process.removeAllListeners('exit')
|
||||||
|
}
|
||||||
|
|
||||||
|
delete this.__ready
|
||||||
|
delete this.__stop_handler
|
||||||
|
|
||||||
|
this.logger && this.logger.emit('stop')
|
||||||
|
}],
|
||||||
|
|
||||||
|
/*
|
||||||
|
// XXX need a clear protocol for this...
|
||||||
|
// something like:
|
||||||
|
// - clear state
|
||||||
|
// - load state
|
||||||
|
reset: ['System/',
|
||||||
|
function(){
|
||||||
|
}],
|
||||||
|
*/
|
||||||
|
})
|
||||||
|
|
||||||
|
var LifeCycle =
|
||||||
|
module.LifeCycle = ImageGridFeatures.Feature({
|
||||||
|
title: '',
|
||||||
|
doc: '',
|
||||||
|
|
||||||
|
tag: 'lifecycle',
|
||||||
|
priority: 'high',
|
||||||
|
|
||||||
|
actions: LifeCycleActions,
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------
|
||||||
|
|
||||||
|
var UtilActions = actions.Actions({
|
||||||
|
mergeConfig: ['- System/',
|
||||||
|
function(config){
|
||||||
|
config = config instanceof Function ? config.call(this)
|
||||||
|
: typeof(config) == typeof('str') ? this.config[config]
|
||||||
|
: config
|
||||||
|
var that = this
|
||||||
|
Object.keys(config).forEach(function(key){
|
||||||
|
that.config[key] = config[key]
|
||||||
|
})
|
||||||
|
}],
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
var Util =
|
||||||
|
module.Util = ImageGridFeatures.Feature({
|
||||||
|
title: '',
|
||||||
|
doc: '',
|
||||||
|
|
||||||
|
tag: 'util',
|
||||||
|
|
||||||
|
actions: UtilActions,
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
//---------------------------------------------------------------------
|
//---------------------------------------------------------------------
|
||||||
// Journal...
|
// Journal...
|
||||||
//
|
//
|
||||||
|
|||||||
@ -331,8 +331,9 @@ module.URLHistoryLocalStorage = core.ImageGridFeatures.Feature({
|
|||||||
|
|
||||||
// NOTE: loading is done by the .url_history prop...
|
// NOTE: loading is done by the .url_history prop...
|
||||||
handlers: [
|
handlers: [
|
||||||
['start',
|
['ready',
|
||||||
function(){ this.loadLastSavedBasePath() }],
|
function(){ this.loadLastSavedBasePath() }],
|
||||||
|
|
||||||
['stop.pre',
|
['stop.pre',
|
||||||
function(){ this.saveURLHistory() }],
|
function(){ this.saveURLHistory() }],
|
||||||
|
|
||||||
|
|||||||
@ -205,19 +205,21 @@ $(function(){
|
|||||||
// setup the viewer...
|
// setup the viewer...
|
||||||
ig
|
ig
|
||||||
.load({ viewer: $('.viewer') })
|
.load({ viewer: $('.viewer') })
|
||||||
|
.on('ready', function(){
|
||||||
|
// load some testing data if nothing else loaded...
|
||||||
|
if(!this.url_history || Object.keys(this.url_history).length == 0){
|
||||||
|
// NOTE: we can (and do) load this in parts...
|
||||||
|
this.loadDemoIndex()
|
||||||
|
|
||||||
|
// this is needed when loading legacy sources that do not have tags
|
||||||
|
// synced...
|
||||||
|
// do not do for actual data...
|
||||||
|
//.syncTags()
|
||||||
|
}
|
||||||
|
})
|
||||||
.start()
|
.start()
|
||||||
|
|
||||||
|
|
||||||
// load some testing data if nothing else loaded...
|
|
||||||
if(!ig.url_history || Object.keys(ig.url_history).length == 0){
|
|
||||||
// NOTE: we can (and do) load this in parts...
|
|
||||||
ig.loadDemoIndex()
|
|
||||||
|
|
||||||
// this is needed when loading legacy sources that do not have tags
|
|
||||||
// synced...
|
|
||||||
// do not do for actual data...
|
|
||||||
//.syncTags()
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user