org.netbeans.api.visual.export.WidgetPolygonalCoordinates Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, 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-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*
* Contributor(s):
*
* Portions Copyrighted 2008 Sun Microsystems, Inc.
*/
package org.netbeans.api.visual.export;
import java.awt.Polygon;
import org.netbeans.api.visual.widget.Widget;
/**
* The purpose of this class is to provide a framework for holding a Widget
* and the Polygon that encompasses it. Can be used for creating HTML image
* maps. For the ConnectionWidgets, a Polygon is created that follows the contour
* of the connection with a pixel buffer equal to the defined margin.
* @author krichard
*/
public final class WidgetPolygonalCoordinates {
private final Widget widget ;
private final Polygon polygon ;
/**
* Creates an instance of a WidgetPolygonalCoordinates object.
* @param widget The Widget (may be a ConnectionWidget) being encompassed
* by the polygon.
* @param polygon The Polygon surrounding the respective Widget.
*/
public WidgetPolygonalCoordinates (Widget widget, Polygon polygon) {
this.widget = widget ;
this.polygon = polygon ;
}
/**
* Returns the Widget stored in this class.
* @return the Widget stored in this class.
*/
public Widget getWidget() {
return widget;
}
/**
* Returns the Polygon stored in this class.
* @return the Polygon stored in this class.
*/
public Polygon getPolygon() {
return polygon;
}
}