"test.routing.ActionsWithRoutingPolicyTest",

        "test.routing.RoutingPolicyTest",

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package test.routing;

import org.netbeans.api.visual.action.ActionFactory;

import org.netbeans.api.visual.anchor.AnchorFactory;

import org.netbeans.api.visual.anchor.AnchorShape;

import org.netbeans.api.visual.anchor.PointShape;

import org.netbeans.api.visual.border.BorderFactory;

import org.netbeans.api.visual.router.RouterFactory;

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

import test.SceneSupport;

import javax.swing.*;

import java.awt.*;

import java.awt.event.ActionEvent;

/**

 * @author David Kaspar

 */

public class ActionsWithRoutingPolicyTest extends Scene {

    private LayerWidget mainLayer;

    private ConnectionWidget connection;

    public ActionsWithRoutingPolicyTest () {

        mainLayer = new LayerWidget (this);

        addChild (mainLayer);

        LayerWidget connLayer = new LayerWidget (this);

        addChild (connLayer);

        Widget source = createLabel ("Source", 50, 200, Color.GREEN);

        Widget target = createLabel ("Target", 450, 200, Color.GREEN);

        connection = new ConnectionWidget (this);

        connection.setSourceAnchor (AnchorFactory.createDirectionalAnchor (source, AnchorFactory.DirectionalAnchorKind.HORIZONTAL));

        connection.setTargetAnchor (AnchorFactory.createDirectionalAnchor (target, AnchorFactory.DirectionalAnchorKind.HORIZONTAL));

        connection.setTargetAnchorShape (AnchorShape.TRIANGLE_FILLED);

        connection.setPaintControlPoints (true);

        connection.setControlPointShape (PointShape.SQUARE_FILLED_BIG);

        connection.setRouter (RouterFactory.createOrthogonalSearchRouter (mainLayer));

        connection.getActions ().addAction (ActionFactory.createAddRemoveControlPointAction (1.0, 5.0, ConnectionWidget.RoutingPolicy.UPDATE_END_POINTS_ONLY));

        connection.getActions ().addAction (ActionFactory.createMoveControlPointAction (ActionFactory.createFreeMoveControlPointProvider (), ConnectionWidget.RoutingPolicy.UPDATE_END_POINTS_ONLY));

        connLayer.addChild (connection);

    }

    private Widget createLabel (String text, int x, int y, Color color) {

        LabelWidget label = new LabelWidget (this, text);

        label.setOpaque (true);

        label.setBackground (color);

        label.setBorder (BorderFactory.createLineBorder (5));

        label.setPreferredLocation (new Point (x, y));

        label.getActions ().addAction (ActionFactory.createMoveAction ());

        mainLayer.addChild (label);

        return label;

    }

    private JComponent createPanel () {

        JPanel panel = new JPanel ();

        panel.setLayout (new BorderLayout ());

        JToolBar bar = new JToolBar ();

        bar.add (new AbstractAction("Force Rerouting") {

            public void actionPerformed (ActionEvent e) {

                connection.reroute ();

                validate ();

            }

        });

        bar.addSeparator ();

        bar.add (new AbstractAction("Reset routing policy to always-route") {

            public void actionPerformed (ActionEvent e) {

                connection.setRoutingPolicy (ConnectionWidget.RoutingPolicy.ALWAYS_ROUTE);

                validate ();

            }

        });

        panel.add (bar, BorderLayout.NORTH);

        panel.add (createView (), BorderLayout.CENTER);

        return panel;

    }

    public static void main (String[] args) {

        SceneSupport.show (new ActionsWithRoutingPolicyTest ().createPanel ());

    }

}

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package test.routing;

import org.netbeans.api.visual.action.ActionFactory;

import org.netbeans.api.visual.anchor.AnchorFactory;

import org.netbeans.api.visual.anchor.AnchorShape;

import org.netbeans.api.visual.anchor.PointShape;

import org.netbeans.api.visual.border.BorderFactory;

import org.netbeans.api.visual.router.RouterFactory;

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

import test.SceneSupport;

import javax.swing.*;

import java.awt.*;

import java.awt.event.ActionEvent;

/**

 * @author David Kaspar

 */

public class RoutingPolicyTest extends Scene {

    private LayerWidget mainLayer;

    private ConnectionWidget connection;

    public RoutingPolicyTest () {

        mainLayer = new LayerWidget (this);

        addChild (mainLayer);

        LayerWidget connLayer = new LayerWidget (this);

        addChild (connLayer);

        createLabel ("Buttons in toolbar", 200, 100, Color.YELLOW);

        createLabel ("allows you to switch", 200, 130, Color.YELLOW);

        createLabel ("routing policy of the connection widget.", 200, 160, Color.YELLOW);

        createLabel ("Try double-clicking on the connection widget.", 200, 250, Color.CYAN);

        createLabel ("Try dragging control points of the connection widget.", 200, 280, Color.CYAN);

        createLabel ("Try force re-routing of the connection widget.", 200, 310, Color.CYAN);

        Widget source = createLabel ("Source", 50, 200, Color.GREEN);

        Widget target = createLabel ("Target", 450, 200, Color.GREEN);

        connection = new ConnectionWidget (this);

        connection.setSourceAnchor (AnchorFactory.createDirectionalAnchor (source, AnchorFactory.DirectionalAnchorKind.HORIZONTAL));

        connection.setTargetAnchor (AnchorFactory.createDirectionalAnchor (target, AnchorFactory.DirectionalAnchorKind.HORIZONTAL));

        connection.setTargetAnchorShape (AnchorShape.TRIANGLE_FILLED);

        connection.setPaintControlPoints (true);

        connection.setControlPointShape (PointShape.SQUARE_FILLED_BIG);

        connection.setRouter (RouterFactory.createOrthogonalSearchRouter (mainLayer));

        connection.getActions ().addAction (ActionFactory.createAddRemoveControlPointAction ());

        connection.getActions ().addAction (ActionFactory.createFreeMoveControlPointAction ());

        connLayer.addChild (connection);

    }

    private Widget createLabel (String text, int x, int y, Color color) {

        LabelWidget label = new LabelWidget (this, text);

        label.setOpaque (true);

        label.setBackground (color);

        label.setBorder (BorderFactory.createLineBorder (5));

        label.setPreferredLocation (new Point (x, y));

        label.getActions ().addAction (ActionFactory.createMoveAction ());

        mainLayer.addChild (label);

        return label;

    }

    private JComponent createPanel () {

        JPanel panel = new JPanel ();

        panel.setLayout (new BorderLayout ());

        JToolBar bar = new JToolBar ();

        bar.add (new AbstractAction("Force Rerouting") {

            public void actionPerformed (ActionEvent e) {

                connection.reroute ();

                validate ();

            }

        });

        bar.addSeparator ();

        bar.add (new JLabel ("Switch routing policy:"));

        bar.add (new AbstractAction("Always Route") {

            public void actionPerformed (ActionEvent e) {

                connection.setRoutingPolicy (ConnectionWidget.RoutingPolicy.ALWAYS_ROUTE);

                validate ();

            }

        });

        bar.add (new AbstractAction("Update End Points Only") {

            public void actionPerformed (ActionEvent e) {

                connection.setRoutingPolicy (ConnectionWidget.RoutingPolicy.UPDATE_END_POINTS_ONLY);

                validate ();

            }

        });

        bar.add (new AbstractAction("Disable Routing Until End Point is Moved") {

            public void actionPerformed (ActionEvent e) {

                connection.setRoutingPolicy (ConnectionWidget.RoutingPolicy.DISABLE_ROUTING_UNTIL_END_POINT_IS_MOVED);

                validate ();

            }

        });

        bar.add (new AbstractAction("Disable Routing") {

            public void actionPerformed (ActionEvent e) {

                connection.setRoutingPolicy (ConnectionWidget.RoutingPolicy.DISABLE_ROUTING);

                validate ();

            }

        });

        panel.add (bar, BorderLayout.NORTH);

        panel.add (createView (), BorderLayout.CENTER);

        return panel;

    }

    public static void main (String[] args) {

        SceneSupport.show (new RoutingPolicyTest ().createPanel ());

    }

}

        <change>

            <api name="general"/>

            <summary>Routing policy support for ConnectionWidget</summary>

            <version major="2" minor="9"/>

            <date day="23" month="8" year="2007"/>

            <author login="dkaspar"/>

            <compatibility addition="yes"/>

            <description>

                ConnectionWidget allows to specify routing policy. The policy defines behaviour of path routing in ConnectionWidget.

                There are 4 values: Always-route, Update-end-points-only, Disable-routing-until-end-point-is-moved, Disable-routing.

                AddRemoveControlPointAction and MoveControlPointAction has new factory methods for automatic assignment of routing policy.

            </description>

            <class package="org.netbeans.api.visual.widget" name="ConnectionWidget" link="yes"/>

            <issue number="113573"/>

        </change>

        return createMoveControlPointAction (provider, null);

    }

    /**

     * Creates a move control point (of a connection widget) action with a specified provider.

     * @param provider the move control point provider

     * @param routingPolicy the routing policy that is automatically set to a connection widget with control points modified by this action;

     *     if null, then routing policy is not set

     * @return the move control point action

     * @since 2.9

     */

    public static WidgetAction createMoveControlPointAction (MoveControlPointProvider provider, ConnectionWidget.RoutingPolicy routingPolicy) {

    /**

     * This enum represents a policy which is used for re-routing control points of a ConnectionWidget.

     * @since 2.9

     */

    public enum RoutingPolicy {

        /**

         * All control points are rerouted when it is necessary. This is the default policy.

         * @since 2.9

         */

        ALWAYS_ROUTE,

        /**

         * All control points (except end points) are kept at the same location.

         * End points are updated to locations resolved by source and target anchors.

         * Note: This is used when an user customizes/adds/removes control points

         * and the change has to be kept until it is reset by the user (setting policy to ALWAYS_ROUTE.

         * @since 2.9

         */

        UPDATE_END_POINTS_ONLY,

        /**

         * Temporarily disables routing until any end point changes its location. Locations are the first

         * and the last point of control points. When an end point location is changed,

         * then the policy is automatically changed to <code>ALWAYS_ROUTE</code>.

         * Note: This is used by GraphLayouts which routes the path (control points)

         * by themselves and would like to keep the path until user moves with source or target widget/anchor.

         * @since 2.9

         */

        DISABLE_ROUTING_UNTIL_END_POINT_IS_MOVED,

        /**

         * Disable routing completely, so control points are kept at their previous location.

         * Note: This is not often used unless you have to freeze a ConnectionWidget

         * @since 2.9

         */

        DISABLE_ROUTING

    }

    private RoutingPolicy routingPolicy;

        routingPolicy = RoutingPolicy.ALWAYS_ROUTE;

     * Returns a routing policy.

     * @return the routing policy

     * @since 2.9

     */

    public final RoutingPolicy getRoutingPolicy () {

        return routingPolicy;

    }

    /**

     * Sets a routing policy. It invokes re-routing in case of routing policy change unless its is changed to DISABLE_ROUTING.

     * @param routingPolicy the new routing policy

     * @since 2.9

     */

    public final void setRoutingPolicy (RoutingPolicy routingPolicy) {

        assert routingPolicy != null;

        if (this.routingPolicy == routingPolicy)

            return;

        boolean changed = routingPolicy != RoutingPolicy.DISABLE_ROUTING;

        this.routingPolicy = routingPolicy;

        if (changed)

            reroute ();

    }

    /**

<li><a href="#RoutingPolicy">Routing Policy</a>

<h3><a name="RoutingPolicy">Routing Policy</a></h3>

Since version 2.9, the ConnectionWidget class has additional <code>routingPolicy</code> property. It ease management of control points changed by users. There are 4 values:

<ol>

<li><code>ALWAYS_ROUTE</code> - This is default value. The router is always invoked when a ConnectionWidget is changed and needs to be re-routed.

<li><code>UPDATE_END_POINTS_ONLY</code> - The router is not invoked. Instead location of the first and the last control points are changed/updated to location computed by source and target anchors.

<li><code>DISABLE_ROUTING_UNTIL_END_POINT_IS_MOVED</code> - The router is not invoked until the first or the last control points is moved (means it has different location from one computed by source or target anchor).

<li><code>DISABLE_ROUTING</code> - The router is not invoked. The control points are freezed at the same locations.

</ol>

These routing policy are very useful when you are using modifying control points:

<ul>

<li>You can specify <code>routingPolicy</code> value to factory method of <code>AddRemoveControlPointAction</code> and <code>MoveControlPointAction</code>. If not null, then the value is automatically set to a ConnectionWidget which control points are modified by the action. Usually <code>UPDATE_END_POINT_ONLY</code> is used.

<li>Some graph-oriented layout algorithms are resolving not only location of nodes on a scene but also routes path of edges. Then you can use <code>UPDATE_END_POINT_ONLY</code> or <code>DISABLE_ROUTING_UNTIL_END_POINT_IS_MOVED</code> to prevent discard of paths routed by the graph-oriented layout.

For usages, see <code>test.routing.ActionsWithRoutingPolicyTest</code> and <code>test.routing.RoutingPolicyTest</code> examples.

<tr>

<td>getRoutingPolicy<br>setRoutingPolicy

<td>Controls a routing policy assigned to the connection widget. It controls whether and how control points are re-routed. For details, see <a href="#RoutingPolicy">Routing Policy</a> section.

import java.awt.*;

        this.routingPolicy = routingPolicy;

     * @param widget the connection widget

                exPoint = elem;

                index++;

    private ConnectionWidget.RoutingPolicy routingPolicy;

        this.routingPolicy = routingPolicy;

        if (routingPolicy != null)

            movingWidget.setRoutingPolicy (routingPolicy);

<li><strong>test.routing.ActionsWithRoutingPolicyTest</strong> - how to use routing policy with <code>AddRemoveControlPointAction</code> and <code>MoveControlPointAction</code>

<li><strong>test.routing.RoutingPolicyTest</strong> - how to use routing policy of <code>ConnectionWidget</code>