| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ClassdiagramEdge |
|
| 1.0;1 |
| 1 | /* $Id: ClassdiagramEdge.java 17863 2010-01-12 20:07:22Z linus $ | |
| 2 | ***************************************************************************** | |
| 3 | * Copyright (c) 2009 Contributors - see below | |
| 4 | * All rights reserved. This program and the accompanying materials | |
| 5 | * are made available under the terms of the Eclipse Public License v1.0 | |
| 6 | * which accompanies this distribution, and is available at | |
| 7 | * http://www.eclipse.org/legal/epl-v10.html | |
| 8 | * | |
| 9 | * Contributors: | |
| 10 | * tfmorris | |
| 11 | ***************************************************************************** | |
| 12 | * | |
| 13 | * Some portions of this file was previously release using the BSD License: | |
| 14 | */ | |
| 15 | ||
| 16 | // Copyright (c) 1996-2006 The Regents of the University of California. All | |
| 17 | // Rights Reserved. Permission to use, copy, modify, and distribute this | |
| 18 | // software and its documentation without fee, and without a written | |
| 19 | // agreement is hereby granted, provided that the above copyright notice | |
| 20 | // and this paragraph appear in all copies. This software program and | |
| 21 | // documentation are copyrighted by The Regents of the University of | |
| 22 | // California. The software program and documentation are supplied "AS | |
| 23 | // IS", without any accompanying services from The Regents. The Regents | |
| 24 | // does not warrant that the operation of the program will be | |
| 25 | // uninterrupted or error-free. The end-user understands that the program | |
| 26 | // was developed for research purposes and is advised not to rely | |
| 27 | // exclusively on the program for any reason. IN NO EVENT SHALL THE | |
| 28 | // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, | |
| 29 | // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, | |
| 30 | // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF | |
| 31 | // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF | |
| 32 | // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY | |
| 33 | // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
| 34 | // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE | |
| 35 | // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF | |
| 36 | // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, | |
| 37 | // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | |
| 38 | ||
| 39 | package org.argouml.uml.diagram.static_structure.layout; | |
| 40 | ||
| 41 | import org.argouml.uml.diagram.layout.LayoutedEdge; | |
| 42 | import org.tigris.gef.presentation.Fig; | |
| 43 | import org.tigris.gef.presentation.FigEdge; | |
| 44 | import org.tigris.gef.presentation.FigPoly; | |
| 45 | ||
| 46 | /** This class is an abstract implementation of all edges which are | |
| 47 | * layoutable in the classdiagram. | |
| 48 | * @author Markus Klink | |
| 49 | * @since 0.11.1 | |
| 50 | */ | |
| 51 | public abstract class ClassdiagramEdge implements LayoutedEdge { | |
| 52 | ||
| 53 | /** the layout is oriented on a grid. These are our grid spaces. | |
| 54 | */ | |
| 55 | private static int vGap; | |
| 56 | private static int hGap; | |
| 57 | ||
| 58 | ||
| 59 | 0 | private FigEdge currentEdge = null; |
| 60 | /** the underlying fig of the edge we want to layout */ | |
| 61 | 0 | private FigPoly underlyingFig = null; |
| 62 | ||
| 63 | /** each fig has a source and a destination port | |
| 64 | */ | |
| 65 | private Fig destFigNode; | |
| 66 | private Fig sourceFigNode; | |
| 67 | ||
| 68 | ||
| 69 | /** Constructor. | |
| 70 | * @param edge the Edge to layout | |
| 71 | */ | |
| 72 | 0 | public ClassdiagramEdge(FigEdge edge) { |
| 73 | 0 | currentEdge = edge; |
| 74 | 0 | underlyingFig = new FigPoly(); |
| 75 | 0 | underlyingFig.setLineColor(edge.getFig().getLineColor()); |
| 76 | ||
| 77 | 0 | destFigNode = edge.getDestFigNode(); |
| 78 | 0 | sourceFigNode = edge.getSourceFigNode(); |
| 79 | 0 | } |
| 80 | ||
| 81 | /** | |
| 82 | * Abstract method to layout the edge. | |
| 83 | * | |
| 84 | * @see org.argouml.uml.diagram.layout.LayoutedEdge#layout() | |
| 85 | */ | |
| 86 | public abstract void layout(); | |
| 87 | ||
| 88 | /** | |
| 89 | * @param h the horizontal gap | |
| 90 | */ | |
| 91 | 0 | public static void setHGap(int h) { hGap = h; } |
| 92 | ||
| 93 | /** | |
| 94 | * @param v the vertical gap | |
| 95 | */ | |
| 96 | 0 | public static void setVGap(int v) { vGap = v; } |
| 97 | ||
| 98 | /** | |
| 99 | * @return the horizontal gap | |
| 100 | */ | |
| 101 | 0 | public static int getHGap() { return hGap; } |
| 102 | ||
| 103 | /** | |
| 104 | * @return the vertical gap | |
| 105 | */ | |
| 106 | 0 | public static int getVGap() { return vGap; } |
| 107 | ||
| 108 | /** | |
| 109 | * @return Returns the destFigNode. | |
| 110 | */ | |
| 111 | Fig getDestFigNode() { | |
| 112 | 0 | return destFigNode; |
| 113 | } | |
| 114 | ||
| 115 | /** | |
| 116 | * @return Returns the sourceFigNode. | |
| 117 | */ | |
| 118 | Fig getSourceFigNode() { | |
| 119 | 0 | return sourceFigNode; |
| 120 | } | |
| 121 | ||
| 122 | /** | |
| 123 | * @return Returns the currentEdge. | |
| 124 | */ | |
| 125 | protected FigEdge getCurrentEdge() { | |
| 126 | 0 | return currentEdge; |
| 127 | } | |
| 128 | ||
| 129 | /** | |
| 130 | * @return Returns the underlyingFig. | |
| 131 | */ | |
| 132 | protected FigPoly getUnderlyingFig() { | |
| 133 | 0 | return underlyingFig; |
| 134 | } | |
| 135 | } | |
| 136 |