← 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/ConnectProvider.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/ConnectProvider.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.widget.Widget;
 
44
import org.netbeans.api.visual.widget.Scene;
 
45
 
 
46
import java.awt.*;
 
47
 
 
48
/**
 
49
 * This interface controls a connect action.
 
50
 *
 
51
 * @author David Kaspar
 
52
 */
 
53
public interface ConnectProvider {
 
54
 
 
55
    /**
 
56
     * Called for checking whether a specified source widget is a possible source of a connection.
 
57
     * @param sourceWidget the source widget
 
58
     * @return if true, then it is possible to create a connection for the source widget; if false, then is not allowed
 
59
     */
 
60
    boolean isSourceWidget (Widget sourceWidget);
 
61
 
 
62
    /**
 
63
     * Called for checking whether a connection could be created between a specified source and target widget.
 
64
     * Called only when a hasCustomTargetWidgetResolver returns false.
 
65
     * @param sourceWidget the source widget
 
66
     * @param targetWidget the target widget
 
67
     * @return the connector state
 
68
     */
 
69
    ConnectorState isTargetWidget (Widget sourceWidget, Widget targetWidget);
 
70
 
 
71
    /**
 
72
     * Called to check whether the provider has a custom target widget resolver.
 
73
     * @param scene the scene where the resolver will be called
 
74
     * @return if true, then the resolveTargetWidget method is called for resolving the target widget;
 
75
     *         if false, then the isTargetWidget method is called for resolving the target widget
 
76
     */
 
77
    boolean hasCustomTargetWidgetResolver (Scene scene);
 
78
 
 
79
    /**
 
80
     * Called to find the target widget of a possible connection.
 
81
     * Called only when a hasCustomTargetWidgetResolver returns true.
 
82
     * @param scene the scene
 
83
     * @param sceneLocation the scene location
 
84
     * @return the target widget; null if no target widget found
 
85
     */
 
86
    Widget resolveTargetWidget (Scene scene, Point sceneLocation);
 
87
 
 
88
    /**
 
89
     * Called for creating a new connection between a specified source and target widget.
 
90
     * This method is called only when the possible connection is available and an user approves its creation.
 
91
     * @param sourceWidget the source widget
 
92
     * @param targetWidget the target widget
 
93
     */
 
94
    void createConnection (Widget sourceWidget, Widget targetWidget);
 
95
 
 
96
}