org.netbeans.api.visual.router.Router Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-api-visual Show documentation

There is a newer version: RELEASE230

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.api.visual.router;

import org.netbeans.api.visual.widget.ConnectionWidget;

import java.awt.*;
import java.util.List;

/**
 * This class is responsible for routing path of connection widgets.
 * Built-in routers could be created by RouterFactory class. Routers are assigned to connection widgets using
 * ConnectionWidget.setRouter method.
 *
 * @author David Kaspar
 */
public interface Router {

    /**
     * Routes a path for a connection widget. The path is specified by a list of control points.
     * @param widget the connection widget
     * @return the list of control points
     */
    public List routeConnection (ConnectionWidget widget);

}