libervia-backend: sat_frontends/tools/xmlui.py comparison

comparison sat_frontends/tools/xmlui.py @ 2668:c274201cea94

core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified

author	Goffi <goffi@goffi.org>
date	Fri, 31 Aug 2018 15:57:11 +0200
parents	56f94936df1e
children	bdb8276fd2da

comparison

equal deleted inserted replaced

-:8dd9db785ac8
+:c274201cea94
 class_map = {}
 CLASS_PANEL = "panel"
 CLASS_DIALOG = "dialog"
 CURRENT_LABEL = "current_label"
+HIDDEN = "hidden"
 class InvalidXMLUI(Exception):
 pass
 """Base class to construct SàT XML User Interface
 This class must not be instancied directly
 """
-def __init__(
+def __init__(self, host, parsed_dom, title=None, flags=None, callback=None,
-self,
+profile=C.PROF_KEY_NONE):
-host,
-parsed_dom,
-title=None,
-flags=None,
-callback=None,
-profile=C.PROF_KEY_NONE,
-):
 """Initialise the XMLUI instance
 @param host: %(doc_host)s
 @param parsed_dom: main parsed dom
 @param title: force the title, or use XMLUI one if None
 @param flags: list of string which can be:
 - NO_CANCEL: the UI can't be cancelled
-- FROM_BACKEND: the UI come from backend (i.e. it's not the direct result of user operation)
+- FROM_BACKEND: the UI come from backend (i.e. it's not the direct result of
+user operation)
 @param callback(callable, None): if not None, will be used with launchAction:
-- if None is used, default behaviour will be used (closing the dialog and calling host.actionManager)
+- if None is used, default behaviour will be used (closing the dialog and
+calling host.actionManager)
 - if a callback is provided, it will be used instead, so you'll have to manage
-dialog closing or new xmlui to display, or other action (you can call host.actionManager)
+dialog closing or new xmlui to display, or other action (you can call
+host.actionManager)
+The callback will have data, callback_id and profile as arguments
 """
 self.host = host
 top = parsed_dom.documentElement
 self.session_id = top.getAttribute("session_id") or None
 self.submit_id = top.getAttribute("submit") or None
 self.xmlui_title = title or top.getAttribute("title") or u""
+self.hidden = {}
 if flags is None:
 flags = []
 self.flags = flags
 self.callback = callback or self._defaultCb
 self.profile = profile
 self._xmluiClose()
 if self.submit_id is None:
 raise ValueError("Can't submit is self.submit_id is not set")
 if "session_id" in data:
 raise ValueError(
-"session_id must no be used in data, it is automaticaly filled with self.session_id if present"
+u"session_id must no be used in data, it is automaticaly filled with "
+u"self.session_id if present"
 )
 if self.session_id is not None:
 data["session_id"] = self.session_id
 self._xmluiLaunchAction(self.submit_id, data)
 @property dialog_factory: factory to create frontend-specific dialogs
 """
 widget_factory = None
-def __init__(
+def __init__(self, host, parsed_dom, title=None, flags=None, callback=None,
-self,
+ignore=None, whitelist=None, profile=C.PROF_KEY_NONE):
-host,
-parsed_dom,
-title=None,
-flags=None,
-callback=None,
-ignore=None,
-whitelist=None,
-profile=C.PROF_KEY_NONE,
-):
 """
 @param title(unicode, None): title of the
 @property widgets(dict): widget name => widget map
 @property widget_value(ValueGetter): retrieve widget value from it's name
 self._whitelist = whitelist
 else:
 self._whitelist = None
 self.constructUI(parsed_dom)
-def escape(self, name):
+@staticmethod
+def escape(name):
 """Return escaped name for forms"""
 return u"%s%s" % (C.SAT_FORM_PREFIX, name)
 @property
 def main_cont(self):
 def _parseChilds(self, _xmlui_parent, current_node, wanted=("container",), data=None):
 """Recursively parse childNodes of an element
 @param _xmlui_parent: widget container with '_xmluiAppend' method
 @param current_node: element from which childs will be parsed
-@param wanted: list of tag names that can be present in the childs to be SàT XMLUI compliant
+@param wanted: list of tag names that can be present in the childs to be SàT XMLUI
+compliant
 @param data(None, dict): additionnal data which are needed in some cases
 """
 for node in current_node.childNodes:
 if data is None:
 data = {}
 raise InvalidXMLUI("Unexpected node: [%s]" % node.nodeName)
 if node.nodeName == "container":
 type_ = node.getAttribute("type")
 if _xmlui_parent is self and type_ != "vertical":
-# main container is not a VerticalContainer and we want one, so we create one to wrap it
+# main container is not a VerticalContainer and we want one,
+# so we create one to wrap it
 _xmlui_parent = self.widget_factory.createVerticalContainer(self)
 self.main_cont = _xmlui_parent
 if type_ == "tabs":
 cont = self.widget_factory.createTabsContainer(_xmlui_parent)
 self._parseChilds(_xmlui_parent, node, ("tab",), {"tabs_cont": cont})
 elif type_ == "text":
 ctrl = self.widget_factory.createTextWidget(_xmlui_parent, value)
 elif type_ == "label":
 ctrl = self.widget_factory.createLabelWidget(_xmlui_parent, value)
 data[CURRENT_LABEL] = ctrl
+elif type_ == "hidden":
+if name in self.hidden:
+raise exceptions.ConflictError(u"Conflict on hidden value with "
+u"name {name}".format(name=name))
+self.hidden[name] = value
+continue
 elif type_ == "jid":
 ctrl = self.widget_factory.createJidWidget(_xmlui_parent, value)
 elif type_ == "divider":
 style = node.getAttribute("style") or "line"
 ctrl = self.widget_factory.createDividerWidget(_xmlui_parent, style)
 ctrl._xmluiOnChange(self.onParamChange)
 ctrl._param_category = self._current_category
 except (
 AttributeError,
 TypeError,
-):  # XXX: TypeError is here because pyjamas raise a TypeError instead of an AttributeError
+):  # XXX: TypeError is here because pyjamas raise a TypeError instead
+#      of an AttributeError
 if not isinstance(
 ctrl, (EmptyWidget, TextWidget, LabelWidget, JidWidget)
 ):
 log.warning(_("No change listener on [%s]") % ctrl)
 selected_values.append(
 (escaped, u"\t".join(ctrl["control"]._xmluiGetSelectedValues()))
 )
 else:
 selected_values.append((escaped, ctrl["control"]._xmluiGetValue()))
+data = dict(selected_values)
+for key, value in self.hidden.iteritems():
+data[self.escape(key)] = value
 if self.submit_id is not None:
-data = dict(selected_values)
 self.submit(data)
 else:
 log.warning(
 _("The form data is not sent back, the type is not managed properly")
 )

Mercurial > libervia-backend

comparison sat_frontends/tools/xmlui.py @ 2668:c274201cea94