Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7900
- 72b88fb20261
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Graphics.ApplicationDiagramBuilder</h1> | 23 <h1>eric6.Graphics.ApplicationDiagramBuilder</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog showing an imports diagram of the application. | 26 Module implementing a dialog showing an imports diagram of the application. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td> | 38 <td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td> |
| 34 <td>Class implementing a builder for imports diagrams of the application.</td> | 39 <td>Class implementing a builder for imports diagrams of the application.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a> | 49 <a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a> |
| 43 <h2>ApplicationDiagramBuilder</h2> | 50 <h2>ApplicationDiagramBuilder</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a builder for imports diagrams of the application. | 53 Class implementing a builder for imports diagrams of the application. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 UMLDiagramBuilder | 56 UMLDiagramBuilder |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td> | 72 <td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#ApplicationDiagramBuilder.__addPackage">__addPackage</a></td> | 76 <td><a href="#ApplicationDiagramBuilder.__addPackage">__addPackage</a></td> |
| 64 <td>Private method to add a package to the diagram.</td> | 77 <td>Private method to add a package to the diagram.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#ApplicationDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> | 80 <td><a href="#ApplicationDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> |
| 67 <td>Private method to build a dictionary of modules contained in the application.</td> | 81 <td>Private method to build a dictionary of modules contained in the application.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td> | 84 <td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td> |
| 70 <td>Private method to generate the associations between the package shapes.</td> | 85 <td>Private method to generate the associations between the package shapes.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td> | 88 <td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td> |
| 73 <td>Public method to build the packages shapes of the diagram.</td> | 89 <td>Public method to build the packages shapes of the diagram.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#ApplicationDiagramBuilder.getPersistenceData">getPersistenceData</a></td> | 92 <td><a href="#ApplicationDiagramBuilder.getPersistenceData">getPersistenceData</a></td> |
| 76 <td>Public method to get a string for data to be persisted.</td> | 93 <td>Public method to get a string for data to be persisted.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#ApplicationDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | 96 <td><a href="#ApplicationDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> |
| 79 <td>Public method to parse persisted data.</td> | 97 <td>Public method to parse persisted data.</td> |
| 80 </tr> | 98 </tr> |
| 81 </table> | 99 </table> |
| 82 <h3>Static Methods</h3> | 100 <h3>Static Methods</h3> |
| 83 <table> | 101 |
| 84 <tr><td>None</td></tr> | 102 <table> |
| 85 </table> | 103 <tr><td>None</td></tr> |
| 104 </table> | |
| 105 | |
| 86 <a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a> | 106 <a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a> |
| 87 <h4>ApplicationDiagramBuilder (Constructor)</h4> | 107 <h4>ApplicationDiagramBuilder (Constructor)</h4> |
| 88 <b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>) | 108 <b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>) |
| 109 | |
| 89 <p> | 110 <p> |
| 90 Constructor | 111 Constructor |
| 91 </p><dl> | 112 </p> |
| 113 <dl> | |
| 114 | |
| 92 <dt><i>dialog</i></dt> | 115 <dt><i>dialog</i></dt> |
| 93 <dd> | 116 <dd> |
| 94 reference to the UML dialog (UMLDialog) | 117 reference to the UML dialog (UMLDialog) |
| 95 </dd><dt><i>view</i></dt> | 118 </dd> |
| 119 <dt><i>view</i></dt> | |
| 96 <dd> | 120 <dd> |
| 97 reference to the view object (UMLGraphicsView) | 121 reference to the view object (UMLGraphicsView) |
| 98 </dd><dt><i>project</i></dt> | 122 </dd> |
| 123 <dt><i>project</i></dt> | |
| 99 <dd> | 124 <dd> |
| 100 reference to the project object (Project) | 125 reference to the project object (Project) |
| 101 </dd><dt><i>noModules=</i></dt> | 126 </dd> |
| 127 <dt><i>noModules=</i></dt> | |
| 102 <dd> | 128 <dd> |
| 103 flag indicating, that no module names should be | 129 flag indicating, that no module names should be |
| 104 shown (boolean) | 130 shown (boolean) |
| 105 </dd> | 131 </dd> |
| 106 </dl><a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a> | 132 </dl> |
| 133 <a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a> | |
| 107 <h4>ApplicationDiagramBuilder.__addPackage</h4> | 134 <h4>ApplicationDiagramBuilder.__addPackage</h4> |
| 108 <b>__addPackage</b>(<i>name, modules, x, y</i>) | 135 <b>__addPackage</b>(<i>name, modules, x, y</i>) |
| 136 | |
| 109 <p> | 137 <p> |
| 110 Private method to add a package to the diagram. | 138 Private method to add a package to the diagram. |
| 111 </p><dl> | 139 </p> |
| 140 <dl> | |
| 141 | |
| 112 <dt><i>name</i></dt> | 142 <dt><i>name</i></dt> |
| 113 <dd> | 143 <dd> |
| 114 package name to be shown (string) | 144 package name to be shown (string) |
| 115 </dd><dt><i>modules</i></dt> | 145 </dd> |
| 146 <dt><i>modules</i></dt> | |
| 116 <dd> | 147 <dd> |
| 117 list of module names contained in the package | 148 list of module names contained in the package |
| 118 (list of strings) | 149 (list of strings) |
| 119 </dd><dt><i>x</i></dt> | 150 </dd> |
| 151 <dt><i>x</i></dt> | |
| 120 <dd> | 152 <dd> |
| 121 x-coordinate (float) | 153 x-coordinate (float) |
| 122 </dd><dt><i>y</i></dt> | 154 </dd> |
| 155 <dt><i>y</i></dt> | |
| 123 <dd> | 156 <dd> |
| 124 y-coordinate (float) | 157 y-coordinate (float) |
| 125 </dd> | 158 </dd> |
| 126 </dl><dl> | 159 </dl> |
| 160 <dl> | |
| 127 <dt>Returns:</dt> | 161 <dt>Returns:</dt> |
| 128 <dd> | 162 <dd> |
| 129 reference to the package item (PackageItem) | 163 reference to the package item (PackageItem) |
| 130 </dd> | 164 </dd> |
| 131 </dl><a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> | 165 </dl> |
| 166 <a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> | |
| 132 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4> | 167 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4> |
| 133 <b>__buildModulesDict</b>(<i></i>) | 168 <b>__buildModulesDict</b>(<i></i>) |
| 169 | |
| 134 <p> | 170 <p> |
| 135 Private method to build a dictionary of modules contained in the | 171 Private method to build a dictionary of modules contained in the |
| 136 application. | 172 application. |
| 137 </p><dl> | 173 </p> |
| 174 <dl> | |
| 138 <dt>Returns:</dt> | 175 <dt>Returns:</dt> |
| 139 <dd> | 176 <dd> |
| 140 dictionary of modules contained in the application. | 177 dictionary of modules contained in the application. |
| 141 </dd> | 178 </dd> |
| 142 </dl><a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> | 179 </dl> |
| 180 <a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> | |
| 143 <h4>ApplicationDiagramBuilder.__createAssociations</h4> | 181 <h4>ApplicationDiagramBuilder.__createAssociations</h4> |
| 144 <b>__createAssociations</b>(<i>shapes</i>) | 182 <b>__createAssociations</b>(<i>shapes</i>) |
| 183 | |
| 145 <p> | 184 <p> |
| 146 Private method to generate the associations between the package shapes. | 185 Private method to generate the associations between the package shapes. |
| 147 </p><dl> | 186 </p> |
| 187 <dl> | |
| 188 | |
| 148 <dt><i>shapes</i></dt> | 189 <dt><i>shapes</i></dt> |
| 149 <dd> | 190 <dd> |
| 150 list of shapes | 191 list of shapes |
| 151 </dd> | 192 </dd> |
| 152 </dl><a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a> | 193 </dl> |
| 194 <a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a> | |
| 153 <h4>ApplicationDiagramBuilder.buildDiagram</h4> | 195 <h4>ApplicationDiagramBuilder.buildDiagram</h4> |
| 154 <b>buildDiagram</b>(<i></i>) | 196 <b>buildDiagram</b>(<i></i>) |
| 197 | |
| 155 <p> | 198 <p> |
| 156 Public method to build the packages shapes of the diagram. | 199 Public method to build the packages shapes of the diagram. |
| 157 </p><a NAME="ApplicationDiagramBuilder.getPersistenceData" ID="ApplicationDiagramBuilder.getPersistenceData"></a> | 200 </p> |
| 201 <a NAME="ApplicationDiagramBuilder.getPersistenceData" ID="ApplicationDiagramBuilder.getPersistenceData"></a> | |
| 158 <h4>ApplicationDiagramBuilder.getPersistenceData</h4> | 202 <h4>ApplicationDiagramBuilder.getPersistenceData</h4> |
| 159 <b>getPersistenceData</b>(<i></i>) | 203 <b>getPersistenceData</b>(<i></i>) |
| 204 | |
| 160 <p> | 205 <p> |
| 161 Public method to get a string for data to be persisted. | 206 Public method to get a string for data to be persisted. |
| 162 </p><dl> | 207 </p> |
| 208 <dl> | |
| 163 <dt>Returns:</dt> | 209 <dt>Returns:</dt> |
| 164 <dd> | 210 <dd> |
| 165 persisted data string (string) | 211 persisted data string (string) |
| 166 </dd> | 212 </dd> |
| 167 </dl><a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> | 213 </dl> |
| 214 <a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> | |
| 168 <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> | 215 <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> |
| 169 <b>parsePersistenceData</b>(<i>version, data</i>) | 216 <b>parsePersistenceData</b>(<i>version, data</i>) |
| 217 | |
| 170 <p> | 218 <p> |
| 171 Public method to parse persisted data. | 219 Public method to parse persisted data. |
| 172 </p><dl> | 220 </p> |
| 221 <dl> | |
| 222 | |
| 173 <dt><i>version</i></dt> | 223 <dt><i>version</i></dt> |
| 174 <dd> | 224 <dd> |
| 175 version of the data (string) | 225 version of the data (string) |
| 176 </dd><dt><i>data</i></dt> | 226 </dd> |
| 227 <dt><i>data</i></dt> | |
| 177 <dd> | 228 <dd> |
| 178 persisted data to be parsed (string) | 229 persisted data to be parsed (string) |
| 179 </dd> | 230 </dd> |
| 180 </dl><dl> | 231 </dl> |
| 232 <dl> | |
| 181 <dt>Returns:</dt> | 233 <dt>Returns:</dt> |
| 182 <dd> | 234 <dd> |
| 183 flag indicating success (boolean) | 235 flag indicating success (boolean) |
| 184 </dd> | 236 </dd> |
| 185 </dl> | 237 </dl> |
