; 0sDc@sdZdZdkZdklZdklZdklZdk l Z dk l Z dk lZlZd eZd eZed d d dddddde ddeeZed ddeddde dd eeZed ddeddde ddeeZed ddeddde ddeeZed ddeddde ddeeZedddfddfd fgZd!e fd"YZd#e fd$YZd%e fd&YZdS('s This module defines a single TableOfContents() class that can be used to create automatically a table of tontents for Platypus documents like this: story = [] toc = TableOfContents() story.append(toc) # some heading paragraphs here... doc = MyTemplate(path) doc.multiBuild(story) The data needed to create the table is a list of (level, text, pageNum) triplets, plus some paragraph styles for each level of the table itself. The triplets will usually be created in a document template's method like afterFlowable(), making notification calls using the notify() method with appropriate data like this: (level, text, pageNum) = ... self.notify('TOCEntry', (level, text, pageNum)) As the table of contents need at least two passes over the Platypus story which is why the moultiBuild0() method must be called. The levelParaStyle variables are the paragraph styles used to format the entries in the table of contents. Their indentation is calculated like this: each entry starts at a multiple of some constant named delta. If one entry spans more than one line, all lines after the first are indented by the same constant named epsilon. s> $Id: tableofcontents.py 2385 2004-06-17 15:26:05Z rgbecker $ N(senums(scm(sParagraphStyle(s Paragraph(sIndexingFlowable(s TableStylesTableif0.5snames LevelZerosfontNames Times-RomansfontSizei sleadingi sfirstLineIndents leftIndentisLevelOnesparentsLevelTwois LevelThreeis LevelFourisVALIGNisTOPsTableOfContentscBsttZdZdZdZdZdZdZdZdZ dZ d Z d Z d d Z RS( sThis creates a formatted table of contents. It presumes a correct block of data is passed in. The data block contains a list of (level, text, pageNumber) triplets. You can supply a paragraph style for each level (starting at zero). cCsRg|_d|_tttttg|_t |_ t |_ g|_ g|_dS(NiH(sselfsentriessrightColumnWidthslevelZeroParaStyleslevelOneParaStyleslevelTwoParaStyleslevelThreeParaStyleslevelFourParaStyles levelStylessdefaultTableStyles tableStylesNones_tables_entriess _lastEntries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys__init__gs     cCs|i|_|idS(N(sselfs_entriess _lastEntriess clearEntries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys beforeBuildus cCsdSdS(Ni((sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys isIndexing{scCs|i|ijSdS(N(sselfs_entriess _lastEntries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys isSatisfiedscCs7|djo&|\}}}|i|||ndS(sThe notification hook called to register all kinds of events. Here we are interested in 'TOCEntry' events only. sTOCEntryN(skindsstuffslevelstextspageNumsselfsaddEntry(sselfskindsstuffspageNumslevelstext((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysnotifys cCs g|_dS(N(sselfs_entries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys clearEntriesscCsdt|tdjp td|t|ijptd||ii|||fdS(sAdds one entry to the table of contents. This allows incremental buildup by a doctemplate. Requires that enough styles are defined.isLevel must be an integersZTable of contents must have a style defined for paragraph level %d before you add an entryN( stypeslevelsAssertionErrorslensselfs levelStyless_entriessappendstextspageNum(sselfslevelstextspageNum((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysaddEntrys#$cCs1x*|D]"\}}}|i|||qWdS(sBulk creation of entries in the table of contents. If you knew the titles but not the page numbers, you could supply them to get sensible output on the first run.N(s listOfEntriesslevelstextspageNumsselfsaddEntry(sselfs listOfEntriesstextspageNumslevel((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys addEntriessc Cs0||i|if}t|idjodddfg} n |i} g} x| D]{\}} }|i |} t dd|d| dddti}t| | }tt||}| i||gqXWt| d|d |i|_|ii|i||\|_|_|i|ifSd S( s,All table properties should be known by now.is!Placeholder for table of contentssnamesleftColLevel%dsparents leftIndents alignments colWidthssstyleN(s availWidthsselfsrightColumnWidthswidthsslens _lastEntriess _tempEntriess tableDataslevelstextspageNums levelStyless leftColStylesParagraphStylesenumssTA_RIGHTs rightColStyles ParagraphsleftParasstrs rightParasappendsTables tableStyles_tableswrapOnscanvs availHeightswidthsheight( sselfs availWidths availHeights rightColStylespageNumslevelswidthssleftParas rightParas leftColStylestexts _tempEntriess tableData((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pyswraps(    'cCs|ii|i||SdS(sAt this stage we do not care about splitting the entries, we will just return a list of platypus tables. Presumably the calling app has a pointer to the original TableOfContents object; Platypus just sees tables. N(sselfs_tablessplitOnscanvs availWidths availHeight(sselfs availWidths availHeight((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pyssplitsicCs|ii||||dS(sDon't do this at home! The standard calls for implementing draw(); we are hooking this in order to delegate ALL the drawing work to the embedded table object. N(sselfs_tablesdrawOnscanvassxsys_sW(sselfscanvassxsys_sW((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysdrawOns(s__name__s __module__s__doc__s__init__s beforeBuilds isIndexings isSatisfiedsnotifys clearEntriessaddEntrys addEntriesswrapssplitsdrawOn(((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysTableOfContents^s        " s SimpleIndexcBsktZdZdZdZdZdZdZdZdZ dZ d Z d d Z RS( sThis creates a very simple index. Entries have a string key, and appear with a page number on the right. Prototype for more sophisticated multi-level index.cCs=h|_h|_t|_tdddddd|_dS(NsnamesindexsfontNames Times-RomansfontSizei (sselfs_entriess _lastEntriessNones_tablesParagraphStyles textStyle(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys__init__s     cCsdSdS(Ni((sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys isIndexingscCs|i|ijSdS(N(sselfs_entriess _lastEntries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys isSatisfiedscCs |ii|_|idS(N(sselfs_entriesscopys _lastEntriess clearEntries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys beforeBuildscCs h|_dS(N(sselfs_entries(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys clearEntriesscCs1|djo |\}}|i||ndS(sThe notification hook called to register all kinds of events. Here we are interested in 'IndexEntry' events only. s IndexEntryN(skindsstuffstextspageNumsselfsaddEntry(sselfskindsstuffstextspageNum((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysnotifys  cCsE|ii|o|i|it|n|g|i|tZdZdZdZdZdZddZRS(sVFakery to illustrate how a reference would work if we could put it in a paragraph.cCs@||_||_td|_t|_d|_t|_ dS(Nstmpi( s textPatternsselfs targetKeystargetsParagraphStyles paraStylesNones _lastPageNums_pageNums_para(sselfs textPatterns targetKey((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys__init__0s     cCs|i|_dS(N(sselfs_pageNums _lastPageNum(sself((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys beforeBuild8scCs>|djo-|\}}||ijo ||_q:ndS(NsTarget(skindsstuffskeyspageNumsselfstargets_pageNum(sselfskindsstuffspageNumskey((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysnotify;s  cCs<|i|i}t||i|_|ii||SdS(N( sselfs textPatterns _lastPageNumstexts Paragraphs paraStyles_paraswraps availWidths availHeight(sselfs availWidths availHeightstext((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pyswrapAsicCs|ii||||dS(N(sselfs_parasdrawOnscanvassxsys_sW(sselfscanvassxsys_sW((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pysdrawOnFs(s__name__s __module__s__doc__s__init__s beforeBuildsnotifyswrapsdrawOn(((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys ReferenceText-s     (s__doc__s __version__sstrings reportlab.libsenumssreportlab.lib.unitsscmsreportlab.lib.stylessParagraphStylesreportlab.platypus.paragraphs Paragraphsreportlab.platypus.doctemplatesIndexingFlowablesreportlab.platypus.tabless TableStylesTablesdeltasepsilonslevelZeroParaStyleslevelOneParaStyleslevelTwoParaStyleslevelThreeParaStyleslevelFourParaStylesdefaultTableStylesTableOfContentss SimpleIndexs ReferenceText(s __version__sIndexingFlowablesstringscmslevelThreeParaStyles TableStyleslevelZeroParaStylesTableOfContentsslevelFourParaStylesepsilons ReferenceTexts SimpleIndexs ParagraphslevelTwoParaStyleslevelOneParaStylesdeltasTablesenumssdefaultTableStylesParagraphStyle((sL/home/packages/reportlab/reportlab_2_0/reportlab/platypus/tableofcontents.pys?"sP             '}R