ilog.views.chart.servlet

Class IlvIMapArea

java.lang.Object

ilog.views.chart.servlet.IlvIMapArea

public final class IlvIMapArea
extends Object

Represents an area of an image map.

Since:

JViews 5.0

Constructor Summary

Constructors

Constructor and Description
IlvIMapArea(double[] xpoints, double[] ypoints, int count, IlvIMapAttributes attr) Initializes a polygonal area with the specified coordinates and attributes.
IlvIMapArea(IlvPolygon2D polygon, IlvIMapAttributes attr) Initializes a polygonal area with the specified IlvPolygon2D and attributes.
IlvIMapArea(int[] xpoints, int[] ypoints, int count, IlvIMapAttributes attr) Initializes a polygonal area with the specified coordinates and attributes.
IlvIMapArea(int cx, int cy, int radius, IlvIMapAttributes attr) Initializes a circular area with the specified center, radius and attributes
IlvIMapArea(Polygon polygon, IlvIMapAttributes attr) Initializes a polygonal area with the specified Polygon and attributes.
IlvIMapArea(Rectangle rect, IlvIMapAttributes attr) Initializes a rectangular area with the specified Rectangle and attributes.
IlvIMapArea(Shape shape, double dx, double dy, IlvIMapAttributes attr) Initializes an area with the specified shape and attributes.
IlvIMapArea(Shape shape, IlvIMapAttributes attr) Initializes an area with the specified shape and attributes.

Method Summary

Modifier and Type	Method and Description
static String	createTag(double[] xpoints, double[] ypoints, int count, IlvIMapAttributes attr) Returns the tag corresponding to a polygonal map area.
static String	createTag(IlvPolygon2D polygon, IlvIMapAttributes attr) Returns the tag corresponding to a polygonal map area.
static String	createTag(int[] xpoints, int[] ypoints, int count, IlvIMapAttributes attr) Returns the tag corresponding to a polygonal map area.
static String	createTag(int cx, int cy, int radius, IlvIMapAttributes attr) Returns the tag corresponding to a circular map area.
static String	createTag(Rectangle rect, IlvIMapAttributes attr) Returns the tag corresponding to a rectangular map area.
static String	createTag(Shape shape, double dx, double dy, IlvIMapAttributes attr) Returns the tag corresponding to a map area of an arbitrary shape.
static String	createTag(Shape shape, IlvIMapAttributes attr) Returns the tag corresponding to a map area of an arbitrary shape.
IlvIMapAttributes	getAttributes() Returns the attributes of the area.
Shape	getShape() Returns the shape of the area.
String	getTag() Returns the tag of the area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvIMapArea

public IlvIMapArea(Rectangle rect,
                   IlvIMapAttributes attr)

Initializes a rectangular area with the specified Rectangle and attributes.

Parameters:

rect - The considered rectangle.

attr - The area attributes.

IlvIMapArea

public IlvIMapArea(Polygon polygon,
                   IlvIMapAttributes attr)

Initializes a polygonal area with the specified Polygon and attributes.

Parameters:

polygon - The considered polygon.

attr - The area attributes.

IlvIMapArea

public IlvIMapArea(int[] xpoints,
                   int[] ypoints,
                   int count,
                   IlvIMapAttributes attr)

Initializes a polygonal area with the specified coordinates and attributes.

Parameters:

xpoints - The x-coordinates of the area.

ypoints - The y-coordinates of the area.

count - The number of coordinates.

attr - The area attributes.

IlvIMapArea

public IlvIMapArea(IlvPolygon2D polygon,
                   IlvIMapAttributes attr)

Initializes a polygonal area with the specified IlvPolygon2D and attributes.

Parameters:

polygon - The considered polygon.

attr - The area attributes.

Since:

JViews 8.5

IlvIMapArea

public IlvIMapArea(double[] xpoints,
                   double[] ypoints,
                   int count,
                   IlvIMapAttributes attr)

Initializes a polygonal area with the specified coordinates and attributes.

Parameters:

xpoints - The x-coordinates of the area.

ypoints - The y-coordinates of the area.

count - The number of coordinates.

attr - The area attributes.

Since:

JViews 5.5

IlvIMapArea

public IlvIMapArea(int cx,
                   int cy,
                   int radius,
                   IlvIMapAttributes attr)

Initializes a circular area with the specified center, radius and attributes

Parameters:

cx - The x-coordinate of the center.

cy - The y-coordinate of the center.

radius - The circle radius.

attr - The area attributes.

IlvIMapArea

public IlvIMapArea(Shape shape,
                   IlvIMapAttributes attr)

Initializes an area with the specified shape and attributes.

The provided shape is converted to a polygonal area.

Parameters:

shape - The shape of the area.

attr - The area attributes.

Since:

JViews 8.1

IlvIMapArea

public IlvIMapArea(Shape shape,
                   double dx,
                   double dy,
                   IlvIMapAttributes attr)

Initializes an area with the specified shape and attributes.

The provided shape is first translated by (dx,dy) and then converted to a polygonal area.

Parameters:

shape - The shape of the area.

dx - An optional horizontal translation to be applied to the shape.

dy - An optional vertical translation to be applied to the shape.

attr - The area attributes.

Since:

JViews 8.1

Method Detail

getShape

public final Shape getShape()

Returns the shape of the area.

Returns:

The shape that was passed as constructor argument. It can be of type Rectangle, Polygon, IlvPolygon2D, Ellipse2D, IlvTranslatedShape, or any other Shape.

Since:

JViews 8.5

getAttributes

public final IlvIMapAttributes getAttributes()

Returns the attributes of the area.

Returns:

The attributes that were passed as constructor argument.

Since:

JViews 8.5

getTag

public String getTag()

Returns the tag of the area.

Returns:

The area tag. The returned string has the following form: <area shape=... coords=... attributeList>

createTag

public static String createTag(Rectangle rect,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a rectangular map area.

Parameters:

rect - The rectangle that defines the area.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 5.5

createTag

public static String createTag(int[] xpoints,
                               int[] ypoints,
                               int count,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a polygonal map area.

Parameters:

xpoints - The x-coordinates of the area.

ypoints - The y-coordinates of the area.

count - The number of coordinates.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 5.5

createTag

public static String createTag(double[] xpoints,
                               double[] ypoints,
                               int count,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a polygonal map area.

Parameters:

xpoints - The x-coordinates of the area.

ypoints - The y-coordinates of the area.

count - The number of coordinates.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 5.5

createTag

public static String createTag(IlvPolygon2D polygon,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a polygonal map area.

Parameters:

polygon - The polygon.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 8.5

createTag

public static String createTag(int cx,
                               int cy,
                               int radius,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a circular map area.

Parameters:

cx - The x-coordinate of the center.

cy - The y-coordinate of the center.

radius - The circle radius.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 5.5

createTag

public static String createTag(Shape shape,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a map area of an arbitrary shape.

Parameters:

shape - The shape of the area.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 8.1

createTag

public static String createTag(Shape shape,
                               double dx,
                               double dy,
                               IlvIMapAttributes attr)

Returns the tag corresponding to a map area of an arbitrary shape.

Parameters:

shape - The shape of the area.

dx - An optional horizontal translation to be applied to the shape.

dy - An optional vertical translation to be applied to the shape.

attr - The area attributes.

Returns:

The area tag.

Since:

JViews 8.1