ilog.views.maps.rendering

Class IlvIconPointRenderer

java.lang.Object

ilog.views.maps.rendering.IlvIconPointRenderer

All Implemented Interfaces:

IlvPersistentObject, IlvFeatureRenderer, Serializable

public class IlvIconPointRenderer
extends Object
implements IlvFeatureRenderer

This renderer translates a map feature whose geometry is an IlvMapPoint into a fixed-size icon.

See Also:

IlvMapPoint, IlvIcon, IlvFixedSizeGraphic, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvIconPointRenderer(IlvInputStream stream) Reads a renderer from an IlvInputStream.
IlvIconPointRenderer(String iconFileName) Creates an instance of the renderer from the specified icon file name.
IlvIconPointRenderer(URL iconURL) Creates an instance of the renderer using the icon at the location specified by the URL.

Method Summary

Modifier and Type	Method and Description
String	getIconFileName() Returns the file name of the icon.
int	getIconHeight() Returns the height of the icon.
URL	getIconURL() Returns the URL of the icon.
int	getIconWidth() Returns the width of the icon.
IlvMapImageRenderingStyle	getImageRenderingStyle() Retrieves the rendering style of the renderer.
boolean	isPersistent() Returns true.
IlvGraphic	makeGraphic(IlvMapFeature feature, IlvCoordinateTransformation transformation) Translates the map feature into a graphic object.
void	setIconFileName(String fileName) Sets the file name of the icon.
void	setIconHeight(int height) Sets the height of the icon.
void	setIconURL(URL url) Sets the URL of the icon.
void	setIconWidth(int width) Sets the width of the icon.
void	setImageRenderingStyle(IlvMapImageRenderingStyle style) Sets the rendering style of the renderer.
void	write(IlvOutputStream stream) Writes the renderer to an IlvOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvIconPointRenderer

public IlvIconPointRenderer(URL iconURL)

Creates an instance of the renderer using the icon at the location specified by the URL. The size of the icon is automatically determined.

Parameters:

iconURL - The URL of the icon.

IlvIconPointRenderer

public IlvIconPointRenderer(String iconFileName)

Creates an instance of the renderer from the specified icon file name. The size of the icon is automatically determined.

Parameters:

iconFileName - The name of the file of the icon.

IlvIconPointRenderer

public IlvIconPointRenderer(IlvInputStream stream)
                     throws IlvReadFileException

Reads a renderer from an IlvInputStream.

Throws:

IlvReadFileException

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the renderer to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Specified by:

write in interface IlvFeatureRenderer

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

makeGraphic

public IlvGraphic makeGraphic(IlvMapFeature feature,
                              IlvCoordinateTransformation transformation)
                       throws IlvMapRenderException,
                              IlvCoordinateTransformationException

Translates the map feature into a graphic object. Note that this method has been changed since Perforce JViews 5.0. The old method was draw(IlvMapFeature, IlvProjection). In case you have overridden the old draw method, you have to rewrite your method in order to migrate to JViews 5.0.

Specified by:

makeGraphic in interface IlvFeatureRenderer

Parameters:

feature - The map feature to translate.

transformation - The transformation. This parameter should never be null.

Throws:

IlvMapRenderException - If the renderer cannot process the map feature.

IlvCoordinateTransformationException - If a transformation exception occurs.

Since:

JViews 5.0

isPersistent

public boolean isPersistent()

Returns true.

Specified by:

isPersistent in interface IlvFeatureRenderer

setIconWidth

public void setIconWidth(int width)

Sets the width of the icon.

getIconWidth

public int getIconWidth()

Returns the width of the icon.

setIconHeight

public void setIconHeight(int height)

Sets the height of the icon.

getIconHeight

public int getIconHeight()

Returns the height of the icon.

getIconFileName

public String getIconFileName()

Returns the file name of the icon.

Returns:

The name of file containing icon or null if this icon was not created using a file.

setIconFileName

public void setIconFileName(String fileName)

Sets the file name of the icon.

getIconURL

public URL getIconURL()

Returns the URL of the icon.

Returns:

The URL of the icon, or null if this icon was not created using an URL.

setIconURL

public void setIconURL(URL url)

Sets the URL of the icon.

getImageRenderingStyle

public IlvMapImageRenderingStyle getImageRenderingStyle()

Retrieves the rendering style of the renderer.

Returns:

The rendering style.

Since:

JViews 5.0

setImageRenderingStyle

public void setImageRenderingStyle(IlvMapImageRenderingStyle style)

Sets the rendering style of the renderer.

Parameters:

style - The IlvMapImageRenderingStyle.

Since:

JViews 5.0