# ------------------------------------------------------------------------------ # This file is part of Appy, a framework for building applications in the Python # language. Copyright (C) 2007 Gaetan Delannay # Appy is free software; you can redistribute it and/or modify it under the # terms of the GNU General Public License as published by the Free Software # Foundation; either version 3 of the License, or (at your option) any later # version. # Appy is distributed in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # You should have received a copy of the GNU General Public License along with # Appy. If not, see . # ------------------------------------------------------------------------------ from appy import Object from appy.px import Px # ------------------------------------------------------------------------------ class Phase: '''A group of pages.''' pxView = Px('''
::aPageInfo.page.getLabel(zobj)
''') # "Static" PX that displays all phases of a given object. pxAllPhases = Px(''' :phase.pxView
:_('%s_phase_%s' % (zobj.meta_type, \ phase.name))
:phase.pxView
''') def __init__(self, name, obj): self.name = name self.obj = obj # The list of names of pages in this phase self.pages = [] # The list of hidden pages in this phase self.hiddenPages = [] # The dict below stores info about every page listed in self.pages. self.pagesInfo = {} self.totalNbOfPhases = None # The following attributes allows to browse, from a given page, to the # last page of the previous phase and to the first page of the following # phase if allowed by phase state. self.previousPhase = None self.nextPhase = None def addPageLinks(self, field, obj): '''If p_field is a navigable Ref, we must add, within self.pagesInfo, objects linked to p_obj through this Ref as links.''' if field.page.name in self.hiddenPages: return infos = [] for ztied in field.getValue(obj, appy=False): infos.append(Object(title=ztied.title, url=ztied.absolute_url())) self.pagesInfo[field.page.name].links = infos def addPage(self, field, obj, layoutType): '''Adds page-related information in the phase.''' # If the page is already there, we have nothing more to do. if (field.page.name in self.pages) or \ (field.page.name in self.hiddenPages): return # Add the page only if it must be shown. showable = field.page.isShowable(obj) if showable: # The page must be added self.pages.append(field.page.name) # Create the dict about page information and add it in self.pageInfo pageInfo = Object(page=field.page, showOnView=bool(showable), showOnEdit=showable==True, links=None) pageInfo.update(field.page.getInfo(obj, layoutType)) self.pagesInfo[field.page.name] = pageInfo else: self.hiddenPages.append(field.page.name) def computeNextPrevious(self, allPhases): '''This method also fills fields "previousPhase" and "nextPhase" if relevant, based on list of p_allPhases.''' # Identify previous and next phases for phase in allPhases: if phase.name == self.name: i = allPhases.index(phase) if i > 0: self.previousPhase = allPhases[i-1] if i < (len(allPhases)-1): self.nextPhase = allPhases[i+1] def getPreviousPage(self, page): '''Returns the page that precedes p_page in this phase.''' try: pageIndex = self.pages.index(page) except ValueError: # The current page is probably not visible anymore. Return the # first available page in current phase. res = self.pages[0] return res, self.pagesInfo[res] if pageIndex > 0: # We stay on the same phase, previous page res = self.pages[pageIndex-1] return res, self.pagesInfo[res] else: if self.previousPhase: # We go to the last page of previous phase previousPhase = self.previousPhase res = previousPhase.pages[-1] return res, previousPhase.pagesInfo[res] else: return None, None def getNextPage(self, page): '''Returns the page that follows p_page in this phase.''' try: pageIndex = self.pages.index(page) except ValueError: # The current page is probably not visible anymore. Return the # first available page in current phase. res = self.pages[0] return res, self.pagesInfo[res] if pageIndex < (len(self.pages)-1): # We stay on the same phase, next page res = self.pages[pageIndex+1] return res, self.pagesInfo[res] else: if self.nextPhase: # We go to the first page of next phase nextPhase = self.nextPhase res = nextPhase.pages[0] return res, nextPhase.pagesInfo[res] else: return None, None # ------------------------------------------------------------------------------