Mercurial Repositories > eric / file comparison

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

src/eric7/Documentation/Source/eric7.Graphics.UMLClassDiagramBuilder.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.UMLClassDiagramBuilder</h1> 9 <h1>eric7.Graphics.UMLClassDiagramBuilder</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog showing a UML like class diagram. 11 Module implementing a dialog showing a UML like class diagram.
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="#UMLClassDiagramBuilder">UMLClassDiagramBuilder</a></td> 22 <td><a href="#UMLClassDiagramBuilder">UMLClassDiagramBuilder</a></td>
25 <td>Class implementing a builder for UML like class diagrams.</td> 23 <td>Class implementing a builder for UML like class diagrams.</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="UMLClassDiagramBuilder" ID="UMLClassDiagramBuilder"></a> 34 <a NAME="UMLClassDiagramBuilder" ID="UMLClassDiagramBuilder"></a>
36 <h2>UMLClassDiagramBuilder</h2> 35 <h2>UMLClassDiagramBuilder</h2>
37
38 <p> 36 <p>
39 Class implementing a builder for UML like class diagrams. 37 Class implementing a builder for UML like class diagrams.
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="#UMLClassDiagramBuilder.__init__">UMLClassDiagramBuilder</a></td> 55 <td><a href="#UMLClassDiagramBuilder.__init__">UMLClassDiagramBuilder</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
97 <tr> 94 <tr>
98 <td><a href="#UMLClassDiagramBuilder.toDict">toDict</a></td> 95 <td><a href="#UMLClassDiagramBuilder.toDict">toDict</a></td>
99 <td>Public method to collect data to be persisted.</td> 96 <td>Public method to collect data to be persisted.</td>
100 </tr> 97 </tr>
101 </table> 98 </table>
99
102 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
103 101 <table>
104 <table> 102 <tr><td>None</td></tr>
105 <tr><td>None</td></tr> 103 </table>
106 </table> 104
107 105
108 <a NAME="UMLClassDiagramBuilder.__init__" ID="UMLClassDiagramBuilder.__init__"></a> 106 <a NAME="UMLClassDiagramBuilder.__init__" ID="UMLClassDiagramBuilder.__init__"></a>
109 <h4>UMLClassDiagramBuilder (Constructor)</h4> 107 <h4>UMLClassDiagramBuilder (Constructor)</h4>
110 <b>UMLClassDiagramBuilder</b>(<i>dialog, view, project, file, noAttrs=False</i>) 108 <b>UMLClassDiagramBuilder</b>(<i>dialog, view, project, file, noAttrs=False</i>)
111
112 <p> 109 <p>
113 Constructor 110 Constructor
114 </p> 111 </p>
112
115 <dl> 113 <dl>
116 114
117 <dt><i>dialog</i> (UMLDialog)</dt> 115 <dt><i>dialog</i> (UMLDialog)</dt>
118 <dd> 116 <dd>
119 reference to the UML dialog 117 reference to the UML dialog
136 </dd> 134 </dd>
137 </dl> 135 </dl>
138 <a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a> 136 <a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a>
139 <h4>UMLClassDiagramBuilder.__addExternalClass</h4> 137 <h4>UMLClassDiagramBuilder.__addExternalClass</h4>
140 <b>__addExternalClass</b>(<i>_class, x, y</i>) 138 <b>__addExternalClass</b>(<i>_class, x, y</i>)
141
142 <p> 139 <p>
143 Private method to add a class defined outside the module. 140 Private method to add a class defined outside the module.
144 </p> 141 </p>
145 <p> 142 <p>
146 If the canvas is too small to take the shape, it 143 If the canvas is too small to take the shape, it
147 is enlarged. 144 is enlarged.
148 </p> 145 </p>
146
149 <dl> 147 <dl>
150 148
151 <dt><i>_class</i> (ModuleParser.Class)</dt> 149 <dt><i>_class</i> (ModuleParser.Class)</dt>
152 <dd> 150 <dd>
153 class to be shown 151 class to be shown
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a> 162 <a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a>
165 <h4>UMLClassDiagramBuilder.__addLocalClass</h4> 163 <h4>UMLClassDiagramBuilder.__addLocalClass</h4>
166 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) 164 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>)
167
168 <p> 165 <p>
169 Private method to add a class defined in the module. 166 Private method to add a class defined in the module.
170 </p> 167 </p>
168
171 <dl> 169 <dl>
172 170
173 <dt><i>className</i> (str)</dt> 171 <dt><i>className</i> (str)</dt>
174 <dd> 172 <dd>
175 name of the class to be as a dictionary key 173 name of the class to be as a dictionary key
192 </dd> 190 </dd>
193 </dl> 191 </dl>
194 <a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a> 192 <a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a>
195 <h4>UMLClassDiagramBuilder.__arrangeClasses</h4> 193 <h4>UMLClassDiagramBuilder.__arrangeClasses</h4>
196 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) 194 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>)
197
198 <p> 195 <p>
199 Private method to arrange the shapes on the canvas. 196 Private method to arrange the shapes on the canvas.
200 </p> 197 </p>
201 <p> 198 <p>
202 The algorithm is borrowed from Boa Constructor. 199 The algorithm is borrowed from Boa Constructor.
203 </p> 200 </p>
201
204 <dl> 202 <dl>
205 203
206 <dt><i>nodes</i> (list of str)</dt> 204 <dt><i>nodes</i> (list of str)</dt>
207 <dd> 205 <dd>
208 list of nodes to arrange 206 list of nodes to arrange
218 </dd> 216 </dd>
219 </dl> 217 </dl>
220 <a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a> 218 <a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a>
221 <h4>UMLClassDiagramBuilder.__createAssociations</h4> 219 <h4>UMLClassDiagramBuilder.__createAssociations</h4>
222 <b>__createAssociations</b>(<i>routes</i>) 220 <b>__createAssociations</b>(<i>routes</i>)
223
224 <p> 221 <p>
225 Private method to generate the associations between the class shapes. 222 Private method to generate the associations between the class shapes.
226 </p> 223 </p>
224
227 <dl> 225 <dl>
228 226
229 <dt><i>routes</i> (list of tuple of (str, str))</dt> 227 <dt><i>routes</i> (list of tuple of (str, str))</dt>
230 <dd> 228 <dd>
231 list of relationsships 229 list of relationsships
232 </dd> 230 </dd>
233 </dl> 231 </dl>
234 <a NAME="UMLClassDiagramBuilder.__getCurrentShape" ID="UMLClassDiagramBuilder.__getCurrentShape"></a> 232 <a NAME="UMLClassDiagramBuilder.__getCurrentShape" ID="UMLClassDiagramBuilder.__getCurrentShape"></a>
235 <h4>UMLClassDiagramBuilder.__getCurrentShape</h4> 233 <h4>UMLClassDiagramBuilder.__getCurrentShape</h4>
236 <b>__getCurrentShape</b>(<i>name</i>) 234 <b>__getCurrentShape</b>(<i>name</i>)
237
238 <p> 235 <p>
239 Private method to get the named shape. 236 Private method to get the named shape.
240 </p> 237 </p>
238
241 <dl> 239 <dl>
242 240
243 <dt><i>name</i> (str)</dt> 241 <dt><i>name</i> (str)</dt>
244 <dd> 242 <dd>
245 name of the shape 243 name of the shape
258 </dd> 256 </dd>
259 </dl> 257 </dl>
260 <a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a> 258 <a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a>
261 <h4>UMLClassDiagramBuilder.buildDiagram</h4> 259 <h4>UMLClassDiagramBuilder.buildDiagram</h4>
262 <b>buildDiagram</b>(<i></i>) 260 <b>buildDiagram</b>(<i></i>)
263
264 <p> 261 <p>
265 Public method to build the class shapes of the class diagram. 262 Public method to build the class shapes of the class diagram.
266 </p> 263 </p>
267 <p> 264 <p>
268 The algorithm is borrowed from Boa Constructor. 265 The algorithm is borrowed from Boa Constructor.
269 </p> 266 </p>
267
270 <a NAME="UMLClassDiagramBuilder.fromDict" ID="UMLClassDiagramBuilder.fromDict"></a> 268 <a NAME="UMLClassDiagramBuilder.fromDict" ID="UMLClassDiagramBuilder.fromDict"></a>
271 <h4>UMLClassDiagramBuilder.fromDict</h4> 269 <h4>UMLClassDiagramBuilder.fromDict</h4>
272 <b>fromDict</b>(<i>version, data</i>) 270 <b>fromDict</b>(<i>version, data</i>)
273
274 <p> 271 <p>
275 Public method to populate the class with data persisted by 'toDict()'. 272 Public method to populate the class with data persisted by 'toDict()'.
276 </p> 273 </p>
274
277 <dl> 275 <dl>
278 276
279 <dt><i>version</i> (str)</dt> 277 <dt><i>version</i> (str)</dt>
280 <dd> 278 <dd>
281 version of the data 279 version of the data
299 </dd> 297 </dd>
300 </dl> 298 </dl>
301 <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a> 299 <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a>
302 <h4>UMLClassDiagramBuilder.initialize</h4> 300 <h4>UMLClassDiagramBuilder.initialize</h4>
303 <b>initialize</b>(<i></i>) 301 <b>initialize</b>(<i></i>)
304
305 <p> 302 <p>
306 Public method to initialize the object. 303 Public method to initialize the object.
307 </p> 304 </p>
305
308 <a NAME="UMLClassDiagramBuilder.parsePersistenceData" ID="UMLClassDiagramBuilder.parsePersistenceData"></a> 306 <a NAME="UMLClassDiagramBuilder.parsePersistenceData" ID="UMLClassDiagramBuilder.parsePersistenceData"></a>
309 <h4>UMLClassDiagramBuilder.parsePersistenceData</h4> 307 <h4>UMLClassDiagramBuilder.parsePersistenceData</h4>
310 <b>parsePersistenceData</b>(<i>version, data</i>) 308 <b>parsePersistenceData</b>(<i>version, data</i>)
311
312 <p> 309 <p>
313 Public method to parse persisted data. 310 Public method to parse persisted data.
314 </p> 311 </p>
312
315 <dl> 313 <dl>
316 314
317 <dt><i>version</i> (str)</dt> 315 <dt><i>version</i> (str)</dt>
318 <dd> 316 <dd>
319 version of the data 317 version of the data
336 </dd> 334 </dd>
337 </dl> 335 </dl>
338 <a NAME="UMLClassDiagramBuilder.toDict" ID="UMLClassDiagramBuilder.toDict"></a> 336 <a NAME="UMLClassDiagramBuilder.toDict" ID="UMLClassDiagramBuilder.toDict"></a>
339 <h4>UMLClassDiagramBuilder.toDict</h4> 337 <h4>UMLClassDiagramBuilder.toDict</h4>
340 <b>toDict</b>(<i></i>) 338 <b>toDict</b>(<i></i>)
341
342 <p> 339 <p>
343 Public method to collect data to be persisted. 340 Public method to collect data to be persisted.
344 </p> 341 </p>
342
345 <dl> 343 <dl>
346 <dt>Return:</dt> 344 <dt>Return:</dt>
347 <dd> 345 <dd>
348 dictionary containing data to be persisted 346 dictionary containing data to be persisted
349 </dd> 347 </dd>

Mercurial Repository: eric

eric ide

mercurial