/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
/**
* A drop-down menu that displays MenuItems about a gadget's metadata.
*
* @module explorer/widgets/gadgetarea/GadgetDropDownMenu
* @requires module:explorer/widgets/MenuItemWidget
* @augments module:explorer/widgets/DropDownMenu
* @augments dijit/_WidgetsInTemplateMixin
* @augments dojo/Evented
* @see {@link http://dojotoolkit.org/reference-guide/1.8/dijit/_WidgetsInTemplateMixin.html|WidgetsInTemplateMixin Documentation}
* @see {@link http://dojotoolkit.org/reference-guide/1.8/dojo/Evented.html|Evented Documentation}
*/
define(['dojo/_base/lang', 'dojo/_base/declare', '../DropDownMenu', 'dojo/Evented', 'dojo/topic',
'dojo/query', 'dojo/dom-class', '../MenuItemWidget', '../../opensocial-data',
'dojo/text!./../../templates/GadgetDropDownMenu.html', 'dijit/_WidgetsInTemplateMixin',
'dojo/on', 'dojo/dom-construct', 'dojo/NodeList-manipulate', 'dojo/NodeList-dom'],
function(lang, declare, DropDownMenu, Evented, topic, query, domClass, MenuItemWidget, osData, template,
WidgetsInTemplateMixin, on, domConstruct) {
return declare('GadgetDropDownMenuWidget', [ DropDownMenu, WidgetsInTemplateMixin, Evented ], {
templateString : template,
/**
* Called right after widget is added to the dom. See link for more information.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @see {@link http://dojotoolkit.org/reference-guide/1.8/dijit/_WidgetBase.html|Dojo Documentation}
*/
startup : function() {
var self = this;
on(this.personMenuOption.domNode,'click', function(e) {
self.publishSelection('opensocial.Person');
});
on(this.fileMenuOption.domNode,'click', function(e) {
self.publishSelection('opensocial.File');
});
on(this.messageMenuOption.domNode,'click', function(e) {
self.publishSelection('opensocial.Message');
});
on(this.preferencesMenuItem.domNode, 'click', function(e) {
topic.publish('org.opensocial.explorer.prefdialog.show');
});
},
/**
* Adds a gadget's views to a MenuItemWidget in the GadgetDropDownMenu.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @param {Object} views - The views object in the gadget's metadata.
*/
setViews : function(views) {
var items = [];
for(var key in views) {
if(views.hasOwnProperty(key)) {
items.push(new MenuItemWidget({"name" : key, "onclick" : lang.hitch(this, function(key){
topic.publish("reRenderGadgetView", {"view" : key});
}, key)}));
}
}
this.viewsMenu.setSubMenuContent(items, 'pull-left');
},
/**
* Adds a gadget's actions to a MenuItemWidget in the GadgetDropDownMenu.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @param {Object} action - The action object in the gadget's metadata to add.
*/
addAction : function(action) {
var actionItem = new MenuItemWidget({"name" : action.label || action.id, "onclick" : action.runAction});
if (action.path) {
// Just add it to the menu
this.actionsMenu.addSubMenuItem(actionItem);
} else {
// It's an action contributed to a type
var typeMenu = this.actionsMenu.getSubMenuItem(action.dataType);
if (!typeMenu) {
typeMenu = new MenuItemWidget({"name" : action.dataType});
this.actionsMenu.addSubMenuItem(typeMenu, 'pull-left');
}
typeMenu.addSubMenuItem(actionItem, 'pull-left');
}
},
/**
* Removes a gadget's actions from a MenuItemWidget in the GadgetDropDownMenu.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @param {Object} action - The action object in the gadget's metadata to remove.
*/
removeAction : function(action) {
// TODO: Removing an action by name is not the most reliable thing to do. Should
// we create an "actionId" to pass to the MenuItemWidget constructor that we can
// use when removing the menu items?
var actionName = action.label || action.id;
if (action.path) {
// Simply remove the item from the subMenu
this.actionsMenu.removeSubMenuItem(actionName);
} else {
// It's an action contributed to a type
var typeMenu = this.actionsMenu.getSubMenuItem(action.dataType);
typeMenu.removeSubMenuItem(actionName);
// FIXME: If all actions of a given type have been removed, remove the type menu item
}
},
/**
* Publishes a gadget's selection given the type.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @param {String} type - The type of the selection.
*/
publishSelection : function(type) {
var selection = osData.get(type);
if(selection) {
topic.publish("setSelection", selection);
}
},
/**
* Adds a menu item to the drop down menu.
*
* @memberof module:explorer/widgets/gadgetarea/GadgetDropDownMenu#
* @param {module:explorer/widgets/MenuItemWidget} menuItem - The menu item to add.
*/
addMenuItem : function(menuItem) {
domConstruct.place(menuItem.domNode, this.domNode, 'last');
}
});
});