libervia-web: src/browser/sat_browser/base

annotate src/browser/sat_browser/base_menu.py @ 502:4aa627b059df

browser_side: categories of the menus can be "flattened": - add the parameter "flat_level" to GenericMenuBar - the items of flattened sub-menus are displayed in the parent menu XXX: the implementation covers the current needs but is not fully completed: - the flattened categories of all levels are displayed the same way - items of flattened categories are appended to the parent menus instead of being inserted

author	souliane <souliane@mailoo.org>
date	Wed, 13 Aug 2014 15:06:40 +0200
parents	60be99de3808
children	1d41cc5b57b1

rev	line source
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	1 #!/usr/bin/python
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	3
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	4 # Libervia: a Salut à Toi frontend
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	5 # Copyright (C) 2011, 2012, 2013, 2014 Jérôme Poisson <goffi@goffi.org>
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	6
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	10 # (at your option) any later version.
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	11
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	16
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	19
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	20
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	21 """Base classes for building a menu.
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	22
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	23 These classes have been moved here from menu.py because they are also used
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	24 by base_widget.py, and the import sequence caused a JS runtime error."""
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	25
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	26
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	27 import pyjd # this is dummy in pyjs
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	28 from sat.core.log import getLogger
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	29 log = getLogger(__name__)
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	30
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	31 from pyjamas.ui.MenuBar import MenuBar
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	32 from pyjamas.ui.MenuItem import MenuItem
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	33 from pyjamas import Window
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	34
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	35
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	36 class MenuCmd:
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	37 """Return an object with an "execute" method that can be set to a menu item callback"""
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	38
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	39 def __init__(self, object_, handler):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	40 self._object = object_
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	41 self._handler = handler
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	42
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	43 def execute(self):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	44 handler = getattr(self._object, self._handler)
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	45 handler()
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	46
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	47
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	48 class PluginMenuCmd:
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	49 """Like MenuCmd, but instead of executing a method, it will command the bridge to launch an action"""
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	50
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	51 def __init__(self, host, action_id, menu_data=None):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	52 self.host = host
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	53 self.action_id = action_id
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	54 self.menu_data = menu_data
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	55
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	56 def execute(self):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	57 self.host.launchAction(self.action_id, self.menu_data)
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	58
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	59
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	60 class MenuNode(object):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	61 """MenuNode is a basic data structure to build a menu hierarchy.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	62 When Pyjamas MenuBar and MenuItem defines UI elements, MenuNode
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	63 stores the logical relation between them."""
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	64
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	65 """This class has been introduced to deal with "flattened menus", when you
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	66 want the items of a sub-menu to be displayed in the parent menu. It was
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	67 needed to break the naive relation of "one MenuBar = one category"."""
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	68
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	69 def __init__(self, name=None, item=None, menu=None, flat_level=0):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	70 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	71 @param name (str): node name
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	72 @param item (MenuItem): associated menu item
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	73 @param menu (GenericMenuBar): associated menu bar
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	74 @param flat_level (int): sub-menus until that level see their items
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	75 displayed in the parent menu bar, instead of in a callback popup.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	76 """
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	77 self.name = name
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	78 self.item = item or None # associated menu item
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	79 self.menu = menu or None # associated menu bar (sub-menu)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	80 self.flat_level = max(flat_level, -1)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	81 self.children = []
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	82
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	83 def _getOrCreateCategory(self, path, path_i18n=None, types=None, create=False):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	84 """Return the requested category. If create is True, path_i18n and
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	85 types are specified, recursively create the category and its parent.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	86
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	87 @param path (list[str]): path to the category
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	88 @param path_i18n (list[str]): internationalized path to the category
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	89 @param types (list[str]): types of the category and its parents
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	90 @param create (bool): if True, create the category
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	91 @return: MenuNode or None
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	92 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	93 assert(len(path) > 0 and len(path) == len(path_i18n) == len(types))
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	94 if isinstance(path, list) and len(path) > 1:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	95 cat = self._getOrCreateCategory(path[:1], path_i18n[:1], types[:1], create)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	96 return cat._getOrCreateCategory(path[1:], path_i18n[1:], types[1:], create) if cat else None
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	97 cats = [child for child in self.children if child.menu and child.name == path[0]]
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	98 if len(cats) == 1:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	99 return cats[0]
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	100 assert(cats == []) # there should not be more than 1 category with the same name
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	101 if create:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	102 html = self.menu.getCategoryHTML(path_i18n[0], types[0])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	103 sub_menu = GenericMenuBar(self.menu.host, vertical=True)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	104 return self.addItem(html, True, sub_menu, name=path[0])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	105 return None
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	106
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	107 def getCategories(self, target_path=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	108 """Return all the categories of the current node, or those of the
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	109 sub-category which is specified by target_path.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	110
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	111 @param target_path (list[str]): path to the target node
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	112 @return: list[MenuNode]
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	113 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	114 assert(self.menu) # this method applies to category nodes
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	115 if target_path:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	116 assert(isinstance(target_path, list))
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	117 cat = self._getOrCreateCategory(target_path[:-1])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	118 return cat.getCategories(target_path[-1:]) if cat else None
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	119 return [child for child in self.children if child.menu]
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	120
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	121 def addMenuItem(self, path, path_i18n, types, callback=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	122 """Recursively add a new node, which could be a category or a leaf node.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	123
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	124 @param path (list[str], str): path to the item
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	125 @param path_i18n (list[str], str): internationalized path to the item
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	126 @param types (list[str], str): types of the item and its parents
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	127 @param menu_cmd (MenuCmd, PluginMenuCmd or GenericMenuBar): instance to
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	128 execute as a leaf's callback or to popup as a category's sub-menu.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	129 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	130 log.info("addMenuItem: %s %s %s %s" % (path, path_i18n, types, callback))
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	131
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	132 leaf_node = hasattr(callback, "execute")
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	133 category = hasattr(callback, "onShow")
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	134 assert(not leaf_node or not category)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	135
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	136 path = [path] if isinstance(path, str) else path
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	137 path_i18n = [path_i18n] if isinstance(path_i18n, str) else path_i18n
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	138 types = [types for dummy in range(len(path_i18n))] if isinstance(types, str) else types
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	139
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	140 if category:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	141 cat = self._getOrCreateCategory(path, path_i18n, types, True)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	142 cat.item.setSubMenu(callback)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	143 return cat
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	144
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	145 if len(path) == len(path_i18n) - 1:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	146 path.append(None) # dummy name for a leaf node
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	147
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	148 parent = self._getOrCreateCategory(path[:-1], path_i18n[:-1], types[:-1], True)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	149 return parent.addItem(path_i18n[-1], callback)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	150
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	151 def addItem(self, item, asHTML=None, popup=None, name=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	152 """Add a single child to the current node.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	153
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	154 @param item: see MenuBar.addItem
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	155 @param asHTML: see MenuBar.addItem
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	156 @param popup: see MenuBar.addItem
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	157 @param name (str): the item node's name
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	158 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	159 if item is None: # empty string is allowed to set a separator
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	160 return None
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	161 item = MenuBar.addItem(self.menu, item, asHTML, popup)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	162 node_menu = item.getSubMenu() # node eventually uses it's own menu
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	163
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	164 # XXX: all the dealing with flattened menus is done here
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	165 if self.flat_level > 0:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	166 item.setSubMenu(None) # eventually remove any sub-menu callback
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	167 if item.getCommand():
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	168 node_menu = None # node isn't a category, it needs no menu
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	169 else:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	170 node_menu = self.menu # node uses the menu of its parent
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	171 item.setStyleName(self.menu.styles["flattened-category"])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	172
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	173 node = MenuNode(name=name, item=item, menu=node_menu, flat_level=self.flat_level - 1)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	174 self.children.append(node)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	175 return node
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	176
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	177 def addCachedMenus(self, type_, menu_data=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	178 """Add cached menus to instance.
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	179
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	180 @param type_: menu type like in sat.core.sat_main.importMenu
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	181 @param menu_data: data to send with these menus
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	182 """
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	183 menus = self.menu.host.menus.get(type_, [])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	184 for action_id, path, path_i18n in menus:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	185 if len(path) != len(path_i18n):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	186 log.error("inconsistency between menu paths")
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	187 continue
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	188 callback = PluginMenuCmd(self.menu.host, action_id, menu_data)
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	189 self.addMenuItem(path, path_i18n, 'plugins', callback)
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	190
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	191
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	192 class GenericMenuBar(MenuBar):
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	193 """A menu bar with sub-categories and items"""
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	194
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	195 def __init__(self, host, vertical=False, styles=None, flat_level=0, **kwargs):
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	196 """
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	197 @param host (SatWebFrontend): host instance
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	198 @param vertical (bool): True to display the popup menu vertically
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	199 @param styles (dict): specific styles to be applied:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	200 - key: a value in ('moved_popup', 'menu_bar')
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	201 - value: a CSS class name
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	202 @param flat_level (int): sub-menus until that level see their items
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	203 displayed in the parent menu bar instead of in a callback popup.
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	204 """
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	205 MenuBar.__init__(self, vertical, **kwargs)
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	206 self.host = host
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	207 self.styles = {'separator': 'menuSeparator', 'flattened-category': 'menuFlattenedCategory'}
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	208 if styles:
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	209 self.styles.update(styles)
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	210 if 'menu_bar' in self.styles:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	211 # XXX: pyjamas set the style to object string representation!
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	212 # FIXME: fix the bug upstream
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	213 first = 'gwt-MenuBar'
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	214 second = first + '-' + ('vertical' if self.vertical else 'horizontal')
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	215 self.setStyleName(' '.join([first, second, self.styles['menu_bar']]))
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	216 self.node = MenuNode(menu=self, flat_level=flat_level)
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	217
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	218 @classmethod
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	219 def getCategoryHTML(cls, menu_name_i18n, type_):
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	220 """Build the html to be used for displaying a category item.
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	221
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	222 Inheriting classes may overwrite this method.
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	223 @param menu_name_i18n (str): internationalized category name
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	224 @param type_ (str): category type
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	225 @return: str
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	226 """
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	227 return menu_name_i18n
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	228
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	229 def doItemAction(self, item, fireCommand):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	230 """Overwrites the default behavior for the popup menu to fit in the screen"""
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	231 MenuBar.doItemAction(self, item, fireCommand)
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	232 if not self.popup:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	233 return
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	234 if self.vertical:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	235 # move the popup if it would go over the screen's viewport
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	236 max_left = Window.getClientWidth() - self.getOffsetWidth() + 1 - self.popup.getOffsetWidth()
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	237 new_left = self.getAbsoluteLeft() - self.popup.getOffsetWidth() + 1
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	238 top = item.getAbsoluteTop()
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	239 else:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	240 # move the popup if it would go over the menu bar right extremity
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	241 max_left = self.getAbsoluteLeft() + self.getOffsetWidth() - self.popup.getOffsetWidth()
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	242 new_left = max_left
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	243 top = self.getAbsoluteTop() + self.getOffsetHeight() - 1
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	244 if item.getAbsoluteLeft() > max_left:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	245 self.popup.setPopupPosition(new_left, top)
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	246 # eventually smooth the popup edges to fit the menu own style
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	247 if 'moved_popup' in self.styles:
60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	248 self.popup.addStyleName(self.styles['moved_popup'])
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	249
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	250 def getCategories(self, parent_path=None):
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	251 """Return all the categories items.
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	252
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	253 @return: list[CategoryItem]
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	254 """
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	255 return [cat.item for cat in self.node.getCategories(parent_path)]
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	256
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	257 def addMenuItem(self, path, path_i18n, types, menu_cmd):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	258 self.node.addMenuItem(path, path_i18n, types, menu_cmd)
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	259
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	260 def addItem(self, item, asHTML=None, popup=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	261 return self.node.addItem(item, asHTML, popup).item
498 60be99de3808 browser_side: menus refactorization + handle levels > 2 souliane <souliane@mailoo.org> parents: 494 diff changeset	262
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	263 def addCachedMenus(self, type_, menu_data=None):
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	264 self.node.addCachedMenus(type_, menu_data)
494 5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	265
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	266 def addSeparator(self):
5d8632a7bfde browser_side: refactorisation of menus and LiberviaWidget's header souliane <souliane@mailoo.org> parents: diff changeset	267 """Add a separator between the categories"""
502 4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	268 item = MenuItem(text='', asHTML=None, StyleName=self.styles['separator'])
4aa627b059df browser_side: categories of the menus can be "flattened": souliane <souliane@mailoo.org> parents: 498 diff changeset	269 return self.addItem(item)

Mercurial > libervia-web

annotate src/browser/sat_browser/base_menu.py @ 502:4aa627b059df