Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Graphics.ApplicationDiagramBuilder.html

src/eric7/Documentation/Source/eric7.Graphics.ApplicationDiagramBuilder.html

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Graphics.ApplicationDiagramBuilder</h1> 9 <h1>eric7.Graphics.ApplicationDiagramBuilder</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog showing an imports diagram of the application. 11 Module implementing a dialog showing an imports diagram of the application.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td> 22 <td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td>
25 <td>Class implementing a builder for imports diagrams of the application.</td> 23 <td>Class implementing a builder for imports diagrams of the application.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a> 34 <a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a>
36 <h2>ApplicationDiagramBuilder</h2> 35 <h2>ApplicationDiagramBuilder</h2>
37
38 <p> 36 <p>
39 Class implementing a builder for imports diagrams of the application. 37 Class implementing a builder for imports diagrams of the application.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 UMLDiagramBuilder 41 UMLDiagramBuilder
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td> 55 <td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
93 <tr> 90 <tr>
94 <td><a href="#ApplicationDiagramBuilder.toDict">toDict</a></td> 91 <td><a href="#ApplicationDiagramBuilder.toDict">toDict</a></td>
95 <td>Public method to collect data to be persisted.</td> 92 <td>Public method to collect data to be persisted.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a> 102 <a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a>
105 <h4>ApplicationDiagramBuilder (Constructor)</h4> 103 <h4>ApplicationDiagramBuilder (Constructor)</h4>
106 <b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>) 104 <b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>dialog</i> (UMLDialog)</dt> 111 <dt><i>dialog</i> (UMLDialog)</dt>
114 <dd> 112 <dd>
115 reference to the UML dialog 113 reference to the UML dialog
129 </dd> 127 </dd>
130 </dl> 128 </dl>
131 <a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a> 129 <a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a>
132 <h4>ApplicationDiagramBuilder.__addPackage</h4> 130 <h4>ApplicationDiagramBuilder.__addPackage</h4>
133 <b>__addPackage</b>(<i>name, modules, x, y</i>) 131 <b>__addPackage</b>(<i>name, modules, x, y</i>)
134
135 <p> 132 <p>
136 Private method to add a package to the diagram. 133 Private method to add a package to the diagram.
137 </p> 134 </p>
135
138 <dl> 136 <dl>
139 137
140 <dt><i>name</i> (str)</dt> 138 <dt><i>name</i> (str)</dt>
141 <dd> 139 <dd>
142 package name to be shown 140 package name to be shown
167 </dd> 165 </dd>
168 </dl> 166 </dl>
169 <a NAME="ApplicationDiagramBuilder.__arrangeNodes" ID="ApplicationDiagramBuilder.__arrangeNodes"></a> 167 <a NAME="ApplicationDiagramBuilder.__arrangeNodes" ID="ApplicationDiagramBuilder.__arrangeNodes"></a>
170 <h4>ApplicationDiagramBuilder.__arrangeNodes</h4> 168 <h4>ApplicationDiagramBuilder.__arrangeNodes</h4>
171 <b>__arrangeNodes</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) 169 <b>__arrangeNodes</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>)
172
173 <p> 170 <p>
174 Private method to arrange the shapes on the canvas. 171 Private method to arrange the shapes on the canvas.
175 </p> 172 </p>
176 <p> 173 <p>
177 The algorithm is borrowed from Boa Constructor. 174 The algorithm is borrowed from Boa Constructor.
178 </p> 175 </p>
176
179 <dl> 177 <dl>
180 178
181 <dt><i>nodes</i> (list of str)</dt> 179 <dt><i>nodes</i> (list of str)</dt>
182 <dd> 180 <dd>
183 list of nodes to arrange 181 list of nodes to arrange
193 </dd> 191 </dd>
194 </dl> 192 </dl>
195 <a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> 193 <a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a>
196 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4> 194 <h4>ApplicationDiagramBuilder.__buildModulesDict</h4>
197 <b>__buildModulesDict</b>(<i></i>) 195 <b>__buildModulesDict</b>(<i></i>)
198
199 <p> 196 <p>
200 Private method to build a dictionary of modules contained in the 197 Private method to build a dictionary of modules contained in the
201 application. 198 application.
202 </p> 199 </p>
200
203 <dl> 201 <dl>
204 <dt>Return:</dt> 202 <dt>Return:</dt>
205 <dd> 203 <dd>
206 dictionary of modules contained in the application 204 dictionary of modules contained in the application
207 </dd> 205 </dd>
213 </dd> 211 </dd>
214 </dl> 212 </dl>
215 <a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> 213 <a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a>
216 <h4>ApplicationDiagramBuilder.__createAssociations</h4> 214 <h4>ApplicationDiagramBuilder.__createAssociations</h4>
217 <b>__createAssociations</b>(<i>routes</i>) 215 <b>__createAssociations</b>(<i>routes</i>)
218
219 <p> 216 <p>
220 Private method to generate the associations between the module shapes. 217 Private method to generate the associations between the module shapes.
221 </p> 218 </p>
219
222 <dl> 220 <dl>
223 221
224 <dt><i>routes</i> (list of tuple of (str, str))</dt> 222 <dt><i>routes</i> (list of tuple of (str, str))</dt>
225 <dd> 223 <dd>
226 list of associations 224 list of associations
227 </dd> 225 </dd>
228 </dl> 226 </dl>
229 <a NAME="ApplicationDiagramBuilder.__findApplicationRoot" ID="ApplicationDiagramBuilder.__findApplicationRoot"></a> 227 <a NAME="ApplicationDiagramBuilder.__findApplicationRoot" ID="ApplicationDiagramBuilder.__findApplicationRoot"></a>
230 <h4>ApplicationDiagramBuilder.__findApplicationRoot</h4> 228 <h4>ApplicationDiagramBuilder.__findApplicationRoot</h4>
231 <b>__findApplicationRoot</b>(<i></i>) 229 <b>__findApplicationRoot</b>(<i></i>)
232
233 <p> 230 <p>
234 Private method to find the application root path. 231 Private method to find the application root path.
235 </p> 232 </p>
233
236 <dl> 234 <dl>
237 <dt>Return:</dt> 235 <dt>Return:</dt>
238 <dd> 236 <dd>
239 application root path 237 application root path
240 </dd> 238 </dd>
246 </dd> 244 </dd>
247 </dl> 245 </dl>
248 <a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a> 246 <a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a>
249 <h4>ApplicationDiagramBuilder.buildDiagram</h4> 247 <h4>ApplicationDiagramBuilder.buildDiagram</h4>
250 <b>buildDiagram</b>(<i></i>) 248 <b>buildDiagram</b>(<i></i>)
251
252 <p> 249 <p>
253 Public method to build the packages shapes of the diagram. 250 Public method to build the packages shapes of the diagram.
254 </p> 251 </p>
252
255 <a NAME="ApplicationDiagramBuilder.fromDict" ID="ApplicationDiagramBuilder.fromDict"></a> 253 <a NAME="ApplicationDiagramBuilder.fromDict" ID="ApplicationDiagramBuilder.fromDict"></a>
256 <h4>ApplicationDiagramBuilder.fromDict</h4> 254 <h4>ApplicationDiagramBuilder.fromDict</h4>
257 <b>fromDict</b>(<i>version, data</i>) 255 <b>fromDict</b>(<i>version, data</i>)
258
259 <p> 256 <p>
260 Public method to populate the class with data persisted by 'toDict()'. 257 Public method to populate the class with data persisted by 'toDict()'.
261 </p> 258 </p>
259
262 <dl> 260 <dl>
263 261
264 <dt><i>version</i> (str)</dt> 262 <dt><i>version</i> (str)</dt>
265 <dd> 263 <dd>
266 version of the data 264 version of the data
284 </dd> 282 </dd>
285 </dl> 283 </dl>
286 <a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> 284 <a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a>
287 <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> 285 <h4>ApplicationDiagramBuilder.parsePersistenceData</h4>
288 <b>parsePersistenceData</b>(<i>version, data</i>) 286 <b>parsePersistenceData</b>(<i>version, data</i>)
289
290 <p> 287 <p>
291 Public method to parse persisted data. 288 Public method to parse persisted data.
292 </p> 289 </p>
290
293 <dl> 291 <dl>
294 292
295 <dt><i>version</i> (str)</dt> 293 <dt><i>version</i> (str)</dt>
296 <dd> 294 <dd>
297 version of the data 295 version of the data
314 </dd> 312 </dd>
315 </dl> 313 </dl>
316 <a NAME="ApplicationDiagramBuilder.toDict" ID="ApplicationDiagramBuilder.toDict"></a> 314 <a NAME="ApplicationDiagramBuilder.toDict" ID="ApplicationDiagramBuilder.toDict"></a>
317 <h4>ApplicationDiagramBuilder.toDict</h4> 315 <h4>ApplicationDiagramBuilder.toDict</h4>
318 <b>toDict</b>(<i></i>) 316 <b>toDict</b>(<i></i>)
319
320 <p> 317 <p>
321 Public method to collect data to be persisted. 318 Public method to collect data to be persisted.
322 </p> 319 </p>
320
323 <dl> 321 <dl>
324 <dt>Return:</dt> 322 <dt>Return:</dt>
325 <dd> 323 <dd>
326 dictionary containing data to be persisted 324 dictionary containing data to be persisted
327 </dd> 325 </dd>

Mercurial Repository: eric

eric ide

mercurial