001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.api.visual.router;
042:
043: import org.netbeans.api.visual.widget.LayerWidget;
044: import org.netbeans.modules.visual.router.DirectRouter;
045: import org.netbeans.modules.visual.router.FreeRouter;
046: import org.netbeans.modules.visual.router.OrthogonalSearchRouter;
047: import org.netbeans.modules.visual.router.WidgetsCollisionCollector;
048:
049: /**
050: * This class creates built-in routers. All implementations can be shared by multiple widgets.
051: *
052: * @author David Kaspar
053: */
054: public final class RouterFactory {
055:
056: private static final Router ROUTER_DIRECT = new DirectRouter();
057: private static final Router ROUTER_FREE = new FreeRouter();
058:
059: private RouterFactory() {
060: }
061:
062: /**
063: * Creates a direct router. The path is direct (single-segment) line between source and target anchor of a connection widget.
064: * The instance can be shared by multiple widgets.
065: * @return the direct router
066: */
067: public static Router createDirectRouter() {
068: return ROUTER_DIRECT;
069: }
070:
071: /**
072: * Creates a free router. The path persist control points created by users using AddRemoveControlPointAction.
073: * The instance can be shared by multiple widgets.
074: * @return the free router
075: */
076: public static Router createFreeRouter() {
077: return ROUTER_FREE;
078: }
079:
080: /**
081: * Creates an orthogonal search router. The router gathers collision regions from widget that are placed in specified layers.
082: * The instance can be shared by multiple widgets.
083: * @param layers the layers with widgets taken as collisions regions
084: * @return the orthogonal search router
085: */
086: public static Router createOrthogonalSearchRouter(
087: LayerWidget... layers) {
088: return createOrthogonalSearchRouter(createWidgetsCollisionCollector(layers));
089: }
090:
091: /**
092: * Creates an orthogonal search router. The router uses collision regions from specified collector.
093: * The instance can be shared by multiple widgets.
094: * @param collector the collision collector
095: * @return the orthogonal search router
096: */
097: public static Router createOrthogonalSearchRouter(
098: CollisionsCollector collector) {
099: assert collector != null;
100: return new OrthogonalSearchRouter(collector);
101: }
102:
103: /**
104: * Creates collision collector based on specified layers. The boundaries of widgets in specified layers are taken
105: * The instance can be shared by multiple widgets.
106: * as collision regions.
107: * @param layers the layers with widgets
108: * @return the collision collector
109: */
110: private static CollisionsCollector createWidgetsCollisionCollector(
111: LayerWidget... layers) {
112: return new WidgetsCollisionCollector(layers);
113: }
114:
115: /**
116: * Creates an orthogonal search router. The router uses collision regions from specified collector
117: * with a connection widget context.
118: * The instance can be shared by multiple widgets.
119: * @param collector the collision collector
120: * @return the orthogonal search router
121: * @since 2.2
122: */
123: public static Router createOrthogonalSearchRouter(
124: ConnectionWidgetCollisionsCollector collector) {
125: assert collector != null;
126: return new OrthogonalSearchRouter(collector);
127: }
128:
129: }
|