Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Graphics.ApplicationDiagramBuilder</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Graphics.ApplicationDiagramBuilder</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog showing an imports diagram of the application. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td> | |
| 34 <td>Class implementing a builder for imports diagrams of the application.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a> | |
| 43 <h2>ApplicationDiagramBuilder</h2> | |
| 44 <p> | |
| 45 Class implementing a builder for imports diagrams of the application. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 UMLDiagramBuilder | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ApplicationDiagramBuilder.__addPackage">__addPackage</a></td> | |
| 64 <td>Private method to add a package to the diagram.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ApplicationDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> | |
| 67 <td>Private method to build a dictionary of modules contained in the application.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td> | |
| 70 <td>Private method to generate the associations between the package shapes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td> | |
| 73 <td>Public method to build the packages shapes of the diagram.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ApplicationDiagramBuilder.getPersistenceData">getPersistenceData</a></td> | |
| 76 <td>Public method to get a string for data to be persisted.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ApplicationDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | |
| 79 <td>Public method to parse persisted data.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a> | |
| 87 <h4>ApplicationDiagramBuilder (Constructor)</h4> | |
| 88 <b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>dialog</i></dt> | |
| 93 <dd> | |
| 94 reference to the UML dialog (UMLDialog) | |
| 95 </dd><dt><i>view</i></dt> | |
| 96 <dd> | |
| 97 reference to the view object (UMLGraphicsView) | |
| 98 </dd><dt><i>project</i></dt> | |
| 99 <dd> | |
| 100 reference to the project object (Project) | |
| 101 </dd><dt><i>noModules=</i></dt> | |
| 102 <dd> | |
| 103 flag indicating, that no module names should be | |
| 104 shown (boolean) | |
| 105 </dd> | |
| 106 </dl><a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a> | |
| 107 <h4>ApplicationDiagramBuilder.__addPackage</h4> | |
| 108 <b>__addPackage</b>(<i>name, modules, x, y</i>) | |
| 109 <p> | |
| 110 Private method to add a package to the diagram. | |
| 111 </p><dl> | |
| 112 <dt><i>name</i></dt> | |
| 113 <dd> | |
| 114 package name to be shown (string) | |
| 115 </dd><dt><i>modules</i></dt> | |
| 116 <dd> | |
| 117 list of module names contained in the package | |
| 118 (list of strings) | |
| 119 </dd><dt><i>x</i></dt> | |
| 120 <dd> | |
| 121 x-coordinate (float) | |
| 122 </dd><dt><i>y</i></dt> | |
| 123 <dd> | |
| 124 y-coordinate (float) | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Returns:</dt> | |
| 128 <dd> | |
| 129 reference to the package item (PackageItem) | |
| 130 </dd> | |
| 131 </dl><a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> | |
| 132 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4> | |
| 133 <b>__buildModulesDict</b>(<i></i>) | |
| 134 <p> | |
| 135 Private method to build a dictionary of modules contained in the | |
| 136 application. | |
| 137 </p><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 dictionary of modules contained in the application. | |
| 141 </dd> | |
| 142 </dl><a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> | |
| 143 <h4>ApplicationDiagramBuilder.__createAssociations</h4> | |
| 144 <b>__createAssociations</b>(<i>shapes</i>) | |
| 145 <p> | |
| 146 Private method to generate the associations between the package shapes. | |
| 147 </p><dl> | |
| 148 <dt><i>shapes</i></dt> | |
| 149 <dd> | |
| 150 list of shapes | |
| 151 </dd> | |
| 152 </dl><a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a> | |
| 153 <h4>ApplicationDiagramBuilder.buildDiagram</h4> | |
| 154 <b>buildDiagram</b>(<i></i>) | |
| 155 <p> | |
| 156 Public method to build the packages shapes of the diagram. | |
| 157 </p><a NAME="ApplicationDiagramBuilder.getPersistenceData" ID="ApplicationDiagramBuilder.getPersistenceData"></a> | |
| 158 <h4>ApplicationDiagramBuilder.getPersistenceData</h4> | |
| 159 <b>getPersistenceData</b>(<i></i>) | |
| 160 <p> | |
| 161 Public method to get a string for data to be persisted. | |
| 162 </p><dl> | |
| 163 <dt>Returns:</dt> | |
| 164 <dd> | |
| 165 persisted data string (string) | |
| 166 </dd> | |
| 167 </dl><a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> | |
| 168 <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> | |
| 169 <b>parsePersistenceData</b>(<i>version, data</i>) | |
| 170 <p> | |
| 171 Public method to parse persisted data. | |
| 172 </p><dl> | |
| 173 <dt><i>version</i></dt> | |
| 174 <dd> | |
| 175 version of the data (string) | |
| 176 </dd><dt><i>data</i></dt> | |
| 177 <dd> | |
| 178 persisted data to be parsed (string) | |
| 179 </dd> | |
| 180 </dl><dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 flag indicating success (boolean) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <div align="right"><a href="#top">Up</a></div> | |
| 187 <hr /> | |
| 188 </body></html> |
