| <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
| <html xmlns:o xmlns:st1> |
| <head> |
| <title>Package-level Javadoc</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta name="Author" content="IBM"> |
| <!-- |
| |
| /****************************************************************************** |
| * Copyright (c) 2004,2005 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| ****************************************************************************/ |
| |
| --> |
| |
| |
| </head> |
| <body> |
| Notation meta-model primary package. |
| <h2> |
| Package Specification</h2> |
| <P>This package exposes the notation meta-model API which is used to create |
| notation models. These models usually play the model part of a |
| Model-View-Controller (MVC) architecture for diagrams. Notation |
| models reference other business models (eg. UML models) and store |
| information needed for the visualization of these business models in |
| diagrams. One advantage of maintaining two separate models it to |
| allow the business model to be visualized differently with each notation model.</P> |
| <H2>Description of the Notation Meta-Model Classes</H2> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>View Classes</H3> |
| <P class="MsoNormal">The views are the central abstraction in a notation model. |
| View objects reference a business model and contain other notation objects |
| that together hold all the properties needed to visualize that business model. |
| The reason the view object does not have all the properties itself but |
| rather delegates to other abstractions is to allow for easy extension of |
| properties.</P> |
| <H4 class="MsoNormal"><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.1<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>View |
| <o:p></o:p></H4> |
| <P class="MsoNormal">The abstract view class is the super class of all view |
| elements. It extends off EModelElement, which is in the EMF core package. It |
| inherits from EmodelElement the ability to be extensible through annotations. |
| The view class has the following properties: |
| <o:p> </o:p></P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l5 level1 lfo2; tab-stops: list .5in"> |
| A 'visible' property, which determines whether the view is visible or not. |
| <LI class="MsoNormal" style="mso-list: l5 level1 lfo2; tab-stops: list .5in"> |
| A 'type' property, which is a user-defined type for the view |
| <LI class="MsoNormal" style="mso-list: l1 level1 lfo4; tab-stops: list .5in"> |
| An 'element' property, which references an EObject representing a business |
| model element. |
| <LI class="MsoNormal" style="mso-list: l1 level1 lfo4; tab-stops: list .5in"> |
| A 'children' collection property, which is used to compose one or more node |
| views if the view is a container. |
| <LI class="MsoNormal" style="mso-list: l1 level1 lfo4; tab-stops: list .5in"> |
| A 'styles' collection property, which is used to install one or more styles |
| containing various notational properties on the view. The advantages of |
| aggregating styles versus defining their properties directly on the views |
| include the ability for more than one extension to contribute properties at the |
| same time, to simply morphing of views which usually require style changes |
| and to avoid redundancy by installing only those styles that are relevant |
| to the view's context. |
| <LI class="MsoNormal" style="mso-list: l1 level1 lfo4; tab-stops: list .5in"> |
| A 'sourceEdges' collection property, which is a list of zero or |
| more outgoing edges from the view. |
| <o:p> |
| <LI class="MsoNormal" style="mso-list: l1 level1 lfo4; tab-stops: list .5in">A |
| 'targetEdges' collection property, which is a list of zero or |
| more incoming edges to the view.</o:p></LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.2<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Node</H4> |
| <P class="MsoNormal">A node is a view that can composed and laid out in a container |
| view. The node class has the following property:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'layoutConstraint' property, which defines an optional constraint suitable |
| for the container's layout manager. The reason for the aggregate pattern |
| is to give the flexibility to change the layout constraint if the view is moved |
| to another parent with a different layout manager. |
| <o:p> </o:p></LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.3<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Edge</H4> |
| <P class="MsoNormal">An edge is a view that represents a connection between two |
| other views. The edge class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'source' property, which is a reference to the source view of the edge. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'target' property, which is a reference to the target view of the edge. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'sourceAnchor' property, which is an object representing an anchor at the |
| source view. The source anchor must make sense in the context of the source |
| view. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'targetAnchor' property, which is an object representing an anchor at |
| the target view. The target anchor must make sense in the context of |
| the target view. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'bendpoints' property, which is an optional object representing a list |
| of bendpoints constraining the edge routing.</LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.4<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Diagram</H4> |
| <P class="MsoNormal">A diagram is a view that represents the top level |
| containment of views. The diagram class has the following properties:</P> |
| <UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'name' property, which is the name of the diagram. |
| </LI> |
| </UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"><SPAN style="FONT: 7pt 'Times New Roman'"><STRONG><FONT size="4">2.</FONT></STRONG> |
| </SPAN> |
| </SPAN> |
| </SPAN>Style classes</H3> |
| <P class="MsoNormal">A style is an object containing properties |
| that affect the visualization of a view. An instance of a style class is |
| created and stored in the 'styles' collection of a view instance.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.1<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Style</H4> |
| <P class="MsoNormal">The style interface captures the concept of a style.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.2<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>FillStyle</H4> |
| <P class="MsoNormal">The fill style is a style to specify the fill properties of a |
| node. The class has the following property:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'fillColor' property, which specifies the fill color or the background color |
| of figures.</LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.3<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>LineStyle</H4> |
| <P class="MsoNormal">The line style is a style to be installed on views with lines. |
| The class has the following property:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'lineColor' property, which specifies the line color (the foreground) color |
| of figures.</LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.4<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>FontStyle</H4> |
| <P class="MsoNormal">The font style is a style to be installed on views with |
| text. The class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'fontColor' property, which specifies the font color. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'fontName property, which specifies the name of the desired font. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'fontHeight' property, which specifies the height of the desired font. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'bold' property, which specifies whether the font style is bold. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| An 'italic' property, which specifies whether the font style is italic. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| An 'underline' property, which specifies whether the font style is underline. |
| <LI class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| A 'strikeThrough' property, which specifies whether the font style is |
| strike-through.</LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.5<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>RoutingStyle</H4></H4> |
| <P class="MsoNormal">The routing style is a style to be installed on edges to guide |
| their routing. The class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'routing' property, which specifies the desired routing algorithm. The |
| different algorithms are defined by the 'Routing' enumeration as follows: |
| <UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| MANUAL |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| RECTILINEAR |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| TREE</LI></UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'smoothness' property, which specifies the smoothness kind of the edge's |
| route. The kinds are defined by the 'Smoothness' enumeration as follows: |
| <UL style="MARGIN-TOP: 0in" type="circle"> |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| NONE: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| <st1:City> |
| <st1:place>NORMAL</st1:place> |
| </st1:City>: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| LESS: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| MORE:</LI></UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| An 'avoidObstructions' property, which specifies whether the edge's router |
| should try to avoid obstructions. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'closestDistance' property, which specifies whether the edge's router should |
| try to route based on the closest distance. |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'jumpLinskStatus' property, which specifies what the edge's router does when |
| it crosses another edge during routing. The values of the property are defined |
| in the 'JumpLinkStatus' enumeration as follows: |
| <UL style="MARGIN-TOP: 0in" type="circle"> |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| NONE: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| ALL: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| BELOW: |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| ABOVE</LI></UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'jumpLinksType' property, which specifies the type of the jump a router takes |
| when it crosses another edge during routing. The values of the property are |
| defined in the 'JumpLinkStatus' enumeration as follows: |
| <UL style="MARGIN-TOP: 0in" type="circle"> |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| SQUARE:</LI></UL> |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| SEMICIRCLE |
| <UL style="MARGIN-TOP: 0in" type="circle"> |
| <LI class="MsoNormal" style="mso-list: l3 level2 lfo3; tab-stops: list 1.0in"> |
| CHAMFERE</LI></UL> |
| <LI class="MsoNormal" style="mso-list: l3 level1 lfo3; tab-stops: list .5in"> |
| A 'jumpLinksReverse' property, which specifies whether the router should |
| reverse the jump links a router takes when it crosses another edge during |
| router.</LI></UL> |
| </SPAN></SPAN> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.6<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>DescriptionStyle</H4></H4> |
| <P class="MsoNormal">The description style is a style to be installed on views to |
| give them description texts. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'description ' property, which specifies the notational description text owned |
| by the view.</SPAN></SPAN></DIV> |
| </LI> |
| </UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.7<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>DrawerStyle</H4> |
| <H4></H4> |
| <P class="MsoNormal">The drawer style is a style to be installed on nodes that can |
| be collapsed like a drawer. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'collapsed' property, which specifies whether a node is collapsed or |
| not</DIV> |
| </LI> |
| </UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.8<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>TitleStyle</H4> |
| <H4></H4> |
| <P class="MsoNormal">The title style is a style to be installed on views that |
| have a title. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'showTitle' property, which specifies whether the view's title is visible or |
| not. |
| <o:p> </o:p></DIV> |
| </LI> |
| </UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.9<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>SortingStyle</H4></H3> |
| <P>The sorting style is a style to be installed on nodes representing lists to |
| be sorted. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'sorting' property, which specifies the type of sorting applied. The |
| values of the property is defined in the 'Sorting' enumeration as follows:</DIV> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">None</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Manual</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Automatic</DIV> |
| </LI> |
| </UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'sortedObjects' collection property, which is used in the Manual case |
| to reference the sorted objects in sequence.</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'sortingKeys' property, which is a java map used in |
| the Automatic case to map a sequence of sorting keys to sorting |
| directions. While sorting keys are strings, sorting directions are defined by |
| the 'SortingDirection' enumeration as follows:</DIV> |
| </o:p></DIV> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Ascending</DIV> |
| </o:p></DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Descending</o:p></SPAN></SPAN></DIV> |
| </DIV></LI></UL> |
| </LI> |
| </UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.10<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>FilteringStyle</H4></H3> |
| <P>The filtering style is a style to be installed on nodes representing lists |
| to be filtered. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'filteing' property, which specifies the type of filtering applied. The |
| values of the property is defined in the 'Filtering' enumeration as follows:</DIV> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">None</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Manual</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">Automatic</DIV> |
| </LI> |
| </UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'filteredObjects' collection property, which is used in the Manual case |
| to reference the filtered objects.</DIV> |
| <o:p> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'filteringKeys' property, which is a java list used in |
| the Automatic case to list the filtering keys as |
| strings.</o:p></SPAN></SPAN><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"></DIV></LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.11<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>CanonicalStyle</H4> |
| <H4></H4> |
| <P class="MsoNormal">The canonical style is a style to be installed on |
| views that need to be |
| <SPAN style="FONT-SIZE: 12pt; FONT-FAMILY: 'Times New Roman'; mso-fareast-font-family: Arial; mso-ansi-language: EN-US; mso-fareast-language: EN-US; mso-bidi-language: AR-SA">synchronized |
| </SPAN> |
| with business model. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'canonical' property, which specifies whether the view's canonical mode is on |
| or off. |
| <o:p> </o:p></DIV> |
| </LI> |
| </UL> |
| </SPAN></SPAN><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.12<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>PageStyle</H4> |
| <H4></H4> |
| <P class="MsoNormal">The page style is a style to be installed on multi-page |
| diagrams. The class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'pageX' property, which specifies the x-origin of the page. |
| <o:p> </o:p></DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'pageY' property, which specifies the y-origin of the page. |
| <o:p> </o:p></DIV> |
| </o:p></DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'pageWidth' property, which specifies the width of the page. |
| <o:p> </o:p></DIV> |
| </o:p></DIV> |
| </o:p></DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in"> |
| <o:p> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'pageHeight' property, which specifies the height in of the page. |
| <o:p> </o:p></DIV> |
| </o:p></DIV> |
| </o:p></DIV> |
| </o:p></DIV> |
| </LI> |
| </UL> |
| </SPAN> |
| </SPAN><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore"> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">2.13<SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN> |
| </SPAN>GuideStyle</H4> |
| <H4></H4> |
| <P class="MsoNormal">The guide style is a style to be installed on diagrams that support |
| guides. A 'Guide' is an object with the following properties:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal">A 'position' property, which specifies the position a long |
| the diagram axis.</DIV> |
| <LI> |
| <DIV class="MsoNormal">A 'nodeMap' property, which is a map of nodes to their |
| alignment in respect to the guide. Alignment values are:</DIV> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal">Left</DIV> |
| <LI> |
| <DIV class="MsoNormal">Right</DIV> |
| <LI> |
| <DIV class="MsoNormal">Center</DIV> |
| <LI> |
| <DIV class="MsoNormal">Top</DIV> |
| <LI> |
| <DIV class="MsoNormal">Bottom</DIV> |
| </LI> |
| </UL> |
| </LI> |
| </UL> |
| <P class="MsoNormal"> The guide style class has the following property:</P> |
| <UL> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A |
| 'horizontalGuides' collection property, which is a collection of horizontal |
| guides on the diagram</DIV> |
| <LI> |
| <DIV class="MsoNormal" style="mso-list: l4 level1 lfo5; tab-stops: list .5in">A</SPAN> |
| </SPAN> 'verticalGuides' collection property, which is a collection of |
| vertical guides on the diagram</SPAN></SPAN></DIV></SPAN></SPAN></LI></UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>LayoutConstraint Classes</H3> |
| <P class="MsoNormal"> |
| Layout constraints are used by layout managers to properly set the |
| location/size/bounds of a node's visuals. Since the layout constraint can be |
| different based on the type of layout manager using it, the composition |
| pattern is used to allow for changing the layout constraint type |
| easily.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.1<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>LayoutConstraint</H4> |
| <P class="MsoNormal"> |
| The layout constraint interface captures the concept of a layout |
| constraint.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.2<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Location</H4> |
| <P class="MsoNormal">The location constraint specifies the position of a node. The |
| class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'x' property, which is a location (or distance) along the x-axis in |
| measurement units. |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'y' property, which is a location (or distance) along the y-axis in |
| measurement units. |
| </LI> |
| </UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.3<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Size</H4> |
| <P class="MsoNormal">The size constraint specifies the extent of a node. The class |
| has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'width' property, which is a distance along the x-axis in measurement units. |
| A value of -1 means there is no specific width and it is up to the layout |
| manager to assign width. |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'height' property, which is a distance along the y-axis in measurement units. |
| A value of -1 means there is no specific height and it is up to the layout |
| manager to assign height.</LI></UL> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.4<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Bounds</H4> |
| <P class="MsoNormal">The bounds constraint specifies the bounds of a node. The |
| class inherits its properties from the super classes 'Location' and 'Size'.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.5<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Ratio</H4> |
| <P class="MsoNormal">The ratio constraint specifies the size ratio of a node in its |
| container. This constraint is suitable for layout algorithms where each child |
| gets a ratio of the container. The class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'value' property, which is a double property representing the ratio. A value |
| of -1 means there is no required ratio and it is up to the layout manager to |
| assign ratio.</LI></UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">4.<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Bendpoints</H3> |
| <P class="MsoNormal"> |
| 'Bendpoints' is a routing constraint installed on edges to suggest that their |
| routing pass through a specific collection of points.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">3.3<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>RelativeBendpoints</H4> |
| <P class="MsoNormal">A type of bendpoints representing a collection of points |
| with relative distances along the x- and y-axis to the source and target |
| views of an edge. The class has the following properties:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'points' property, which is a java list of relative bendpoints. |
| RelativeBendpoint has the following properties: |
| <UL> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'sourceX' property, which is the point's x-axis distance from the point of |
| attach with the source view. |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'sourceY' property, which is the point's y-axis distance from the point of |
| attach with the source view. |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'targetX' property, which is the point's x-axis distance from the point of |
| attach with the target view. |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| A 'targetY' property, which is the point's y-axis distance from the point of |
| attach with the target view.</LI></UL> |
| </LI> |
| </UL> |
| <H3><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.1.6<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>Anchor</H3> |
| <P class="MsoNormal">An anchor is a routing constraint installed on edges to |
| identify where the source/target views should anchor that edge. This abstract |
| class only captures the concept of an anchor without restricting it by |
| properties.</P> |
| <H4><SPAN style="mso-fareast-font-family: Arial; mso-bidi-font-family: Arial"><SPAN style="mso-list: Ignore">1.1.6.1<SPAN style="FONT: 7pt 'Times New Roman'"> |
| </SPAN></SPAN> |
| </SPAN>IdentityAnchor</H4> |
| <P class="MsoNormal">The identity anchor is an anchor constraint which has a unique |
| string id. The class has the following property:</P> |
| <UL style="MARGIN-TOP: 0in" type="disc"> |
| <LI class="MsoNormal" style="mso-list: l2 level1 lfo6; tab-stops: list .5in"> |
| An 'id property, which is a unique string identifying the anchor at the |
| source/target view. The default value is "anchor" (since most views have one |
| anchor)</LI></UL> |
| |
| |
| @canBeSeenBy %partners |
| |
| </body> |
| </html> |
