Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.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.PackageDiagramBuilder</h1> | 23 <h1>eric6.Graphics.PackageDiagramBuilder</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog showing a UML like class diagram of a package. | 26 Module implementing a dialog showing a UML like class diagram of a package. |
| 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="#PackageDiagramBuilder">PackageDiagramBuilder</a></td> | 38 <td><a href="#PackageDiagramBuilder">PackageDiagramBuilder</a></td> |
| 34 <td>Class implementing a builder for UML like class diagrams of a package.</td> | 39 <td>Class implementing a builder for UML like class diagrams of a package.</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="PackageDiagramBuilder" ID="PackageDiagramBuilder"></a> | 49 <a NAME="PackageDiagramBuilder" ID="PackageDiagramBuilder"></a> |
| 43 <h2>PackageDiagramBuilder</h2> | 50 <h2>PackageDiagramBuilder</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a builder for UML like class diagrams of a package. | 53 Class implementing a builder for UML like class diagrams of a package. |
| 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="#PackageDiagramBuilder.__init__">PackageDiagramBuilder</a></td> | 72 <td><a href="#PackageDiagramBuilder.__init__">PackageDiagramBuilder</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#PackageDiagramBuilder.__addExternalClass">__addExternalClass</a></td> | 76 <td><a href="#PackageDiagramBuilder.__addExternalClass">__addExternalClass</a></td> |
| 64 <td>Private method to add a class defined outside the module.</td> | 77 <td>Private method to add a class defined outside the module.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#PackageDiagramBuilder.__addLocalClass">__addLocalClass</a></td> | 80 <td><a href="#PackageDiagramBuilder.__addLocalClass">__addLocalClass</a></td> |
| 67 <td>Private method to add a class defined in the module.</td> | 81 <td>Private method to add a class defined in the module.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#PackageDiagramBuilder.__addPackage">__addPackage</a></td> | 84 <td><a href="#PackageDiagramBuilder.__addPackage">__addPackage</a></td> |
| 70 <td>Private method to add a package to the diagram.</td> | 85 <td>Private method to add a package to the diagram.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#PackageDiagramBuilder.__arrangeClasses">__arrangeClasses</a></td> | 88 <td><a href="#PackageDiagramBuilder.__arrangeClasses">__arrangeClasses</a></td> |
| 73 <td>Private method to arrange the shapes on the canvas.</td> | 89 <td>Private method to arrange the shapes on the canvas.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#PackageDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> | 92 <td><a href="#PackageDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td> |
| 76 <td>Private method to build a dictionary of modules contained in the package.</td> | 93 <td>Private method to build a dictionary of modules contained in the package.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#PackageDiagramBuilder.__buildSubpackagesDict">__buildSubpackagesDict</a></td> | 96 <td><a href="#PackageDiagramBuilder.__buildSubpackagesDict">__buildSubpackagesDict</a></td> |
| 79 <td>Private method to build a dictionary of sub-packages contained in this package.</td> | 97 <td>Private method to build a dictionary of sub-packages contained in this package.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#PackageDiagramBuilder.__createAssociations">__createAssociations</a></td> | 100 <td><a href="#PackageDiagramBuilder.__createAssociations">__createAssociations</a></td> |
| 82 <td>Private method to generate the associations between the class shapes.</td> | 101 <td>Private method to generate the associations between the class shapes.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#PackageDiagramBuilder.__getCurrentShape">__getCurrentShape</a></td> | 104 <td><a href="#PackageDiagramBuilder.__getCurrentShape">__getCurrentShape</a></td> |
| 85 <td>Private method to get the named shape.</td> | 105 <td>Private method to get the named shape.</td> |
| 86 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 87 <td><a href="#PackageDiagramBuilder.buildDiagram">buildDiagram</a></td> | 108 <td><a href="#PackageDiagramBuilder.buildDiagram">buildDiagram</a></td> |
| 88 <td>Public method to build the class shapes of the package diagram.</td> | 109 <td>Public method to build the class shapes of the package diagram.</td> |
| 89 </tr><tr> | 110 </tr> |
| 111 <tr> | |
| 90 <td><a href="#PackageDiagramBuilder.getPersistenceData">getPersistenceData</a></td> | 112 <td><a href="#PackageDiagramBuilder.getPersistenceData">getPersistenceData</a></td> |
| 91 <td>Public method to get a string for data to be persisted.</td> | 113 <td>Public method to get a string for data to be persisted.</td> |
| 92 </tr><tr> | 114 </tr> |
| 115 <tr> | |
| 93 <td><a href="#PackageDiagramBuilder.initialize">initialize</a></td> | 116 <td><a href="#PackageDiagramBuilder.initialize">initialize</a></td> |
| 94 <td>Public method to initialize the object.</td> | 117 <td>Public method to initialize the object.</td> |
| 95 </tr><tr> | 118 </tr> |
| 119 <tr> | |
| 96 <td><a href="#PackageDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | 120 <td><a href="#PackageDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> |
| 97 <td>Public method to parse persisted data.</td> | 121 <td>Public method to parse persisted data.</td> |
| 98 </tr> | 122 </tr> |
| 99 </table> | 123 </table> |
| 100 <h3>Static Methods</h3> | 124 <h3>Static Methods</h3> |
| 101 <table> | 125 |
| 102 <tr><td>None</td></tr> | 126 <table> |
| 103 </table> | 127 <tr><td>None</td></tr> |
| 128 </table> | |
| 129 | |
| 104 <a NAME="PackageDiagramBuilder.__init__" ID="PackageDiagramBuilder.__init__"></a> | 130 <a NAME="PackageDiagramBuilder.__init__" ID="PackageDiagramBuilder.__init__"></a> |
| 105 <h4>PackageDiagramBuilder (Constructor)</h4> | 131 <h4>PackageDiagramBuilder (Constructor)</h4> |
| 106 <b>PackageDiagramBuilder</b>(<i>dialog, view, project, package, noAttrs=False</i>) | 132 <b>PackageDiagramBuilder</b>(<i>dialog, view, project, package, noAttrs=False</i>) |
| 133 | |
| 107 <p> | 134 <p> |
| 108 Constructor | 135 Constructor |
| 109 </p><dl> | 136 </p> |
| 137 <dl> | |
| 138 | |
| 110 <dt><i>dialog</i></dt> | 139 <dt><i>dialog</i></dt> |
| 111 <dd> | 140 <dd> |
| 112 reference to the UML dialog (UMLDialog) | 141 reference to the UML dialog (UMLDialog) |
| 113 </dd><dt><i>view</i></dt> | 142 </dd> |
| 143 <dt><i>view</i></dt> | |
| 114 <dd> | 144 <dd> |
| 115 reference to the view object (UMLGraphicsView) | 145 reference to the view object (UMLGraphicsView) |
| 116 </dd><dt><i>project</i></dt> | 146 </dd> |
| 147 <dt><i>project</i></dt> | |
| 117 <dd> | 148 <dd> |
| 118 reference to the project object (Project) | 149 reference to the project object (Project) |
| 119 </dd><dt><i>package</i></dt> | 150 </dd> |
| 151 <dt><i>package</i></dt> | |
| 120 <dd> | 152 <dd> |
| 121 name of a python package to be shown (string) | 153 name of a python package to be shown (string) |
| 122 </dd><dt><i>noAttrs=</i></dt> | 154 </dd> |
| 155 <dt><i>noAttrs=</i></dt> | |
| 123 <dd> | 156 <dd> |
| 124 flag indicating, that no attributes should be shown | 157 flag indicating, that no attributes should be shown |
| 125 (boolean) | 158 (boolean) |
| 126 </dd> | 159 </dd> |
| 127 </dl><a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a> | 160 </dl> |
| 161 <a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a> | |
| 128 <h4>PackageDiagramBuilder.__addExternalClass</h4> | 162 <h4>PackageDiagramBuilder.__addExternalClass</h4> |
| 129 <b>__addExternalClass</b>(<i>_class, x, y</i>) | 163 <b>__addExternalClass</b>(<i>_class, x, y</i>) |
| 164 | |
| 130 <p> | 165 <p> |
| 131 Private method to add a class defined outside the module. | 166 Private method to add a class defined outside the module. |
| 132 </p><p> | 167 </p> |
| 168 <p> | |
| 133 If the canvas is too small to take the shape, it | 169 If the canvas is too small to take the shape, it |
| 134 is enlarged. | 170 is enlarged. |
| 135 </p><dl> | 171 </p> |
| 172 <dl> | |
| 173 | |
| 136 <dt><i>_class</i></dt> | 174 <dt><i>_class</i></dt> |
| 137 <dd> | 175 <dd> |
| 138 class to be shown (string) | 176 class to be shown (string) |
| 139 </dd><dt><i>x</i></dt> | 177 </dd> |
| 178 <dt><i>x</i></dt> | |
| 140 <dd> | 179 <dd> |
| 141 x-coordinate (float) | 180 x-coordinate (float) |
| 142 </dd><dt><i>y</i></dt> | 181 </dd> |
| 182 <dt><i>y</i></dt> | |
| 143 <dd> | 183 <dd> |
| 144 y-coordinate (float) | 184 y-coordinate (float) |
| 145 </dd> | 185 </dd> |
| 146 </dl><a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a> | 186 </dl> |
| 187 <a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a> | |
| 147 <h4>PackageDiagramBuilder.__addLocalClass</h4> | 188 <h4>PackageDiagramBuilder.__addLocalClass</h4> |
| 148 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) | 189 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) |
| 190 | |
| 149 <p> | 191 <p> |
| 150 Private method to add a class defined in the module. | 192 Private method to add a class defined in the module. |
| 151 </p><dl> | 193 </p> |
| 194 <dl> | |
| 195 | |
| 152 <dt><i>className</i></dt> | 196 <dt><i>className</i></dt> |
| 153 <dd> | 197 <dd> |
| 154 name of the class to be as a dictionary key (string) | 198 name of the class to be as a dictionary key (string) |
| 155 </dd><dt><i>_class</i></dt> | 199 </dd> |
| 200 <dt><i>_class</i></dt> | |
| 156 <dd> | 201 <dd> |
| 157 class to be shown (ModuleParser.Class) | 202 class to be shown (ModuleParser.Class) |
| 158 </dd><dt><i>x</i></dt> | 203 </dd> |
| 204 <dt><i>x</i></dt> | |
| 159 <dd> | 205 <dd> |
| 160 x-coordinate (float) | 206 x-coordinate (float) |
| 161 </dd><dt><i>y</i></dt> | 207 </dd> |
| 208 <dt><i>y</i></dt> | |
| 162 <dd> | 209 <dd> |
| 163 y-coordinate (float) | 210 y-coordinate (float) |
| 164 </dd><dt><i>isRbModule</i></dt> | 211 </dd> |
| 212 <dt><i>isRbModule</i></dt> | |
| 165 <dd> | 213 <dd> |
| 166 flag indicating a Ruby module (boolean) | 214 flag indicating a Ruby module (boolean) |
| 167 </dd> | 215 </dd> |
| 168 </dl><a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a> | 216 </dl> |
| 217 <a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a> | |
| 169 <h4>PackageDiagramBuilder.__addPackage</h4> | 218 <h4>PackageDiagramBuilder.__addPackage</h4> |
| 170 <b>__addPackage</b>(<i>name, modules, x, y</i>) | 219 <b>__addPackage</b>(<i>name, modules, x, y</i>) |
| 220 | |
| 171 <p> | 221 <p> |
| 172 Private method to add a package to the diagram. | 222 Private method to add a package to the diagram. |
| 173 </p><dl> | 223 </p> |
| 224 <dl> | |
| 225 | |
| 174 <dt><i>name</i></dt> | 226 <dt><i>name</i></dt> |
| 175 <dd> | 227 <dd> |
| 176 package name to be shown (string) | 228 package name to be shown (string) |
| 177 </dd><dt><i>modules</i></dt> | 229 </dd> |
| 230 <dt><i>modules</i></dt> | |
| 178 <dd> | 231 <dd> |
| 179 list of module names contained in the package | 232 list of module names contained in the package |
| 180 (list of strings) | 233 (list of strings) |
| 181 </dd><dt><i>x</i></dt> | 234 </dd> |
| 235 <dt><i>x</i></dt> | |
| 182 <dd> | 236 <dd> |
| 183 x-coordinate (float) | 237 x-coordinate (float) |
| 184 </dd><dt><i>y</i></dt> | 238 </dd> |
| 239 <dt><i>y</i></dt> | |
| 185 <dd> | 240 <dd> |
| 186 y-coordinate (float) | 241 y-coordinate (float) |
| 187 </dd> | 242 </dd> |
| 188 </dl><a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a> | 243 </dl> |
| 244 <a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a> | |
| 189 <h4>PackageDiagramBuilder.__arrangeClasses</h4> | 245 <h4>PackageDiagramBuilder.__arrangeClasses</h4> |
| 190 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) | 246 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) |
| 247 | |
| 191 <p> | 248 <p> |
| 192 Private method to arrange the shapes on the canvas. | 249 Private method to arrange the shapes on the canvas. |
| 193 </p><p> | 250 </p> |
| 251 <p> | |
| 194 The algorithm is borrowed from Boa Constructor. | 252 The algorithm is borrowed from Boa Constructor. |
| 195 </p><dl> | 253 </p> |
| 254 <dl> | |
| 255 | |
| 196 <dt><i>nodes</i></dt> | 256 <dt><i>nodes</i></dt> |
| 197 <dd> | 257 <dd> |
| 198 list of nodes to arrange | 258 list of nodes to arrange |
| 199 </dd><dt><i>routes</i></dt> | 259 </dd> |
| 260 <dt><i>routes</i></dt> | |
| 200 <dd> | 261 <dd> |
| 201 list of routes | 262 list of routes |
| 202 </dd><dt><i>whiteSpaceFactor</i></dt> | 263 </dd> |
| 264 <dt><i>whiteSpaceFactor</i></dt> | |
| 203 <dd> | 265 <dd> |
| 204 factor to increase whitespace between | 266 factor to increase whitespace between |
| 205 items (float) | 267 items (float) |
| 206 </dd> | 268 </dd> |
| 207 </dl><a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> | 269 </dl> |
| 270 <a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> | |
| 208 <h4>PackageDiagramBuilder.__buildModulesDict</h4> | 271 <h4>PackageDiagramBuilder.__buildModulesDict</h4> |
| 209 <b>__buildModulesDict</b>(<i></i>) | 272 <b>__buildModulesDict</b>(<i></i>) |
| 273 | |
| 210 <p> | 274 <p> |
| 211 Private method to build a dictionary of modules contained in the | 275 Private method to build a dictionary of modules contained in the |
| 212 package. | 276 package. |
| 213 </p><dl> | 277 </p> |
| 278 <dl> | |
| 214 <dt>Returns:</dt> | 279 <dt>Returns:</dt> |
| 215 <dd> | 280 <dd> |
| 216 dictionary of modules contained in the package. | 281 dictionary of modules contained in the package. |
| 217 </dd> | 282 </dd> |
| 218 </dl><a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a> | 283 </dl> |
| 284 <a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a> | |
| 219 <h4>PackageDiagramBuilder.__buildSubpackagesDict</h4> | 285 <h4>PackageDiagramBuilder.__buildSubpackagesDict</h4> |
| 220 <b>__buildSubpackagesDict</b>(<i></i>) | 286 <b>__buildSubpackagesDict</b>(<i></i>) |
| 287 | |
| 221 <p> | 288 <p> |
| 222 Private method to build a dictionary of sub-packages contained in this | 289 Private method to build a dictionary of sub-packages contained in this |
| 223 package. | 290 package. |
| 224 </p><dl> | 291 </p> |
| 292 <dl> | |
| 225 <dt>Returns:</dt> | 293 <dt>Returns:</dt> |
| 226 <dd> | 294 <dd> |
| 227 dictionary of sub-packages contained in this package | 295 dictionary of sub-packages contained in this package |
| 228 </dd> | 296 </dd> |
| 229 </dl><a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a> | 297 </dl> |
| 298 <a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a> | |
| 230 <h4>PackageDiagramBuilder.__createAssociations</h4> | 299 <h4>PackageDiagramBuilder.__createAssociations</h4> |
| 231 <b>__createAssociations</b>(<i>routes</i>) | 300 <b>__createAssociations</b>(<i>routes</i>) |
| 301 | |
| 232 <p> | 302 <p> |
| 233 Private method to generate the associations between the class shapes. | 303 Private method to generate the associations between the class shapes. |
| 234 </p><dl> | 304 </p> |
| 305 <dl> | |
| 306 | |
| 235 <dt><i>routes</i></dt> | 307 <dt><i>routes</i></dt> |
| 236 <dd> | 308 <dd> |
| 237 list of relationsships | 309 list of relationsships |
| 238 </dd> | 310 </dd> |
| 239 </dl><a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a> | 311 </dl> |
| 312 <a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a> | |
| 240 <h4>PackageDiagramBuilder.__getCurrentShape</h4> | 313 <h4>PackageDiagramBuilder.__getCurrentShape</h4> |
| 241 <b>__getCurrentShape</b>(<i>name</i>) | 314 <b>__getCurrentShape</b>(<i>name</i>) |
| 315 | |
| 242 <p> | 316 <p> |
| 243 Private method to get the named shape. | 317 Private method to get the named shape. |
| 244 </p><dl> | 318 </p> |
| 319 <dl> | |
| 320 | |
| 245 <dt><i>name</i></dt> | 321 <dt><i>name</i></dt> |
| 246 <dd> | 322 <dd> |
| 247 name of the shape (string) | 323 name of the shape (string) |
| 248 </dd> | 324 </dd> |
| 249 </dl><dl> | 325 </dl> |
| 326 <dl> | |
| 250 <dt>Returns:</dt> | 327 <dt>Returns:</dt> |
| 251 <dd> | 328 <dd> |
| 252 shape (QCanvasItem) | 329 shape (QCanvasItem) |
| 253 </dd> | 330 </dd> |
| 254 </dl><a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a> | 331 </dl> |
| 332 <a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a> | |
| 255 <h4>PackageDiagramBuilder.buildDiagram</h4> | 333 <h4>PackageDiagramBuilder.buildDiagram</h4> |
| 256 <b>buildDiagram</b>(<i></i>) | 334 <b>buildDiagram</b>(<i></i>) |
| 335 | |
| 257 <p> | 336 <p> |
| 258 Public method to build the class shapes of the package diagram. | 337 Public method to build the class shapes of the package diagram. |
| 259 </p><p> | 338 </p> |
| 339 <p> | |
| 260 The algorithm is borrowed from Boa Constructor. | 340 The algorithm is borrowed from Boa Constructor. |
| 261 </p><a NAME="PackageDiagramBuilder.getPersistenceData" ID="PackageDiagramBuilder.getPersistenceData"></a> | 341 </p> |
| 342 <a NAME="PackageDiagramBuilder.getPersistenceData" ID="PackageDiagramBuilder.getPersistenceData"></a> | |
| 262 <h4>PackageDiagramBuilder.getPersistenceData</h4> | 343 <h4>PackageDiagramBuilder.getPersistenceData</h4> |
| 263 <b>getPersistenceData</b>(<i></i>) | 344 <b>getPersistenceData</b>(<i></i>) |
| 345 | |
| 264 <p> | 346 <p> |
| 265 Public method to get a string for data to be persisted. | 347 Public method to get a string for data to be persisted. |
| 266 </p><dl> | 348 </p> |
| 349 <dl> | |
| 267 <dt>Returns:</dt> | 350 <dt>Returns:</dt> |
| 268 <dd> | 351 <dd> |
| 269 persisted data string (string) | 352 persisted data string (string) |
| 270 </dd> | 353 </dd> |
| 271 </dl><a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a> | 354 </dl> |
| 355 <a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a> | |
| 272 <h4>PackageDiagramBuilder.initialize</h4> | 356 <h4>PackageDiagramBuilder.initialize</h4> |
| 273 <b>initialize</b>(<i></i>) | 357 <b>initialize</b>(<i></i>) |
| 358 | |
| 274 <p> | 359 <p> |
| 275 Public method to initialize the object. | 360 Public method to initialize the object. |
| 276 </p><a NAME="PackageDiagramBuilder.parsePersistenceData" ID="PackageDiagramBuilder.parsePersistenceData"></a> | 361 </p> |
| 362 <a NAME="PackageDiagramBuilder.parsePersistenceData" ID="PackageDiagramBuilder.parsePersistenceData"></a> | |
| 277 <h4>PackageDiagramBuilder.parsePersistenceData</h4> | 363 <h4>PackageDiagramBuilder.parsePersistenceData</h4> |
| 278 <b>parsePersistenceData</b>(<i>version, data</i>) | 364 <b>parsePersistenceData</b>(<i>version, data</i>) |
| 365 | |
| 279 <p> | 366 <p> |
| 280 Public method to parse persisted data. | 367 Public method to parse persisted data. |
| 281 </p><dl> | 368 </p> |
| 369 <dl> | |
| 370 | |
| 282 <dt><i>version</i></dt> | 371 <dt><i>version</i></dt> |
| 283 <dd> | 372 <dd> |
| 284 version of the data (string) | 373 version of the data (string) |
| 285 </dd><dt><i>data</i></dt> | 374 </dd> |
| 375 <dt><i>data</i></dt> | |
| 286 <dd> | 376 <dd> |
| 287 persisted data to be parsed (string) | 377 persisted data to be parsed (string) |
| 288 </dd> | 378 </dd> |
| 289 </dl><dl> | 379 </dl> |
| 380 <dl> | |
| 290 <dt>Returns:</dt> | 381 <dt>Returns:</dt> |
| 291 <dd> | 382 <dd> |
| 292 flag indicating success (boolean) | 383 flag indicating success (boolean) |
| 293 </dd> | 384 </dd> |
| 294 </dl> | 385 </dl> |
