File: /home/iestorre/moodleAW/moodle10/lib/yui/src/dock/js/dock.js
/**
* Dock JS.
*
* This file contains the DOCK object and all dock related global namespace methods and properties.
*
* @module moodle-core-dock
*/
var LOGNS = 'moodle-core-dock',
BODY = Y.one(Y.config.doc.body),
CSS = {
dock: 'dock', // CSS Class applied to the dock box
dockspacer: 'dockspacer', // CSS class applied to the dockspacer
controls: 'controls', // CSS class applied to the controls box
body: 'has_dock', // CSS class added to the body when there is a dock
buttonscontainer: 'buttons_container',
dockeditem: 'dockeditem', // CSS class added to each item in the dock
dockeditemcontainer: 'dockeditem_container',
dockedtitle: 'dockedtitle', // CSS class added to the item's title in each dock
activeitem: 'activeitem', // CSS class added to the active item
contentonly: 'content-only',
dockonload: 'dock_on_load'
},
SELECTOR = {
dockableblock: '.block[data-instanceid][data-dockable]',
blockmoveto: '.block[data-instanceid][data-dockable] .moveto',
panelmoveto: '#dockeditempanel .commands a.moveto',
dockonload: '.block.'+CSS.dockonload,
blockregion: '[data-blockregion]'
},
DOCK,
DOCKPANEL,
TABHEIGHTMANAGER,
BLOCK,
DOCKEDITEM;
/**
* Core namespace.
*
* @static
* @namespace M
* @class core
*/
M.core = M.core || {};
/**
* Dock namespace.
*
* @static
* @namespace M.core
* @class dock
*/
M.core.dock = M.core.dock || {};
/**
* The dock - once initialised.
*
* @private
* @property _dock
* @type DOCK
*/
M.core.dock._dock = null;
/**
* An associative array of dockable blocks.
* @property _dockableblocks
* @type {Array} An array of BLOCK objects organised by instanceid.
* @private
*/
M.core.dock._dockableblocks = {};
/**
* Initialises the dock.
* This method registers dockable blocks, and creates delegations to dock them.
* @static
* @method init
*/
M.core.dock.init = function() {
Y.all(SELECTOR.dockableblock).each(M.core.dock.registerDockableBlock);
BODY.delegate('click', M.core.dock.dockBlock, SELECTOR.blockmoveto);
BODY.delegate('key', M.core.dock.dockBlock, SELECTOR.blockmoveto, 'enter');
};
/**
* Returns an instance of the dock.
* Initialises one if one hasn't already being initialised.
*
* @static
* @method get
* @return DOCK
*/
M.core.dock.get = function() {
if (this._dock === null) {
this._dock = new DOCK();
}
return this._dock;
};
/**
* Registers a dockable block with the dock.
*
* @static
* @method registerDockableBlock
* @param {int} id The block instance ID.
* @return void
*/
M.core.dock.registerDockableBlock = function(id) {
if (typeof id === 'object' && typeof id.getData === 'function') {
id = id.getData('instanceid');
}
M.core.dock._dockableblocks[id] = new BLOCK({id : id});
};
/**
* Docks a block given either its instanceid, its node, or an event fired from within the block.
* @static
* @method dockBlockByInstanceID
* @param id
* @return void
*/
M.core.dock.dockBlock = function(id) {
if (typeof id === 'object' && id.target !== 'undefined') {
id = id.target;
}
if (typeof id === "object") {
if (!id.test(SELECTOR.dockableblock)) {
id = id.ancestor(SELECTOR.dockableblock);
}
if (typeof id === 'object' && typeof id.getData === 'function' && !id.ancestor('.'+CSS.dock)) {
id = id.getData('instanceid');
} else {
Y.log('Invalid instanceid given to dockBlockByInstanceID', 'warn', LOADERNAME);
return;
}
}
var block = M.core.dock._dockableblocks[id];
if (block) {
block.moveToDock();
}
};
/**
* Fixes the title orientation. Rotating it if required.
*
* @static
* @method fixTitleOrientation
* @param {Node} title The title node we are looking at.
* @param {String} text The string to use as the title.
* @return {Node} The title node to use.
*/
M.core.dock.fixTitleOrientation = function(title, text) {
var dock = M.core.dock.get(),
fontsize = '11px',
transform = 'rotate(270deg)',
test,
width,
height,
container;
title = Y.one(title);
if (dock.get('orientation') !== 'vertical') {
// If the dock isn't vertical don't adjust it!
title.set('innerHTML', text);
return title;
}
if (Y.UA.ie > 0 && Y.UA.ie < 8) {
// IE 6/7 can't rotate text so force ver
M.str.langconfig.thisdirectionvertical = 'ver';
}
switch (M.str.langconfig.thisdirectionvertical) {
case 'ver':
// Stacked is easy
return title.set('innerHTML', text.split('').join('<br />'));
case 'ttb':
transform = 'rotate(90deg)';
break;
case 'btt':
// Nothing to do here. transform default is good.
break;
}
if (Y.UA.ie === 8) {
// IE8 can flip the text via CSS but not handle transform. IE9+ can handle the CSS3 transform attribute.
title.set('innerHTML', text);
title.setAttribute('style', 'writing-mode: tb-rl; filter: flipV flipH;display:inline;');
title.addClass('filterrotate');
return title;
}
// We need to fix a font-size - sorry theme designers.
test = Y.Node.create('<h2 class="transform-test-heading"><span class="transform-test-node" style="font-size:'+fontsize+';">'+text+'</span></h2>');
BODY.insert(test, 0);
width = test.one('span').get('offsetWidth') * 1.2;
height = test.one('span').get('offsetHeight');
test.remove();
title.set('innerHTML', text);
title.addClass('css3transform');
// Move the title into position
title.setStyles({
'position' : 'relative',
'fontSize' : fontsize,
'width' : width,
'top' : (width - height)/2
});
// Positioning is different when in RTL mode.
if (right_to_left()) {
title.setStyle('left', width/2 - height);
} else {
title.setStyle('right', width/2 - height);
}
// Rotate the text
title.setStyles({
'transform' : transform,
'-ms-transform' : transform,
'-moz-transform' : transform,
'-webkit-transform' : transform,
'-o-transform' : transform
});
container = Y.Node.create('<div></div>');
container.append(title);
container.setStyles({
height : width + (width / 4),
position : 'relative'
});
return container;
};
/**
* Informs the dock that the content of the block has changed.
* This should be called by the blocks JS code if its content has been updated dynamically.
* This method ensure the dock resizes if need be.
*
* @static
* @method notifyBlockChange
* @param {Number} instanceid
* @return void
*/
M.core.dock.notifyBlockChange = function(instanceid) {
if (this._dock !== null) {
var dock = M.core.dock.get(),
activeitem = dock.getActiveItem();
if (activeitem && activeitem.get('blockinstanceid') === parseInt(instanceid, 10)) {
dock.resizePanelIfRequired();
}
}
};
/**
* The Dock.
*
* @namespace M.core.dock
* @class Dock
* @constructor
* @extends Y.Base
* @uses Y.EventTarget
*/
DOCK = function() {
DOCK.superclass.constructor.apply(this, arguments);
};
DOCK.prototype = {
/**
* Tab height manager used to ensure tabs are always visible.
* @protected
* @property tabheightmanager
* @type TABHEIGHTMANAGER
*/
tabheightmanager : null,
/**
* Will be an eventtype if there is an eventype to prevent.
* @protected
* @property preventevent
* @type String
*/
preventevent : null,
/**
* Will be an object if there is a delayed event in effect.
* @protected
* @property delayedevent
* @type {Object}
*/
delayedevent : null,
/**
* An array of currently docked items.
* @protected
* @property dockeditems
* @type Array
*/
dockeditems : [],
/**
* Set to true once the dock has been drawn.
* @protected
* @property dockdrawn
* @type Boolean
*/
dockdrawn : false,
/**
* The number of blocks that are currently docked.
* @protected
* @property count
* @type Number
*/
count : 0,
/**
* The total number of blocks that have been docked.
* @protected
* @property totalcount
* @type Number
*/
totalcount : 0,
/**
* A hidden node used as a holding area for DOM objects used by blocks that have been docked.
* @protected
* @property holdingareanode
* @type Node
*/
holdingareanode : null,
/**
* Called during the initialisation process of the object.
* @method initializer
*/
initializer : function() {
Y.log('Dock initialising', 'debug', LOGNS);
// Publish the events the dock has
/**
* Fired when the dock first starts initialising.
* @event dock:starting
*/
this.publish('dock:starting', {prefix: 'dock',broadcast: 2,emitFacade: true, fireOnce:true});
/**
* Fired after the dock is initialised for the first time.
* @event dock:initialised
*/
this.publish('dock:initialised', {prefix: 'dock',broadcast: 2,emitFacade: true, fireOnce:true});
/**
* Fired before the dock structure and content is first created.
* @event dock:beforedraw
*/
this.publish('dock:beforedraw', {prefix:'dock', fireOnce:true});
/**
* Fired before the dock is changed from hidden to visible.
* @event dock:beforeshow
*/
this.publish('dock:beforeshow', {prefix:'dock'});
/**
* Fires after the dock has been changed from hidden to visible.
* @event dock:shown
*/
this.publish('dock:shown', {prefix:'dock'});
/**
* Fired after the dock has been changed from visible to hidden.
* @event dock:hidden
*/
this.publish('dock:hidden', {prefix:'dock'});
/**
* Fires when an item is added to the dock.
* @event dock:itemadded
*/
this.publish('dock:itemadded', {prefix:'dock'});
/**
* Fires when an item is removed from the dock.
* @event dock:itemremoved
*/
this.publish('dock:itemremoved', {prefix:'dock'});
/**
* Fires when a block is added or removed from the dock.
* This happens after the itemadded and itemremoved events have been called.
* @event dock:itemschanged
*/
this.publish('dock:itemschanged', {prefix:'dock'});
/**
* Fires once when the docks panel is first initialised.
* @event dock:panelgenerated
*/
this.publish('dock:panelgenerated', {prefix:'dock', fireOnce:true});
/**
* Fires when the dock panel is about to be resized.
* @event dock:panelresizestart
*/
this.publish('dock:panelresizestart', {prefix:'dock'});
/**
* Fires after the dock panel has been resized.
* @event dock:resizepanelcomplete
*/
this.publish('dock:resizepanelcomplete', {prefix:'dock'});
// Apply theme customisations here before we do any real work.
this._applyThemeCustomisation();
// Inform everyone we are now about to initialise.
this.fire('dock:starting');
this._ensureDockDrawn();
// Inform everyone the dock has been initialised
this.fire('dock:initialised');
},
/**
* Ensures that the dock has been drawn.
* @private
* @method _ensureDockDrawn
* @return {Boolean}
*/
_ensureDockDrawn : function() {
if (this.dockdrawn === true) {
return true;
}
var dock = this._initialiseDockNode(),
clickargs = {
cssselector:'.'+CSS.dockedtitle,
delay:0
},
mouseenterargs = {
cssselector:'.'+CSS.dockedtitle,
delay:0.5,
iscontained:true,
preventevent:'click',
preventdelay:3
};
if (Y.UA.ie > 0 && Y.UA.ie < 7) {
// Adjust for IE 6 (can't handle fixed pos)
dock.setStyle('height', dock.get('winHeight')+'px');
}
this.fire('dock:beforedraw');
this._initialiseDockControls();
this.tabheightmanager = new TABHEIGHTMANAGER({dock:this});
// Attach the required event listeners
// We use delegate here as that way a handful of events are created for the dock
// and all items rather than the same number for the dock AND every item individually
Y.delegate('click', this.handleEvent, this.get('dockNode'), '.'+CSS.dockedtitle, this, clickargs);
Y.delegate('mouseenter', this.handleEvent, this.get('dockNode'), '.'+CSS.dockedtitle, this, mouseenterargs);
this.get('dockNode').on('mouseleave', this.handleEvent, this, {cssselector:'#dock', delay:0.5, iscontained:false});
Y.delegate('click', this.handleReturnToBlock, this.get('dockNode'), SELECTOR.panelmoveto, this);
Y.delegate('click', this.handleReturnToBlock, this.get('dockNode'), SELECTOR.panelmoveto, this);
Y.delegate('dock:actionkey', this.handleDockedItemEvent, this.get('dockNode'), '.'+CSS.dockeditem, this);
BODY.on('click', this.handleEvent, this, {cssselector:'body', delay:0});
this.on('dock:itemschanged', this.resizeBlockSpace, this);
this.on('dock:itemschanged', this.checkDockVisibility, this);
this.on('dock:itemschanged', this.resetFirstItem, this);
this.dockdrawn = true;
return true;
},
/**
* Handles an actionkey event on the dock.
* @param {EventFacade} e
* @method handleDockedItemEvent
* @return {Boolean}
*/
handleDockedItemEvent : function(e) {
if (e.type !== 'dock:actionkey') {
return false;
}
var target = e.target,
dockeditem = '.'+CSS.dockeditem;
if (!target.test(dockeditem)) {
target = target.ancestor(dockeditem);
}
if (!target) {
return false;
}
e.halt();
this.dockeditems[target.getAttribute('rel')].toggle(e.action);
},
/**
* Call the theme customisation method "customise_dock_for_theme" if it exists.
* @private
* @method _applyThemeCustomisation
*/
_applyThemeCustomisation : function() {
// Check if there is a customisation function
if (typeof(customise_dock_for_theme) === 'function') {
// First up pre the legacy object.
M.core_dock = this;
M.core_dock.cfg = {
buffer : null,
orientation : null,
position : null,
spacebeforefirstitem : null,
removeallicon : null
};
M.core_dock.css = {
dock : null,
dockspacer : null,
controls : null,
body : null,
buttonscontainer : null,
dockeditem : null,
dockeditemcontainer : null,
dockedtitle : null,
activeitem : null
};
try {
// Run the customisation function
customise_dock_for_theme(this);
} catch (exception) {
// Do nothing at the moment.
Y.log('Exception while attempting to apply theme customisations.', 'error', LOGNS);
}
// Now to work out what they did.
var key, value,
warned = false,
cfgmap = {
buffer : 'bufferPanel',
orientation : 'orientation',
position : 'position',
spacebeforefirstitem : 'bufferBeforeFirstItem',
removeallicon : 'undockAllIconUrl'
};
// Check for and apply any legacy configuration.
for (key in M.core_dock.cfg) {
if (Y.Lang.isString(key) && cfgmap[key]) {
value = M.core_dock.cfg[key];
if (value === null) {
continue;
}
if (!warned) {
Y.log('Warning: customise_dock_for_theme has changed. Please update your code.', 'warn', LOGNS);
warned = true;
}
// Damn, the've set something.
Y.log('Note for customise_dock_for_theme code: M.core_dock.cfg.'+key+' is now dock.set(\''+key+'\', value)', 'debug', LOGNS);
this.set(cfgmap[key], value);
}
}
// Check for and apply any legacy CSS changes..
for (key in M.core_dock.css) {
if (Y.Lang.isString(key)) {
value = M.core_dock.css[key];
if (value === null) {
continue;
}
if (!warned) {
Y.log('Warning: customise_dock_for_theme has changed. Please update your code.', 'warn', LOGNS);
warned = true;
}
// Damn, they've set something.
Y.log('Note for customise_dock_for_theme code: M.core_dock.css.'+key+' is now CSS.'+key+' = value', 'debug', LOGNS);
CSS[key] = value;
}
}
}
},
/**
* Initialises the dock node, creating it and its content if required.
*
* @private
* @method _initialiseDockNode
* @return {Node} The dockNode
*/
_initialiseDockNode : function() {
var dock = this.get('dockNode'),
positionorientationclass = CSS.dock+'_'+this.get('position')+'_'+this.get('orientation'),
holdingarea = Y.Node.create('<div></div>').setStyles({display:'none'}),
buttons = this.get('buttonsNode'),
container = this.get('itemContainerNode');
if (!dock) {
dock = Y.one('#'+CSS.dock);
}
if (!dock) {
dock = Y.Node.create('<div id="'+CSS.dock+'"></div>');
BODY.append(dock);
}
dock.setAttribute('role', 'menubar').addClass(positionorientationclass);
if (Y.all(SELECTOR.dockonload).size() === 0) {
// Nothing on the dock... hide it using CSS
dock.addClass('nothingdocked');
} else {
positionorientationclass = CSS.body+'_'+this.get('position')+'_'+this.get('orientation');
BODY.addClass(CSS.body).addClass();
}
if (!buttons) {
buttons = dock.one('.'+CSS.buttonscontainer);
}
if (!buttons) {
buttons = Y.Node.create('<div class="'+CSS.buttonscontainer+'"></div>');
dock.append(buttons);
}
if (!container) {
container = dock.one('.'+CSS.dockeditemcontainer);
}
if (!container) {
container = Y.Node.create('<div class="'+CSS.dockeditemcontainer+'"></div>');
buttons.append(container);
}
BODY.append(holdingarea);
this.holdingareanode = holdingarea;
this.set('dockNode', dock);
this.set('buttonsNode', buttons);
this.set('itemContainerNode', container);
return dock;
},
/**
* Initialises the dock controls.
*
* @private
* @method _initialiseDockControls
*/
_initialiseDockControls : function() {
// Add a removeall button
// Must set the image src seperatly of we get an error with XML strict headers
var removeall = Y.Node.create('<img alt="'+M.util.get_string('undockall', 'block')+'" tabindex="0" />');
removeall.setAttribute('src',this.get('undockAllIconUrl'));
removeall.on('removeall|click', this.removeAll, this);
removeall.on('dock:actionkey', this.removeAll, this, {actions:{enter:true}});
this.get('buttonsNode').append(Y.Node.create('<div class="'+CSS.controls+'"></div>').append(removeall));
},
/**
* Returns the dock panel. Initialising it if it hasn't already been initialised.
* @method getPanel
* @return {DOCKPANEL}
*/
getPanel : function() {
var panel = this.get('panel');
if (!panel) {
panel = new DOCKPANEL({dock:this});
panel.on('panel:visiblechange', this.resize, this);
Y.on('windowresize', this.resize, this);
// Initialise the dockpanel .. should only happen once
this.set('panel', panel);
this.fire('dock:panelgenerated');
}
return panel;
},
/**
* Resizes the dock panel if required.
* @method resizePanelIfRequired
*/
resizePanelIfRequired : function() {
this.resize();
var panel = this.get('panel');
if (panel) {
panel.correctWidth();
}
},
/**
* Handles a dock event sending it to the right place.
*
* @method handleEvent
* @param {EventFacade} e
* @param {Object} options
* @return {Boolean}
*/
handleEvent : function(e, options) {
var item = this.getActiveItem(),
target,
targetid,
regex = /^dock_item_(\d+)_title$/,
self = this;
if (options.cssselector === 'body') {
if (!this.get('dockNode').contains(e.target)) {
if (item) {
item.hide();
}
}
} else {
if (e.target.test(options.cssselector)) {
target = e.target;
} else {
target = e.target.ancestor(options.cssselector);
}
if (!target) {
return true;
}
if (this.preventevent !== null && e.type === this.preventevent) {
return true;
}
if (options.preventevent) {
this.preventevent = options.preventevent;
if (options.preventdelay) {
setTimeout(function(){
self.preventevent = null;
}, options.preventdelay * 1000);
}
}
if (this.delayedevent && this.delayedevent.timeout) {
clearTimeout(this.delayedevent.timeout);
this.delayedevent.event.detach();
this.delayedevent = null;
}
if (options.delay > 0) {
return this.delayEvent(e, options, target);
}
targetid = target.get('id');
if (targetid.match(regex)) {
item = this.dockeditems[targetid.replace(regex, '$1')];
if (item.active) {
item.hide();
} else {
item.show();
}
} else if (item) {
item.hide();
}
}
return true;
},
/**
* Delays an event.
*
* @method delayEvent
* @param {EventFacade} event
* @param {Object} options
* @param {Node} target
* @return {Boolean}
*/
delayEvent : function(event, options, target) {
var self = this;
self.delayedevent = (function(){
return {
target : target,
event : BODY.on('mousemove', function(e){
self.delayedevent.target = e.target;
}),
timeout : null
};
})(self);
self.delayedevent.timeout = setTimeout(function(){
self.delayedevent.timeout = null;
self.delayedevent.event.detach();
if (options.iscontained === self.get('dockNode').contains(self.delayedevent.target)) {
self.handleEvent(event, {cssselector:options.cssselector, delay:0, iscontained:options.iscontained});
}
}, options.delay*1000);
return true;
},
/**
* Resizes block spaces.
* @method resizeBlockSpace
*/
resizeBlockSpace : function() {
if (Y.all(SELECTOR.dockonload).size() > 0) {
// Do not resize during initial load
return;
}
var blockregions = [],
populatedblockregions = 0,
allnewregions = true,
showregions = false,
i;
// First look for understood regions.
Y.all(SELECTOR.blockregion).each(function(region){
var regionname = region.getData('blockregion');
if (region.all('.block').size() > 0) {
populatedblockregions++;
BODY.addClass('used-region-'+regionname);
BODY.removeClass('empty-region-'+regionname);
BODY.removeClass('docked-region-'+regionname);
} else if (region.all('.block_dock_placeholder').size() > 0) {
// There are no blocks in the region but there are placeholders.
// All blocks in this region have been docked.
BODY.addClass('empty-region-'+regionname);
BODY.addClass('docked-region-'+regionname);
BODY.removeClass('used-region-'+regionname);
}
});
// Next check for legacy regions.
Y.all('.block-region').each(function(region){
if (region.test(SELECTOR.blockregion)) {
// This is a new region, we've already processed it.
return;
}
var hasblocks = (region.all('.block').size() > 0);
if (hasblocks) {
populatedblockregions++;
}
allnewregions = false;
blockregions[region.get('id')] = {
hasblocks : hasblocks,
bodyclass : region.get('id').replace(/^region\-/, 'side-')+'-only'
};
});
if (BODY.hasClass('blocks-moving')) {
// open up blocks during blocks positioning
showregions = true;
}
if (populatedblockregions === 0 && showregions === false) {
BODY.addClass(CSS.contentonly);
} else {
BODY.removeClass(CSS.contentonly);
}
if (!allnewregions) {
if (populatedblockregions === 0 && showregions === false) {
for (i in blockregions) {
if (blockregions[i].bodyclass) {
BODY.removeClass(blockregions[i].bodyclass);
}
}
} else if (populatedblockregions === 1 && showregions === false) {
for (i in blockregions) {
if (blockregions[i].bodyclass) {
if (!blockregions[i].hasblocks) {
BODY.removeClass(blockregions[i].bodyclass);
} else {
BODY.addClass(blockregions[i].bodyclass);
}
}
}
} else {
for (i in blockregions) {
if (blockregions[i].bodyclass) {
BODY.removeClass(blockregions[i].bodyclass);
}
}
}
}
},
/**
* Adds an item to the dock.
* @method add
* @param {DOCKEDITEM} item
*/
add : function(item) {
// Set the dockitem id to the total count and then increment it.
item.set('id', this.totalcount);
Y.log('Adding block '+item._getLogDescription()+' to the dock.', 'debug', LOGNS);
this.count++;
this.totalcount++;
this.dockeditems[item.get('id')] = item;
this.dockeditems[item.get('id')].draw();
this.fire('dock:itemadded', item);
this.fire('dock:itemschanged', item);
},
/**
* Appends an item to the dock (putting it in the item container.
* @method append
* @param {Node} docknode
*/
append : function(docknode) {
this.get('itemContainerNode').append(docknode);
},
/**
* Handles events that require a docked block to be returned to the page./
* @method handleReturnToBlock
* @param {EventFacade} e
*/
handleReturnToBlock : function(e) {
e.halt();
this.remove(this.getActiveItem().get('id'));
},
/**
* Removes a docked item from the dock.
* @method remove
* @param {Number} id The docked item id.
* @return {Boolean}
*/
remove : function(id) {
if (!this.dockeditems[id]) {
return false;
}
Y.log('Removing block '+this.dockeditems[id]._getLogDescription()+' from the dock.', 'debug', LOGNS);
this.dockeditems[id].remove();
delete this.dockeditems[id];
this.count--;
this.fire('dock:itemremoved', id);
this.fire('dock:itemschanged', id);
return true;
},
/**
* Ensures the the first item in the dock has the correct class.
* @method resetFirstItem
*/
resetFirstItem : function() {
this.get('dockNode').all('.'+CSS.dockeditem+'.firstdockitem').removeClass('firstdockitem');
if (this.get('dockNode').one('.'+CSS.dockeditem)) {
this.get('dockNode').one('.'+CSS.dockeditem).addClass('firstdockitem');
}
},
/**
* Removes all docked blocks returning them to the page.
* @method removeAll
* @return {Boolean}
*/
removeAll : function() {
Y.log('Undocking all '+this.dockeditems.length+' blocks', 'debug', LOGNS);
var i;
for (i in this.dockeditems) {
if (Y.Lang.isNumber(i) || Y.Lang.isString(i)) {
this.remove(i);
}
}
return true;
},
/**
* Hides the active item.
* @method hideActive
*/
hideActive : function() {
var item = this.getActiveItem();
if (item) {
item.hide();
}
},
/**
* Checks wether the dock should be shown or hidden
* @method checkDockVisibility
*/
checkDockVisibility : function() {
var bodyclass = CSS.body+'_'+this.get('position')+'_'+this.get('orientation');
if (!this.count) {
this.get('dockNode').addClass('nothingdocked');
BODY.removeClass(CSS.body).removeClass();
this.fire('dock:hidden');
} else {
this.fire('dock:beforeshow');
this.get('dockNode').removeClass('nothingdocked');
BODY.addClass(CSS.body).addClass(bodyclass);
this.fire('dock:shown');
}
},
/**
* This function checks the size and position of the panel and moves/resizes if
* required to keep it within the bounds of the window.
* @method resize
* @return {Boolean}
*/
resize : function() {
var panel = this.getPanel(),
item = this.getActiveItem(),
buffer,
screenh,
docky,
titletop,
containery,
containerheight,
scrolltop,
panelheight,
dockx,
titleleft;
if (!panel.get('visible') || !item) {
return true;
}
this.fire('dock:panelresizestart');
if (this.get('orientation') === 'vertical') {
buffer = this.get('bufferPanel');
screenh = parseInt(BODY.get('winHeight'), 10)-(buffer*2);
docky = this.get('dockNode').getY();
titletop = item.get('dockTitleNode').getY()-docky-buffer;
containery = this.get('itemContainerNode').getY();
containerheight = containery-docky+this.get('buttonsNode').get('offsetHeight');
scrolltop = panel.get('bodyNode').get('scrollTop');
panel.get('bodyNode').setStyle('height', 'auto');
panel.get('node').removeClass('oversized_content');
panelheight = panel.get('node').get('offsetHeight');
if (Y.UA.ie > 0 && Y.UA.ie < 7) {
panel.setTop(item.get('dockTitleNode').getY());
} else if (panelheight > screenh) {
panel.setTop(buffer-containerheight);
panel.get('bodyNode').setStyle('height', (screenh-panel.get('headerNode').get('offsetHeight'))+'px');
panel.get('node').addClass('oversized_content');
} else if (panelheight > (screenh-(titletop-buffer))) {
panel.setTop(titletop-containerheight-(panelheight - (screenh-titletop))+buffer);
} else {
panel.setTop(titletop-containerheight+buffer);
}
if (scrolltop) {
panel.get('bodyNode').set('scrollTop', scrolltop);
}
}
if (this.get('position') === 'right') {
panel.get('node').setStyle('left', '-' + panel.get('node').get('offsetWidth') + 'px');
} else if (this.get('position') === 'top') {
dockx = this.get('dockNode').getX();
titleleft = item.get('dockTitleNode').getX()-dockx;
panel.get('node').setStyle('left', titleleft+'px');
}
this.fire('dock:resizepanelcomplete');
return true;
},
/**
* Returns the currently active dock item or false
* @method getActiveItem
* @return {DOCKEDITEM}
*/
getActiveItem : function() {
var i;
for (i in this.dockeditems) {
if (this.dockeditems[i].active) {
return this.dockeditems[i];
}
}
return false;
},
/**
* Adds an item to the holding area.
* @method addToHoldingArea
* @param {Node} node
*/
addToHoldingArea : function(node) {
this.holdingareanode.append(node);
}
};
Y.extend(DOCK, Y.Base, DOCK.prototype, {
NAME : 'moodle-core-dock',
ATTRS : {
/**
* The dock itself. #dock.
* @attribute dockNode
* @type Node
* @writeOnce
*/
dockNode : {
writeOnce : true
},
/**
* The docks panel.
* @attribute panel
* @type DOCKPANEL
* @writeOnce
*/
panel : {
writeOnce : true
},
/**
* A container within the dock used for buttons.
* @attribute buttonsNode
* @type Node
* @writeOnce
*/
buttonsNode : {
writeOnce : true
},
/**
* A container within the dock used for docked blocks.
* @attribute itemContainerNode
* @type Node
* @writeOnce
*/
itemContainerNode : {
writeOnce : true
},
/**
* Buffer used when containing a panel.
* @attribute bufferPanel
* @type Number
* @default 10
*/
bufferPanel : {
value : 10,
validator : Y.Lang.isNumber
},
/**
* Position of the dock.
* @attribute position
* @type String
* @default left
*/
position : {
value : 'left',
validator : Y.Lang.isString
},
/**
* vertical || horizontal determines if we change the title
* @attribute orientation
* @type String
* @default vertical
*/
orientation : {
value : 'vertical',
validator : Y.Lang.isString,
setter : function(value) {
if (value.match(/^vertical$/i)) {
return 'vertical';
}
return 'horizontal';
}
},
/**
* Space between the top of the dock and the first item.
* @attribute bufferBeforeFirstItem
* @type Number
* @default 10
*/
bufferBeforeFirstItem : {
value : 10,
validator : Y.Lang.isNumber
},
/**
* Icon URL for the icon to undock all blocks
* @attribute undockAllIconUrl
* @type String
* @default t/dock_to_block
*/
undockAllIconUrl : {
value : M.util.image_url((right_to_left()) ? 't/dock_to_block_rtl' : 't/dock_to_block', 'moodle'),
validator : Y.Lang.isString
}
}
});
Y.augment(DOCK, Y.EventTarget);