← 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/action/ConnectDecorator.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/action/ConnectDecorator.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.action;
 
42
 
 
43
import org.netbeans.api.visual.anchor.Anchor;
 
44
import org.netbeans.api.visual.widget.ConnectionWidget;
 
45
import org.netbeans.api.visual.widget.Scene;
 
46
import org.netbeans.api.visual.widget.Widget;
 
47
 
 
48
import java.awt.*;
 
49
 
 
50
/**
 
51
 * This interface decorates a connect action.
 
52
 *
 
53
 * @author David Kaspar
 
54
 */
 
55
public interface ConnectDecorator {
 
56
 
 
57
    /**
 
58
     * Creates a connection widget that is temporarily used for visualization of a connection while user is dragging (creating) it.
 
59
     * @param scene the scene where the connection widget will be used
 
60
     * @return the connection widget
 
61
     */
 
62
    ConnectionWidget createConnectionWidget (Scene scene);
 
63
 
 
64
    /**
 
65
     * Creates a source anchor for a specified source widget. The anchor will be used at the temporary connection widget created by the createConnectionWidget method.
 
66
     * @param sourceWidget the source widget
 
67
     * @return the source anchor
 
68
     */
 
69
    Anchor createSourceAnchor (Widget sourceWidget);
 
70
 
 
71
    /**
 
72
     * Creates a target anchor for a specified target widget. The anchor will be used at the temporary connection widget created by the createConnectionWidget method.
 
73
     * @param targetWidget the source widget
 
74
     * @return the target anchor
 
75
     */
 
76
    Anchor createTargetAnchor (Widget targetWidget);
 
77
 
 
78
    /**
 
79
     * Creates a floating anchor which will be used when the connection target is not attached to any widget. The anchor will be used at the temporary connection widget created by the createConnectionWidget method.
 
80
     * @param location the scene location of the mouse cursor
 
81
     * @return the floating anchor; usually FixedAnchor
 
82
     */
 
83
    Anchor createFloatAnchor (Point location);
 
84
 
 
85
}