From 084f1f9a232b9a9f5ae3ad9b4bc2adc9edaca67b Mon Sep 17 00:00:00 2001 From: Gaetan Delannay Date: Tue, 1 Apr 2014 18:34:12 +0200 Subject: [PATCH] [gen] Ref field: param 'link' can now be 'list' (ongoing work). --- fields/ref.py | 497 ++++++++++++++++++++---------------- gen/mixins/__init__.py | 14 +- gen/tr/Appy.pot | 12 + gen/tr/ar.po | 12 + gen/tr/de.po | 12 + gen/tr/en.po | 12 + gen/tr/es.po | 12 + gen/tr/fr.po | 12 + gen/tr/it.po | 12 + gen/tr/nl.po | 12 + gen/ui/appy.js | 8 + gen/ui/link.png | Bin 0 -> 234 bytes gen/wrappers/ToolWrapper.py | 7 + 13 files changed, 400 insertions(+), 222 deletions(-) create mode 100644 gen/ui/link.png diff --git a/fields/ref.py b/fields/ref.py index 7b72853..69fa1e9 100644 --- a/fields/ref.py +++ b/fields/ref.py @@ -39,17 +39,17 @@ class Ref(Field): # ui/view. pxObjectTitle = Px(''' - ::ztied.getSupTitle(navInfo) + cssClass=tied.o.getCssFor('title')"> + ::tied.o.getSupTitle(navInfo) :(not includeShownInfo) and \ - ztied.Title() or field.getReferenceLabel(ztied.appy()) + tied.title or field.getReferenceLabel(tied) ::ztied.getSubTitle() + 'display:none'">::tied.o.getSubTitle() ''') # This PX displays icons for triggering actions on a given referenced object @@ -58,11 +58,12 @@ class Ref(Field): - - + - - - + +
+ q(tied.o.id), q('move'), q('**v**')))"> @@ -71,25 +72,31 @@ class Ref(Field): onclick=":ajaxBaseCall.replace('**v**', 'down')"/> :targetObj.appy().pxTransitions:tied.pxTransitions + + field.pageName, loop.tied.nb+startNumber, totalNumber)" + href=":tied.o.getUrl(mode='edit', page='main', nav=navInfo)"> + + onclick=":'onDeleteObject(%s)' % q(tied.o.id)"/> + + onclick=":'onUnlinkObject(%s,%s,%s)' % (q(zobj.id), \ + q(field.name), q(tied.o.id))"/> + +
''') @@ -97,7 +104,7 @@ class Ref(Field): # Displays the button allowing to add a new object through a Ref field, if # it has been declared as addable and if multiplicities allow it. pxAdd = Px(''' - - - - - :_('no_ref') - :field.pxAdd - - - - :field.pxObjectTitle - - - - - - -
- (:totalNumber) - :field.pxAdd - - -
- - - :tool.pxNavigate - - -

:_('no_ref')

- - - - + pxViewList = Px(''' +
+ +
- - - - - - - - -
- :_(refField.labelId) - :field.pxSortIcons - :tool.pxShowDetails -
- - - :field.pxObjectTitle -
:field.pxObjectActions
- - - - :field.pxRender - -
-
+ + + + + + + + + +
:_('no_ref'):field.pxAdd:field.pxObjectTitle
- - :tool.pxNavigate - ''') + + +
+ :_(subLabel) + (:totalNumber) + :field.pxAdd + + +
+ + + :tool.pxNavigate + + +

:_('no_ref')

+ + + + + +
+ + + + + + + + +
+ :_(refField.labelId) + :field.pxSortIcons + :tool.pxShowDetails +
+ + + :field.pxObjectTitle +
:field.pxObjectActions
+ + + + :field.pxRender + +
+
+ + + :tool.pxNavigate + ''') + + # PX that displays the list of objects the user may select to insert into a + # ref field with link="list". + pxViewPickList = Px(''' + :field.pxViewList''') # PX that displays referred objects as menus. pxViewMenus = Px(''' -
+ - + :menu.text 1 -
:menu.text - :len(menu.zobjects) + :len(menu.objects) @@ -246,46 +271,47 @@ class Ref(Field): # PX that displays referred objects through this field. pxView = Px(''' -
+ - - :field.pxViewList + :field.pxViewPickList + :field.pxViewList :field.pxViewMenus -
''') + ''') # The "menus" render mode is only applicable in "cell", not in "view". pxCell = Px(''':field.pxView''') pxEdit = Px(''' @@ -350,7 +376,13 @@ class Ref(Field): # the object will be created automatically, and no creation form will # be presented to the user. self.noForm = noForm - # May the user link existing objects through this ref? + # May the user link existing objects through this ref? If "link" is; + # True, the user will, on the edit page, choose objects from a + # dropdown menu; + # "list", the user will, on the view page, choose objects from a list + # of objects which is similar to those rendered in pxViewList; + # "popup", the user will, on the edit page, choose objects from a popup + # menu. self.link = link # May the user unlink existing objects? self.unlink = unlink @@ -444,7 +476,7 @@ class Ref(Field): height, None, colspan, master, masterValue, focus, historized, mapping, label, sdefault, scolspan, swidth, sheight, persist) - self.validable = self.link + self.validable = bool(self.link) def getDefaultLayouts(self): return {'view': Table('l-f', width='100%'), 'edit': 'lrv-f'} @@ -454,22 +486,21 @@ class Ref(Field): if not res: return res # We add here specific Ref rules for preventing to show the field under # some inappropriate circumstances. - if (layoutType == 'edit') and \ - (self.mayAdd(obj) or not self.link): return False + if layoutType == 'edit': + if self.mayAdd(obj): return False + if self.link in (False, 'list'): return False if self.isBack: if layoutType == 'edit': return False else: return getattr(obj.aq_base, self.name, None) return res - def getValue(self, obj, type='objects', noListIfSingleObj=False, + def getValue(self, obj, appy=True, noListIfSingleObj=False, startNumber=None, someObjects=False): - '''Returns the objects linked to p_obj through this Ref field. - - If p_type is "objects", it returns the Appy wrappers; - - If p_type is "zobjects", it returns the Zope objects; - - If p_type is "uids", it returns UIDs of objects (= strings). + '''Returns the objects linked to p_obj through this Ref field. It + returns Appy wrappers if p_appy is True, the Zope objects else. - * If p_startNumber is None, it returns all referred objects. - * If p_startNumber is a number, it returns self.maxPerPage objects, + * If p_startNumber is None, it returns all referred objects; + * if p_startNumber is a number, it returns self.maxPerPage objects, starting at p_startNumber. If p_noListIfSingleObj is True, it returns the single reference as @@ -482,12 +513,10 @@ class Ref(Field): # Maybe is there a default value? defValue = Field.getValue(self, obj) if defValue: - # I must prefix call to function "type" with "__builtins__" - # because this name was overridden by a method parameter. - if __builtins__['type'](defValue) in sutils.sequenceTypes: - uids = [o.o.UID() for o in defValue] + if type(defValue) in sutils.sequenceTypes: + uids = [o.o.id for o in defValue] else: - uids = [defValue.o.UID()] + uids = [defValue.o.id] # Prepare the result: an instance of SomeObjects, that will be unwrapped # if not required. res = gutils.SomeObjects() @@ -502,13 +531,9 @@ class Ref(Field): while i < (res.startNumber + res.batchSize): if i >= res.totalNumber: break # Retrieve every reference in the correct format according to p_type - if type == 'uids': - ref = uids[i] - else: - ref = obj.getTool().getObject(uids[i]) - if type == 'objects': - ref = ref.appy() - res.objects.append(ref) + tied = obj.getTool().getObject(uids[i]) + if appy: tied = tied.appy() + res.objects.append(tied) i += 1 # Manage parameter p_noListIfSingleObj if res.objects and noListIfSingleObj: @@ -517,32 +542,96 @@ class Ref(Field): if someObjects: return res return res.objects - def getLinkedObjects(self, obj, startNumber=None): - '''Gets the objects linked to p_obj via this Ref field. If p_startNumber - is None, all linked objects are returned. If p_startNumber is a - number, self.maxPerPage objects will be returned, starting at - p_startNumber.''' - return self.getValue(obj, type='zobjects', someObjects=True, - startNumber=startNumber) + def getPossibleValues(self, obj, startNumber=None, someObjects=False, + removeLinked=False): + '''This method returns the list of all objects that can be selected + to be linked as references to p_obj via p_self. It is applicable only + for Ref fields with link!=False. If master values are present in the + request, we use field.masterValues method instead of self.select. - def getLinkedObjectsByMenu(self, obj, zobjects): - '''This method groups p_zobjects into sub-lists of objects, grouped by + If p_startNumber is a number, it returns self.maxPerPage objects, + starting at p_startNumber. If p_someObjects is True, it returns an + instance of SomeObjects instead of returning a list of objects. + + If p_removeLinked is True, we remove, from the result, objects which + are already linked. For example, for Ref fields rendered as a + dropdown menu or a multi-selection box (with link=True), on the edit + page, we need to display all possible values: those that are already + linked appear to be selected in the widget. But for Ref fields + rendered as pick lists (link="list"), once an object is linked, it + must disappear from the "pick list". + ''' + req = obj.REQUEST + obj = obj.appy() + if 'masterValues' in req: + # Convert masterValue(s) from id(s) to real object(s). + masterValues = req['masterValues'].strip() + if not masterValues: masterValues = None + else: + masterValues = masterValues.split('*') + tool = obj.tool + if len(masterValues) == 1: + masterValues = tool.getObject(masterValues[0]) + else: + masterValues = [tool.getObject(v) for v in masterValues] + objects = self.masterValue(obj, masterValues) + else: + # If this field is an ajax-updatable slave, no need to compute + # possible values: it will be overridden by method self.masterValue + # by a subsequent ajax request (=the "if" statement above). + if self.masterValue and callable(self.masterValue): + objects = [] + else: + if not self.select: + # No select method has been defined: we must retrieve all + # objects of the referred type that the user is allowed to + # access. + objects = obj.search(self.klass) + else: + objects = self.select(obj) + # Remove already linked objects if required. + if removeLinked: + uids = getattr(obj.o.aq_base, self.name, None) + if uids: + # Browse objects in reverse order and remove linked objects. + i = len(objects) - 1 + while i >= 0: + if objects[i].uid in uids: del objects[i] + i -= 1 + # Restrict, if required, the result to self.maxPerPage starting at + # p_startNumber. Unlike m_getValue, we already have all objects in + # "objects": we can't limit objects "waking up" to at most + # self.maxPerPage. + total = len(objects) + if startNumber != None: + objects = objects[startNumber:startNumber + self.maxPerPage] + # Return the result, wrapped in a SomeObjects instance if required. + if not someObjects: return objects + res = gutils.SomeObjects() + res.totalNumber = total + res.batchSize = self.maxPerPage + res.startNumber = startNumber + res.objects = objects + return res + + def getLinkedObjectsByMenu(self, obj, objects): + '''This method groups p_objects into sub-lists of objects, grouped by menu (happens when self.render == 'menus').''' res = [] # We store in "menuIds" the already encountered menus: # ~{s_menuId : i_indexInRes}~ menuIds = {} - # Browse every object from p_zobjects and put them in their menu + # Browse every object from p_objects and put them in their menu # (within "res"). - for zobj in zobjects: - menuId = self.menuIdMethod(obj, zobj.appy()) + for tied in objects: + menuId = self.menuIdMethod(obj, tied) if menuId in menuIds: # We have already encountered this menu. menuIndex = menuIds[menuId] - res[menuIndex].zobjects.append(zobj) + res[menuIndex].objects.append(tied) else: # A new menu. - menu = Object(id=menuId, zobjects=[zobj]) + menu = Object(id=menuId, objects=[tied]) res.append(menu) menuIds[menuId] = len(res) - 1 # Complete information about every menu by calling self.menuInfoMethod @@ -552,16 +641,16 @@ class Ref(Field): menu.icon = icon return res - def getMenuUrl(self, zobj, ztied): - '''We must provide the URL of the tied object p_ztied, when shown in a - Ref field in render mode 'menus'. If self.menuUrlMethod is specified, + def getMenuUrl(self, zobj, tied): + '''We must provide the URL of the p_tied object, when shown in a Ref + field in render mode 'menus'. If self.menuUrlMethod is specified, use it. Else, returns the "normal" URL of the view page for the tied object, but without any navigation information, because in this render mode, tied object's order is lost and navigation is impossible.''' if self.menuUrlMethod: - return self.menuUrlMethod(zobj.appy(), ztied.appy()) - return ztied.getUrl(nav='') + return self.menuUrlMethod(zobj.appy(), tied) + return tied.o.getUrl(nav='') def getStartNumber(self, render, req, ajaxHookId): '''This method returns the index of the first linked object that must be @@ -594,17 +683,16 @@ class Ref(Field): return res else: # For the global search: return linked objects' titles. - res = [o.title for o in self.getValue(type='objects')] + res = [o.title for o in self.getValue()] if not res: res.append('') return res def validateValue(self, obj, value): - if not self.link: return None + if not self.link: return # We only check "link" Refs because in edit views, "add" Refs are # not visible. So if we check "add" Refs, on an "edit" view we will # believe that that there is no referred object even if there is. - # If the field is a reference, we must ensure itself that multiplicities - # are enforced. + # Also ensure that multiplicities are enforced. if not value: nbOfRefs = 0 elif isinstance(value, basestring): @@ -634,7 +722,7 @@ class Ref(Field): refs = obj.getProductConfig().PersistentList() setattr(obj, self.name, refs) # Insert p_value into it. - uid = value.o.UID() + uid = value.o.id if uid not in refs: # Where must we insert the object? At the start? At the end? if callable(self.add): @@ -752,39 +840,6 @@ class Ref(Field): newIndex = oldIndex + move uids.insert(newIndex, uid) - def getPossibleValues(self, obj): - '''This method returns the list of all objects that can be selected - to be linked as references to p_obj via p_self. It is applicable only - for ref fields with link=True. If master values are present in the - request, we use field.masterValues method instead of self.select. - ''' - req = obj.request - if 'masterValues' in req: - # Convert masterValue(s) from UID(s) to real object(s). - masterValues = req['masterValues'].strip() - if not masterValues: masterValues = None - else: - masterValues = masterValues.split('*') - tool = obj.tool - if len(masterValues) == 1: - masterValues = tool.getObject(masterValues[0]) - else: - masterValues = [tool.getObject(v) for v in masterValues] - res = self.masterValue(obj, masterValues) - return res - else: - # If this field is an ajax-updatable slave, no need to compute - # possible values: it will be overridden by method self.masterValue - # by a subsequent ajax request (=the "if" statement above). - if self.masterValue and callable(self.masterValue): return [] - if not self.select: - # No select method has been defined: we must retrieve all - # objects of the referred type that the user is allowed to - # access. - return obj.search(self.klass) - else: - return self.select(obj) - xhtmlToText = re.compile('<.*?>', re.S) def getReferenceLabel(self, refObject, unlimited=False): '''p_self must have link=True. I need to display, on an edit view, the @@ -813,7 +868,7 @@ class Ref(Field): '''Gets the position of p_refObj within this field on p_obj.''' uids = getattr(obj.aq_base, self.name, None) if not uids: raise IndexError() - return uids.index(refObj.UID()) + return uids.index(refObj.o.id) def sort(self, obj): '''Called when the user wants to sort the content of this field.''' diff --git a/gen/mixins/__init__.py b/gen/mixins/__init__.py index eca2424..da8fd2a 100644 --- a/gen/mixins/__init__.py +++ b/gen/mixins/__init__.py @@ -191,6 +191,18 @@ class BaseMixin: self.say(self.translate('action_done')) self.goto(urlBack) + def onLink(self): + '''Called when an object linking is triggered from the ui.''' + rq = self.REQUEST + tool = self.getTool() + sourceObject = tool.getObject(rq['sourceUid']) + targetObject = tool.getObject(rq['targetUid']) + field = sourceObject.getAppyType(rq['fieldName']) + field.linkObject(sourceObject, targetObject) + urlBack = self.getUrl(rq['HTTP_REFERER']) + self.say(self.translate('action_done')) + self.goto(urlBack) + def onCreate(self): '''This method is called when a user wants to create a root object in the "data" folder or an object through a reference field. A temporary @@ -1263,7 +1275,7 @@ class BaseMixin: # -------------------------------------------------------------------------- def UID(self): '''Returns the unique identifier for this object.''' - return self._at_uid + return self.id def Title(self): '''Returns the title for this object.''' diff --git a/gen/tr/Appy.pot b/gen/tr/Appy.pot index 76ae616..4e93e22 100644 --- a/gen/tr/Appy.pot +++ b/gen/tr/Appy.pot @@ -83,6 +83,14 @@ msgstr "" msgid "add_ref" msgstr "" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "" @@ -187,6 +195,10 @@ msgstr "" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/tr/ar.po b/gen/tr/ar.po index 433ae10..59190b8 100644 --- a/gen/tr/ar.po +++ b/gen/tr/ar.po @@ -83,6 +83,14 @@ msgstr "" msgid "add_ref" msgstr "" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "" @@ -187,6 +195,10 @@ msgstr "" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/tr/de.po b/gen/tr/de.po index 22feaf5..677a7bd 100644 --- a/gen/tr/de.po +++ b/gen/tr/de.po @@ -83,6 +83,14 @@ msgstr "Kein Element" msgid "add_ref" msgstr "Hinzufügen" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "Der Auftrag wird ausgeführt." @@ -187,6 +195,10 @@ msgstr "Löschen" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/tr/en.po b/gen/tr/en.po index a4b9a3b..38fdd1b 100644 --- a/gen/tr/en.po +++ b/gen/tr/en.po @@ -84,6 +84,14 @@ msgstr "No object." msgid "add_ref" msgstr "Add a new one" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "Selectable elements" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "Selected elements" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "The action has been successfully executed." @@ -188,6 +196,10 @@ msgstr "Delete" msgid "object_unlink" msgstr "Unlink" +#. Default: "Insert" +msgid "object_link" +msgstr "Insert" + #. Default: "Unlock" msgid "page_unlock" msgstr "Unlock" diff --git a/gen/tr/es.po b/gen/tr/es.po index 11c3f1f..4438e1d 100644 --- a/gen/tr/es.po +++ b/gen/tr/es.po @@ -83,6 +83,14 @@ msgstr "Ningún elemento." msgid "add_ref" msgstr "Añadir" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "La acción ha sido efectuada." @@ -187,6 +195,10 @@ msgstr "Eliminar" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/tr/fr.po b/gen/tr/fr.po index 6085e6d..bd2c78a 100644 --- a/gen/tr/fr.po +++ b/gen/tr/fr.po @@ -84,6 +84,14 @@ msgstr "Aucun élément." msgid "add_ref" msgstr "Ajouter" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "Éléments sélectionnables" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "Éléments sélectionnés" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "L'action a été effectuée." @@ -188,6 +196,10 @@ msgstr "Supprimer" msgid "object_unlink" msgstr "Dissocier" +#. Default: "Insert" +msgid "object_link" +msgstr "Insérer" + #. Default: "Unlock" msgid "page_unlock" msgstr "Déverrouiller" diff --git a/gen/tr/it.po b/gen/tr/it.po index 535f2f3..924bdfb 100644 --- a/gen/tr/it.po +++ b/gen/tr/it.po @@ -83,6 +83,14 @@ msgstr "Nessun elemento" msgid "add_ref" msgstr "Aggiungi un nuovo" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "L'operazione è stata eseguita con successo" @@ -187,6 +195,10 @@ msgstr "Elimina" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/tr/nl.po b/gen/tr/nl.po index 793537c..5b593a7 100644 --- a/gen/tr/nl.po +++ b/gen/tr/nl.po @@ -83,6 +83,14 @@ msgstr "Geen element." msgid "add_ref" msgstr "Toevoegen" +#. Default: "Selectable elements" +msgid "selectable_objects" +msgstr "" + +#. Default: "Selected elements" +msgid "selected_objects" +msgstr "" + #. Default: "The action has been successfully executed." msgid "action_ok" msgstr "De opdracht werd uitgevoerd." @@ -187,6 +195,10 @@ msgstr "Verwijderen" msgid "object_unlink" msgstr "" +#. Default: "Insert" +msgid "object_link" +msgstr "" + #. Default: "Unlock" msgid "page_unlock" msgstr "" diff --git a/gen/ui/appy.js b/gen/ui/appy.js index 657a105..c179699 100644 --- a/gen/ui/appy.js +++ b/gen/ui/appy.js @@ -464,6 +464,14 @@ function onUnlinkObject(sourceUid, fieldName, targetUid) { askConfirm('form', 'unlinkForm', action_confirm); } +function onLinkObject(sourceUid, fieldName, targetUid) { + f = document.getElementById('linkForm'); + f.sourceUid.value = sourceUid; + f.fieldName.value = fieldName; + f.targetUid.value = targetUid; + f.submit(); +} + function onUnlockPage(objectUid, pageName) { f = document.getElementById('unlockForm'); f.objectUid.value = objectUid; diff --git a/gen/ui/link.png b/gen/ui/link.png new file mode 100644 index 0000000000000000000000000000000000000000..fbfa95bae3bffb20ef6ee77a46772b0dab61db9c GIT binary patch literal 234 zcmeAS@N?(olHy`uVBq!ia0vp@KrFz-3?w(4m0bm-7>k44ofy`glX(f`a0d8{Km9#B5&Gs Ppn3*RS3j3^P6 + +
+ + + + +