prajna.data

Class MarkerIcon

java.lang.Object

javax.swing.ImageIcon

prajna.data.MarkerIcon

All Implemented Interfaces:

java.io.Serializable, javax.accessibility.Accessible, javax.swing.Icon

public class MarkerIcon
extends javax.swing.ImageIcon

Class for representing a marker image. The marker image extends ImageIcon, so that it can be easily drawn or rendered. However, the MarkerIcon also includes an offset, so that it can be centered on a coordinate, or use a particular feature within the image as the image point, such as the point of a pin.

Author:

Edward Swing

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.ImageIcon

javax.swing.ImageIcon.AccessibleImageIcon

Field Summary

Fields inherited from class javax.swing.ImageIcon

component, tracker

Constructor Summary

Constructors

Constructor and Description
MarkerIcon(java.awt.Shape shape, java.awt.Color drawColor, java.awt.Color fillColor) Create a MarkerIcon from a specified shape, draw color and fill color.
MarkerIcon(java.lang.String fileName) Create a marker icon from an image file.
MarkerIcon(java.net.URL url) Create a marker icon from an image file specified by a URL.

Method Summary

Methods

Modifier and Type	Method and Description
java.net.URL	getIconUrl() Get the URL for the icon.
int	getXOffset() Get the XOffset for this MarkerIcon.
int	getYOffset() Get the YOffset for this MarkerIcon.
boolean	isPoint() Return whether this MarkerIcon is a single point.
void	setOffset(int xOffset, int yOffset) Set the offset for this MarkerIcon.
void	writeToFile(java.lang.String fileName) Write this icon to a file.

Methods inherited from class javax.swing.ImageIcon

getAccessibleContext, getDescription, getIconHeight, getIconWidth, getImage, getImageLoadStatus, getImageObserver, loadImage, paintIcon, setDescription, setImage, setImageObserver, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerIcon

public MarkerIcon(java.awt.Shape shape,
          java.awt.Color drawColor,
          java.awt.Color fillColor)

Create a MarkerIcon from a specified shape, draw color and fill color. This constructor will create an image large enough to contain the shape. If the fill color is not null, it will create a filled shape. If the draw color is not null, it will draw the outline in the drawColor. The offset for this MarkerIcon will be set at the origin of the shape.

Parameters:

shape - the shape

drawColor -

fillColor -

Throws:

java.lang.IllegalArgumentException - if both draw and fill color are null.

MarkerIcon

public MarkerIcon(java.lang.String fileName)

Create a marker icon from an image file. This will load the image from the file

Parameters:

fileName - the name of the file

MarkerIcon

public MarkerIcon(java.net.URL url)

Create a marker icon from an image file specified by a URL. This will load the image from the file

Parameters:

url - the url of the file

Method Detail

getIconUrl

public java.net.URL getIconUrl()

Get the URL for the icon. If the URL constructor is used, this method will return the URL used to construct the MarkerIcon. If the icon has been written to a file, this method will return a file path to the icon

Returns:

the URL for this icon, or null if it is not available.

getXOffset

public int getXOffset()

Get the XOffset for this MarkerIcon. The offset (x, y) determines where this MarkerIcon should be placed relative to its reference point.

Returns:

the XOffset, in pixel coordinates

getYOffset

public int getYOffset()

Get the YOffset for this MarkerIcon. The offset (x, y) determines where this MarkerIcon should be placed relative to its reference point.

Returns:

the YOffset, in pixel coordinates

isPoint

public boolean isPoint()

Return whether this MarkerIcon is a single point. A MarkerIcon is considered a single point if its height and width are less than 2.

Returns:

whether this icon is a single point.

setOffset

public void setOffset(int xOffset,
             int yOffset)

Set the offset for this MarkerIcon. The offset (x, y) determines where this MarkerIcon should be placed relative to its reference point.

Parameters:

xOffset - the X coordinate of the offset, in pixel coordinates

yOffset - the Y coordinate of the offset, in pixel coordinates

writeToFile

public void writeToFile(java.lang.String fileName)

Write this icon to a file. Not currently implemented

Parameters:

fileName - the file to write to.