Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Graphics.PackageDiagramBuilder.html
Documentation/Source/eric5.Graphics.PackageDiagramBuilder.html
- changeset 2031
- c36c2eb62a75
- child 2033
- 4b99609f6a87
equal
deleted
inserted
replaced
| 2030:db11a2fe9bbc | 2031:c36c2eb62a75 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Graphics.PackageDiagramBuilder</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Graphics.PackageDiagramBuilder</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog showing a UML like class diagram of a package. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#PackageDiagramBuilder">PackageDiagramBuilder</a></td> | |
| 35 <td>Class implementing a builder for UML like class diagrams of a package.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="PackageDiagramBuilder" ID="PackageDiagramBuilder"></a> | |
| 44 <h2>PackageDiagramBuilder</h2> | |
| 45 <p> | |
| 46 Class implementing a builder for UML like class diagrams of a package. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 UMLDiagramBuilder | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#PackageDiagramBuilder.__init__">PackageDiagramBuilder</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#PackageDiagramBuilder.__addExternalClass">__addExternalClass</a></td> | |
| 65 <td>Private method to add a class defined outside the module.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#PackageDiagramBuilder.__addLocalClass">__addLocalClass</a></td> | |
| 68 <td>Private method to add a class defined in the module.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#PackageDiagramBuilder.__arrangeClasses">__arrangeClasses</a></td> | |
| 71 <td>Private method to arrange the shapes on the canvas.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#PackageDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> | |
| 74 <td>Private method to build a dictionary of modules contained in the package.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#PackageDiagramBuilder.__createAssociations">__createAssociations</a></td> | |
| 77 <td>Private method to generate the associations between the class shapes.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#PackageDiagramBuilder.__getCurrentShape">__getCurrentShape</a></td> | |
| 80 <td>Private method to get the named shape.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#PackageDiagramBuilder.buildDiagram">buildDiagram</a></td> | |
| 83 <td>Public method to build the class shapes of the package diagram.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 <table> | |
| 88 <tr><td>None</td></tr> | |
| 89 </table> | |
| 90 <a NAME="PackageDiagramBuilder.__init__" ID="PackageDiagramBuilder.__init__"></a> | |
| 91 <h4>PackageDiagramBuilder (Constructor)</h4> | |
| 92 <b>PackageDiagramBuilder</b>(<i>dialog, view, project, package, noAttrs=False</i>) | |
| 93 <p> | |
| 94 Constructor | |
| 95 </p><dl> | |
| 96 <dt><i>dialog</i></dt> | |
| 97 <dd> | |
| 98 reference to the UML dialog (UMLDialog) | |
| 99 </dd><dt><i>view</i></dt> | |
| 100 <dd> | |
| 101 reference to the view object (UMLGraphicsView) | |
| 102 </dd><dt><i>project</i></dt> | |
| 103 <dd> | |
| 104 reference to the project object (Project) | |
| 105 </dd><dt><i>package</i></dt> | |
| 106 <dd> | |
| 107 name of a python package to be shown (string) | |
| 108 </dd><dt><i>noAttrs=</i></dt> | |
| 109 <dd> | |
| 110 flag indicating, that no attributes should be shown (boolean) | |
| 111 </dd> | |
| 112 </dl><a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a> | |
| 113 <h4>PackageDiagramBuilder.__addExternalClass</h4> | |
| 114 <b>__addExternalClass</b>(<i>_class, x, y</i>) | |
| 115 <p> | |
| 116 Private method to add a class defined outside the module. | |
| 117 </p><p> | |
| 118 If the canvas is too small to take the shape, it | |
| 119 is enlarged. | |
| 120 </p><dl> | |
| 121 <dt><i>_class</i></dt> | |
| 122 <dd> | |
| 123 class to be shown (string) | |
| 124 </dd><dt><i>x</i></dt> | |
| 125 <dd> | |
| 126 x-coordinate (float) | |
| 127 </dd><dt><i>y</i></dt> | |
| 128 <dd> | |
| 129 y-coordinate (float) | |
| 130 </dd> | |
| 131 </dl><a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a> | |
| 132 <h4>PackageDiagramBuilder.__addLocalClass</h4> | |
| 133 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) | |
| 134 <p> | |
| 135 Private method to add a class defined in the module. | |
| 136 </p><dl> | |
| 137 <dt><i>className</i></dt> | |
| 138 <dd> | |
| 139 name of the class to be as a dictionary key (string) | |
| 140 </dd><dt><i>_class</i></dt> | |
| 141 <dd> | |
| 142 class to be shown (ModuleParser.Class) | |
| 143 </dd><dt><i>x</i></dt> | |
| 144 <dd> | |
| 145 x-coordinate (float) | |
| 146 </dd><dt><i>y</i></dt> | |
| 147 <dd> | |
| 148 y-coordinate (float) | |
| 149 </dd><dt><i>isRbModule</i></dt> | |
| 150 <dd> | |
| 151 flag indicating a Ruby module (boolean) | |
| 152 </dd> | |
| 153 </dl><a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a> | |
| 154 <h4>PackageDiagramBuilder.__arrangeClasses</h4> | |
| 155 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) | |
| 156 <p> | |
| 157 Private method to arrange the shapes on the canvas. | |
| 158 </p><p> | |
| 159 The algorithm is borrowed from Boa Constructor. | |
| 160 </p><a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> | |
| 161 <h4>PackageDiagramBuilder.__buildModulesDict</h4> | |
| 162 <b>__buildModulesDict</b>(<i></i>) | |
| 163 <p> | |
| 164 Private method to build a dictionary of modules contained in the package. | |
| 165 </p><dl> | |
| 166 <dt>Returns:</dt> | |
| 167 <dd> | |
| 168 dictionary of modules contained in the package. | |
| 169 </dd> | |
| 170 </dl><a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a> | |
| 171 <h4>PackageDiagramBuilder.__createAssociations</h4> | |
| 172 <b>__createAssociations</b>(<i>routes</i>) | |
| 173 <p> | |
| 174 Private method to generate the associations between the class shapes. | |
| 175 </p><dl> | |
| 176 <dt><i>routes</i></dt> | |
| 177 <dd> | |
| 178 list of relationsships | |
| 179 </dd> | |
| 180 </dl><a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a> | |
| 181 <h4>PackageDiagramBuilder.__getCurrentShape</h4> | |
| 182 <b>__getCurrentShape</b>(<i>name</i>) | |
| 183 <p> | |
| 184 Private method to get the named shape. | |
| 185 </p><dl> | |
| 186 <dt><i>name</i></dt> | |
| 187 <dd> | |
| 188 name of the shape (string) | |
| 189 </dd> | |
| 190 </dl><dl> | |
| 191 <dt>Returns:</dt> | |
| 192 <dd> | |
| 193 shape (QCanvasItem) | |
| 194 </dd> | |
| 195 </dl><a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a> | |
| 196 <h4>PackageDiagramBuilder.buildDiagram</h4> | |
| 197 <b>buildDiagram</b>(<i></i>) | |
| 198 <p> | |
| 199 Public method to build the class shapes of the package diagram. | |
| 200 </p><p> | |
| 201 The algorithm is borrowed from Boa Constructor. | |
| 202 </p> | |
| 203 <div align="right"><a href="#top">Up</a></div> | |
| 204 <hr /> | |
| 205 </body></html> |
