/*
* Copyright 2015 Anyware Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This factory creates Ametys.message.MessageTarget for a page.
*
* See #createTargets to know more.
* @private
*/
Ext.define("Ametys.plugins.web.page.PageMessageTargetFactory",
{
extend: "Ametys.message.factory.DefaultMessageTargetFactory",
/**
* Create the targets for a message
* @param {Object} parameters The parameters needed by the factory to create the message. Can not be null. Handled elements are
* @param {String[]} parameters.ids The page's identifiers. Must be present if pages is empty
* @param {Object} [parameters.errorMessage] The error message to display
* @param {Ametys.web.page.Page[]} parameters.pages The pages themselves. Must be present if ids is empty
* @param {Function} callback The callback function called when the targets are created. Parameters are
* @param {Ametys.message.MessageTarget[]} callback.targets The targets created. Cannot be null.
* @param {String} targetId The id of target specified. Useful for gerneric MessageTargetFactories.
* @param {String} cancelCode The cancel code to transmit to the ServerComm. Can be null. Usefull to avoid request that will be discarded such as SelectionChanged events.
*/
createTargets: function(parameters, callback, targetId, cancelCode)
{
if (parameters.ids)
{
Ametys.web.page.PageDAO.getPages (parameters.ids,
Ext.bind(this._createTargets, this, [callback, parameters], true),
null, // Workspace name
parameters.errorMessage,
parameters['zone-name'],
parameters['zoneitem-id'],
cancelCode
);
}
else if (parameters.pages)
{
this._createTargets (parameters.pages, callback, parameters);
}
},
/**
* Create the page targets
* @param {Ametys.web.page.Page[]} pages The pages
* @param {Function} callback The callback function called when the targets are created. Parameters are
* @param {Ametys.message.MessageTarget[]} callback.targets The targets created. Cannot be null.
* @param {Object} parameters The initial parameters of the #createTargets method
* @private
*/
_createTargets: function (pages, callback, parameters)
{
delete parameters['ids'];
delete parameters['pages'];
var targets = [];
for (var i=0; i < pages.length; i++)
{
var subtargets = [];
var page = pages[i];
if (page.getType() == 'CONTAINER')
{
subtargets = this._createZoneTargets(page, parameters['zone-name'], parameters['zoneitem-id'], parameters['content-id'], parameters['zone-width']);
}
targets.push(Ext.create("Ametys.message.MessageTarget", {
id: Ametys.message.MessageTarget.PAGE,
parameters: Ext.merge(pages[i].getProperties(parameters), {page: pages[i]}),
subtargets: subtargets
}));
}
callback(targets);
},
/**
* @private
* Create the zone subtarget
* @param {Ametys.web.page.Page} page The parent page
* @param {String} zoneName The zone name of subtarget to restrict to. Can be null be to create a subtarget for all zones.
* @param {String} zoneItemId The id of zone item to restrict to. Can be null be to create a subtarget for all zone items.
* @param {String} contentId The content id to restrict to. Can be null be to create a subtarget for all contents.
* @param {Number} zoneWidth The width of parent zone.
*/
_createZoneTargets: function (page, zoneName, zoneItemId, contentId, zoneWidth)
{
var targets = [];
var zones = page.getZones();
for (var z=0; z < zones.length; z++)
{
function passesCondition (zone, zoneName, zoneItemId)
{
if (zoneItemId == null)
{
// Only look for zone to check condition
return zoneName == null || zone.name == zoneName;
}
var zoneitems = zone.zoneitems;
for (var i=0; i < zoneitems.length; i++)
{
if (zoneitems[i].id == zoneItemId)
{
return true;
}
}
return false;
}
if (passesCondition(zones[z], zoneName, zoneItemId))
{
var subtargets = this._createZoneItemTargets(zones[z], zoneItemId, contentId, zoneWidth);
targets.push(Ext.create("Ametys.message.MessageTarget", {
id: Ametys.message.MessageTarget.ZONE,
parameters: {
name: zones[z].name,
isModifiable: zones[z].isModifiable
},
subtargets: subtargets
}));
}
}
return targets;
},
/**
* @private
* Create the zone item subtarget
* @param {Object} zone The parent zone
* @param {String} zoneItemId The id of zone item to restrict to. Can be null be to create a subtarget for all zone items.
* @param {String} contentId The content id to restrict to. Can be null be to create a subtarget for all contents.
* @param {Number} zoneWidth The width of parent zone.
*/
_createZoneItemTargets: function (zone, zoneItemId, contentId, zoneWidth)
{
var targets = [];
var zoneitems = zone.zoneitems;
for (var z=0; z < zoneitems.length; z++)
{
if (zoneItemId == null || zoneitems[z].id == zoneItemId)
{
var subtargets = [];
if (zoneitems[z].content)
{
if (contentId == null || zoneitems[z].content.id == contentId)
{
var content = Ext.create ('Ametys.cms.content.Content', Ext.apply(zoneitems[z].content, {'contentWidth': zoneWidth}));
subtargets.push(Ametys.plugins.cms.content.ContentMessageTargetFactory.createTarget(Ametys.message.MessageTarget.CONTENT, content));
}
delete zoneitems[z].content;
}
targets.push(Ext.create("Ametys.message.MessageTarget", {
id: Ametys.message.MessageTarget.ZONE_ITEM,
parameters: zoneitems[z],
subtargets: subtargets
}));
}
}
return targets;
}
}
);
Ext.define("Ametys.message.PageMessageTarget",
{
override: "Ametys.message.MessageTarget",
statics:
{
/**
* @member Ametys.message.MessageTarget
* @readonly
* @property {String} PAGE The target type is a page. See Ametys.plugins.web.page.PageMessageTargetFactory parameters to know more of the associated parameters.
*/
PAGE: "page",
/**
* @member Ametys.message.MessageTarget
* @readonly
* @property {String} ZONE The target type is a zone. See Ametys.plugins.web.page.PageMessageTargetFactory parameters to know more of the associated parameters.
*/
ZONE: "zone",
/**
* @member Ametys.message.MessageTarget
* @readonly
* @property {String} ZONE_ITEM The target type is a zone item. See Ametys.plugins.web.page.PageMessageTargetFactory parameters to know more of the associated parameters.
*/
ZONE_ITEM: "zoneitem"
}
}
);