← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to graph/lib/src/org/netbeans/api/visual/anchor/AnchorShape.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
graph/lib/src/org/netbeans/api/visual/anchor/AnchorShape.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
package org.netbeans.api.visual.anchor;
 
42
 
 
43
import org.netbeans.modules.visual.anchor.TriangleAnchorShape;
 
44
 
 
45
import java.awt.*;
 
46
 
 
47
/**
 
48
 * Represents an anchor shape which is rendered at the source and the target point of a connection widget where the shape is used.
 
49
 * The same instance of a shape could be shared by multiple connection widgets.
 
50
 * @author David Kaspar
 
51
 */
 
52
public interface AnchorShape {
 
53
 
 
54
    /**
 
55
     * Returns whether the shape is oriented by the line path of a connection.
 
56
     * @return true if it is line-oriented
 
57
     */
 
58
    public boolean isLineOriented ();
 
59
 
 
60
    /**
 
61
     * Returns a radius of a shape that the shape used for rendering.
 
62
     * @return the radius
 
63
     */
 
64
    public int getRadius ();
 
65
 
 
66
    /**
 
67
     * Returns a distance by which a line at particular source or target point should be cut (not rendered).
 
68
     * This is used for hollow-triangle shapes, to not paint the connection-line within the triangle.
 
69
     * @return the cut distance in pixels;
 
70
     *     if positive, then the line is cut by specified number of pixels, the line could be cut by radius pixels only;
 
71
     *     if 0.0, then the line is not cut;
 
72
     *     if negative, then the line is extended by specified number of pixels, the line could be extended by radius pixels only
 
73
     */
 
74
    public double getCutDistance ();
 
75
 
 
76
    /**
 
77
     * Renders the shape into a graphics instance
 
78
     * @param graphics the graphics
 
79
     * @param source true, if the shape is used for a source point; false if the shape is used for a target point.
 
80
     */
 
81
    public void paint (Graphics2D graphics, boolean source);
 
82
 
 
83
    /**
 
84
     * The empty anchor shape.
 
85
     */
 
86
    public static final AnchorShape NONE = new AnchorShape() {
 
87
        public boolean isLineOriented () { return false; }
 
88
        public int getRadius () { return 0; }
 
89
        public double getCutDistance () { return 0; }
 
90
        public void paint (Graphics2D graphics, boolean source) { }
 
91
    };
 
92
 
 
93
    /**
 
94
     * The hollow-triangle anchor shape.
 
95
     */
 
96
    public static final AnchorShape TRIANGLE_HOLLOW = new TriangleAnchorShape (12, false, false, true, 12.0);
 
97
 
 
98
    /**
 
99
     * The filled-triangle anchor shape.
 
100
     */
 
101
    public static final AnchorShape TRIANGLE_FILLED = new TriangleAnchorShape (12, true, false, false, 11.0);
 
102
 
 
103
    /**
 
104
     * The output-triangle anchor shape.
 
105
     */
 
106
    public static final AnchorShape TRIANGLE_OUT = new TriangleAnchorShape (12, true, true, false, 11.0);
 
107
 
 
108
}