mirror of
https://github.com/flynx/ImageGrid.git
synced 2025-10-31 03:10:07 +00:00
472 lines
12 KiB
JavaScript
Executable File
472 lines
12 KiB
JavaScript
Executable File
/**********************************************************************
|
|
*
|
|
* Minomal UI API...
|
|
*
|
|
*
|
|
**********************************************************************/
|
|
|
|
define(function(require){ var module = {}
|
|
console.log('>>> ribbons')
|
|
|
|
//var DEBUG = DEBUG != null ? DEBUG : true
|
|
|
|
var data = require('data')
|
|
var image = require('image')
|
|
|
|
|
|
|
|
/*********************************************************************/
|
|
//
|
|
// This xpects the folowing HTML structure...
|
|
//
|
|
// Unpopulated:
|
|
// NOTE: there can be only one .ribbon-set element.
|
|
//
|
|
// <div class="viewer">
|
|
// <div class="ribbon-set"></div>
|
|
// </div>
|
|
//
|
|
//
|
|
// Populated:
|
|
//
|
|
// <div class="viewer">
|
|
// <div class="ribbon-set">
|
|
// <div class="ribbon">
|
|
// <div class="image"></div>
|
|
// <div class="image"></div>
|
|
// ...
|
|
// </div>
|
|
// <div class="ribbon">
|
|
// <div class="image"></div>
|
|
// <div class="current image"></div>
|
|
// <div class="image"></div>
|
|
// <div class="mark selected"></div>
|
|
// <div class="image"></div>
|
|
// ...
|
|
// </div>
|
|
// ...
|
|
// </div>
|
|
// </div>
|
|
//
|
|
//
|
|
/*********************************************************************/
|
|
|
|
var RibbonsClassPrototype =
|
|
module.RibbonsClassPrototype = {
|
|
getElemGID: function(elem){
|
|
return JSON.parse('"' + elem.attr('gid') + '"')
|
|
},
|
|
|
|
// NOTE: these will return unattached objects...
|
|
createViewer: function(){
|
|
return $('<div>')
|
|
.addClass('viewer')
|
|
.append($('<div>')
|
|
.addClass('ribbon-set'))
|
|
},
|
|
// XXX NOTE: quots removal might render this incompatible with older data formats...
|
|
createRibbon: function(gid){
|
|
gid = gid != null ? gid+'' : gid
|
|
return $('<div>')
|
|
.addClass('ribbon')
|
|
.attr('gid', JSON.stringify(gid)
|
|
// this removes the extra quots...
|
|
.replace(/^"(.*)"$/g, '$1'))
|
|
},
|
|
// XXX NOTE: quots removal might render this incompatible with older data formats...
|
|
createImage: function(gid){
|
|
gid = gid != null ? gid+'' : gid
|
|
return $('<div>')
|
|
.addClass('image')
|
|
.attr('gid', JSON.stringify(gid)
|
|
// this removes the extra quots...
|
|
.replace(/^"(.*)"$/g, '$1'))
|
|
},
|
|
}
|
|
|
|
|
|
// XXX this is a low level interface, not a set of actions...
|
|
// XXX test
|
|
var RibbonsPrototype =
|
|
module.RibbonsPrototype = {
|
|
//
|
|
// .viewer (jQuery object)
|
|
//
|
|
|
|
// Constructors...
|
|
createViewer: RibbonsClassPrototype.createViewer,
|
|
createRibbon: RibbonsClassPrototype.createRibbon,
|
|
createImage: RibbonsClassPrototype.createImage,
|
|
|
|
// Generic getters...
|
|
getElemGID: RibbonsClassPrototype.getElemGID,
|
|
|
|
// Contextual getters...
|
|
// NOTE: these accept gids or jQuery objects...
|
|
getRibbon: function(target){
|
|
if(target == null) {
|
|
return this.viewer.find('.current.image').parents('.ribbon').first()
|
|
|
|
} else if(typeof(target) == typeof('str')){
|
|
//return this.viewer.find('.ribbon[gid="'+JSON.stringify(target)+'"]')
|
|
return this.viewer.find('.ribbon[gid='+JSON.stringify(target)+']')
|
|
}
|
|
return $(target).filter('.ribbon')
|
|
},
|
|
getImage: function(target){
|
|
if(target == null) {
|
|
return this.viewer.find('.current.image')
|
|
|
|
} else if(typeof(target) == typeof('str')){
|
|
//return this.viewer.find('.image[gid="'+JSON.stringify(target)+'"]')
|
|
return this.viewer.find('.image[gid='+JSON.stringify(target)+']')
|
|
}
|
|
return $(target).filter('.image')
|
|
},
|
|
|
|
|
|
// Place a ribbon...
|
|
//
|
|
// position can be:
|
|
// - index
|
|
// - ribbon gid
|
|
// - ribbon
|
|
// - null - append the ribbon to the end
|
|
//
|
|
// NOTE: if ribbon does not exist a new ribbon will be created...
|
|
// XXX these will place at current loaded position rather than the
|
|
// actual DATA position...
|
|
// ...is this correct?
|
|
// XXX interaction animation...
|
|
placeRibbon: function(gid, position){
|
|
// get create the ribbon...
|
|
var ribbon = this.getRibbon(gid)
|
|
ribbon = ribbon.length == 0 ? this.createRibbon(gid) : ribbon
|
|
|
|
var ribbons = this.viewer.find('.ribbon')
|
|
// normalize the position...
|
|
var p = this.getRibbon(position)
|
|
position = p.hasClass('ribbon') ? ribbons.index(p) : position
|
|
position = position == null ? -1 : position
|
|
position = position < 0 ? ribbons.length + position + 1 : position
|
|
position = position < 0 ? 0 : position
|
|
|
|
// place the ribbon...
|
|
if(ribbons.length == 0 || ribbons.length <= position){
|
|
this.viewer.find('.ribbon-set').append(ribbon)
|
|
|
|
} else {
|
|
ribbons.eq(position).before(ribbon)
|
|
}
|
|
|
|
// XXX do we need to update the ribbon here???
|
|
return ribbon
|
|
},
|
|
|
|
// Place an image...
|
|
//
|
|
// Place gid at image position and image ribbon:
|
|
// .placeImage(gid, image)
|
|
// -> image
|
|
//
|
|
// Place gid at index in current ribbon:
|
|
// .placeImage(gid, position)
|
|
// -> image
|
|
//
|
|
// Place gid at position in ribbon:
|
|
// .placeImage(gid, ribbon, position)
|
|
// -> image
|
|
//
|
|
//
|
|
// NOTE: if image gid does not exist it will be created.
|
|
// NOTE: index can be negative indicating the position from the tail.
|
|
// NOTE: if index is an image or a gid then the ribbon argument will
|
|
// be ignored and the actual ribbon will be derived from the
|
|
// image given.
|
|
// XXX interaction animation...
|
|
placeImage: function(gid, ribbon, position){
|
|
// get/create the image...
|
|
var img = this.getImage(gid)
|
|
img = img.length == 0 ? this.createImage(gid) : img
|
|
|
|
// normalize the position, ribbon and images...
|
|
if(position == null){
|
|
position = ribbon
|
|
ribbon = null
|
|
}
|
|
var p = this.getImage(position)
|
|
ribbon = p.hasClass('image')
|
|
? p.parents('.ribbon').first()
|
|
: this.getRibbon(ribbon)
|
|
var images = ribbon.find('.image')
|
|
position = p.hasClass('image') ? images.index(p) : position
|
|
position = position < 0 ? images.length + position + 1 : position
|
|
position = position < 0 ? 0 : position
|
|
|
|
// place the image...
|
|
if(images.length == 0 || images.length <= position){
|
|
ribbon.append(img)
|
|
|
|
} else {
|
|
images.eq(position).before(img)
|
|
}
|
|
|
|
//return image.updateImage(img)
|
|
return img
|
|
},
|
|
|
|
// XXX do we need shorthands like shiftImageUp/shiftImageDown/... here?
|
|
|
|
|
|
// Bulk manipulation...
|
|
|
|
// NOTE: gids and ribbon must be .getImage(..) and .getRibbon(..)
|
|
// compatible...
|
|
// XXX do we need an image pool here???
|
|
showImagesInRibbon: function(gids, ribbon){
|
|
// get/create the ribbon...
|
|
var r = this.getRibbon(ribbon)
|
|
if(r.length == 0){
|
|
// no such ribbon exists, then create and append it...
|
|
r = this.placeRibbon(ribbon, this.viewer.find('.ribbon').length)
|
|
}
|
|
|
|
var loaded = r.find('.image')
|
|
|
|
var that = this
|
|
$(gids).each(function(i, gid){
|
|
// get/create image...
|
|
var img = that.getImage(gid)
|
|
img = img.length == 0 ? that.createImage(gid) : img
|
|
|
|
// clear images that are not in gids...
|
|
var g = loaded.length > i ? that.getElemGID(loaded.eq(i)) : null
|
|
while(g != null && gids.indexOf(g) < 0){
|
|
that.clear(g)
|
|
loaded.splice(i, 1)
|
|
g = loaded.length > i ? that.getElemGID(loaded.eq(i)) : null
|
|
}
|
|
|
|
// check if we need to reattach the image...
|
|
if(gid != g){
|
|
// append the image to set...
|
|
if(loaded.length == 0 || loaded.length <= i){
|
|
r.append(img.detach())
|
|
|
|
// attach the image at i...
|
|
} else {
|
|
// update the DOM...
|
|
loaded.eq(i).before(img.detach())
|
|
|
|
// update the loaded list...
|
|
var l = loaded.index(img)
|
|
if(l >= 0){
|
|
loaded.splice(l, 1)
|
|
}
|
|
loaded.splice(i, 0, img)
|
|
}
|
|
}
|
|
|
|
//image.updateImage(img)
|
|
})
|
|
|
|
// remove the rest of the stuff in ribbon...
|
|
if(loaded.length > gids.length){
|
|
loaded.eq(gids.length).nextAll().remove()
|
|
loaded.eq(gids.length).remove()
|
|
}
|
|
|
|
return this
|
|
},
|
|
// XXX do we need anything else here? ..seems too simple :)
|
|
loadData: function(data){
|
|
var that = this
|
|
data.ribbon_order.forEach(function(gid){
|
|
that.showImagesInRibbon(data.ribbons[gid], gid)
|
|
})
|
|
return this
|
|
},
|
|
|
|
|
|
// Clear elements...
|
|
//
|
|
// Clear all elements:
|
|
// .clear()
|
|
// .clear('*')
|
|
// -> Ribbons
|
|
//
|
|
// Clear an image or a ribbon by gid:
|
|
// .clear(gid)
|
|
// -> Ribbons
|
|
//
|
|
// Clear a set of elements:
|
|
// .clear([gid, ...])
|
|
// -> Ribbons
|
|
//
|
|
//
|
|
// NOTE: another way to remove a ribbon or an image just to use
|
|
// .getRibbon(..).remove() and .getImage(...).remove() respectivly.
|
|
clear: function(gids){
|
|
// clear all...
|
|
if(gids == null || gids == '*'){
|
|
this.viewer.find('.ribbon').remove()
|
|
|
|
// clear one or more gids...
|
|
} else {
|
|
gids = gids.constructor.name != 'Array' ? [gids] : gids
|
|
var that = this
|
|
gids.forEach(function(g){
|
|
that.viewer.find('[gid='+JSON.stringify(g)+']').remove()
|
|
})
|
|
}
|
|
return this
|
|
},
|
|
|
|
|
|
// UI manipulation...
|
|
|
|
// XXX if target is an image align the ribbon both vertically and horizontally...
|
|
alignRibbon: function(target, mode){
|
|
// XXX
|
|
},
|
|
|
|
// XXX
|
|
fitNImages: function(n){
|
|
// XXX
|
|
},
|
|
|
|
|
|
// XXX this does not align anything, it's just a low level focus...
|
|
// XXX interaction animation...
|
|
focusImage: function(gid){
|
|
this.viewer
|
|
.find('.current.image')
|
|
.removeClass('current')
|
|
return this.getImage(gid)
|
|
.addClass('current')
|
|
},
|
|
|
|
|
|
// Image manipulation...
|
|
|
|
// Rotate an image...
|
|
//
|
|
// direction can be:
|
|
// XXX not sure if we need these as attrs...
|
|
CW: 'cw',
|
|
CCW: 'ccw',
|
|
//
|
|
// rotation tables...
|
|
// NOTE: setting a value to null will remove the attribute, 0 will
|
|
// set 0 explicitly...
|
|
_cw: {
|
|
null: 90,
|
|
0: 90,
|
|
90: 180,
|
|
180: 270,
|
|
//270: 0,
|
|
270: null,
|
|
},
|
|
_ccw: {
|
|
null: 270,
|
|
0: 270,
|
|
//90: 0,
|
|
90: null,
|
|
180: 90,
|
|
270: 180,
|
|
},
|
|
rotateImage: function(target, direction){
|
|
var r_table = direction == this.CW ? this._cw : this._ccw
|
|
target = this.getImage(target)
|
|
target.each(function(i, e){
|
|
var img = $(this)
|
|
var o = img.attr('orientation')
|
|
o = r_table[ o == null ? null : o ]
|
|
if(o == null){
|
|
img.removeAttr('orientation')
|
|
} else {
|
|
img.attr('orientation', o)
|
|
}
|
|
// account for proportions...
|
|
image.correctImageProportionsForRotation(img)
|
|
// XXX this is a bit of an overkill but it will update the
|
|
// preview if needed...
|
|
//image.updateImage(img)
|
|
})
|
|
return target
|
|
},
|
|
|
|
// Flip an image...
|
|
//
|
|
// direction can be:
|
|
// XXX not sure if we need these as attrs...
|
|
VERTICAL: 'vertical',
|
|
HORIZONTAL: 'horizontal',
|
|
flipImage: function(target, direction){
|
|
target = this.getImage(target)
|
|
target.each(function(i, e){
|
|
var img = $(this)
|
|
|
|
// get the state...
|
|
var state = img.attr('flipped')
|
|
state = (state == null ? '' : state)
|
|
.split(',')
|
|
.map(function(e){ return e.trim() })
|
|
.filter(function(e){ return e != '' })
|
|
|
|
// toggle the specific state...
|
|
var i = state.indexOf(direction)
|
|
if(i >= 0){
|
|
state.splice(i, 1)
|
|
} else {
|
|
state.push(direction)
|
|
}
|
|
|
|
// write the state...
|
|
if(state.length == 0){
|
|
img.removeAttr('flipped')
|
|
} else {
|
|
img.attr('flipped', state.join(', '))
|
|
}
|
|
})
|
|
return target
|
|
},
|
|
|
|
// shorthands...
|
|
// XXX should these be here???
|
|
//rotateCW: function(target){ return this.rotateImage(target, this.CW) },
|
|
//rotateCCW: function(target){ return this.rotateImage(target, this.CCW) },
|
|
//flipVertical: function(target){ return this.flipImage(target, this.VERTICAL) },
|
|
//flipHorizontal: function(target){ return this.flipImage(target, this.HORIZONTAL) },
|
|
|
|
|
|
_setup: function(viewer){
|
|
this.viewer = $(viewer)
|
|
},
|
|
}
|
|
|
|
|
|
// Main Ribbons object...
|
|
//
|
|
var Ribbons =
|
|
module.Ribbons =
|
|
function Ribbons(viewer){
|
|
// in case this is called as a function (without new)...
|
|
if(this.constructor.name != 'Ribbons'){
|
|
return new Ribbons(viewer)
|
|
}
|
|
|
|
this.viewer = $(viewer)
|
|
|
|
return this
|
|
}
|
|
Ribbons.__proto__ = RibbonsClassPrototype
|
|
Ribbons.prototype = RibbonsPrototype
|
|
Ribbons.prototype.constructor = Ribbons
|
|
|
|
|
|
|
|
/**********************************************************************
|
|
* vim:set ts=4 sw=4 : */
|
|
return module })
|