com.moximedia.ows.acetate
Class AcetateImageMarker

java.lang.Object
  com.moximedia.ows.acetate.AcetateImageMarker

All Implemented Interfaces:

AcetateObject, java.lang.Cloneable, java.io.Serializable

public class AcetateImageMarker

extends java.lang.Object

implements AcetateObject, java.io.Serializable, java.lang.Cloneable

A graphic object that can be drawn onto an acetate layer of an IMF map.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AcetateImageMarker()
Creates new AcetateImageMarker

AcetateImageMarker(double x, double y, java.lang.String imageFileName)
Creates new AcetateSimpleMarker

AcetateImageMarker(double x, double y, java.lang.String imageFileName, java.lang.String label)
Creates new AcetateSimpleMarker

AcetateImageMarker(Point position, java.lang.String imageFileName)
Creates new AcetateImageMarker

AcetateImageMarker(Point position, java.lang.String imageFileName, java.lang.String label)
Creates new AcetateImageMarker

Method Summary

java.lang.Object	clone() Creates a clone of this object.
void	draw(java.awt.Graphics2D graphics, java.awt.geom.AffineTransform pageTransform, java.util.Locale locale) Draws the graphic on the specified graphics device.
AcetateImageMarker	getCopy() Creates a copy of this object.
java.lang.String	getName() Gets the progammer specified name for this object.
java.lang.Object	getObjectTag() Gets the object tag.
int	getObjectType() Gets the object type enumerator
java.lang.String	getProperty(java.lang.String name) Gets the value of a property.
java.lang.String[]	getPropertyNames() Returns a Set containing the property names.
Geometry	getShape() The geometry of this object, a point in this case.
boolean	hasProperties() Returns an indicator of whether the object has programmer defined properties.
boolean	isNamed(java.lang.String name) Returns an indicator of whether this object is named the same as the parameter.
void	setImageFileName(java.lang.String fileName) The text of the marker's label, or null.
void	setLabel(java.lang.String label) The text of the marker's label, or null.
void	setLabelBackgroundColor(java.awt.Color color) The color of the label text background, if any.
void	setLabelFont(java.awt.Font font) The font of the label text, if any.
void	setLabelFontColor(java.awt.Color color) The color of the label text, if any.
void	setName(java.lang.String name) Sets a name for this object.
void	setObjectTag(java.lang.Object tag) Sets an object tag for this object.
void	setPixelOffset(int x, int y) Sets the offset from the origin of the image.
void	setPosition(double x, double y) Sets the position of the object.
void	setPosition(Point point) Sets the position of the object.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setUnits(int units) Sets the units of the acetate object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcetateImageMarker

public AcetateImageMarker()

Creates new AcetateImageMarker

AcetateImageMarker

public AcetateImageMarker(Point position,
                          java.lang.String imageFileName)

Creates new AcetateImageMarker

Parameters:

position - The position of the marker.

imageFileName - The image file name on the same system as IMF.

AcetateImageMarker

public AcetateImageMarker(Point position,
                          java.lang.String imageFileName,
                          java.lang.String label)

Creates new AcetateImageMarker

Parameters:

position - The position of the marker.

imageFileName - The image file name on the same system as IMF.

label - The label, if any. Null OK.

AcetateImageMarker

public AcetateImageMarker(double x,
                          double y,
                          java.lang.String imageFileName)

Creates new AcetateSimpleMarker

Parameters:

x - The X coordinate value of the marker's position.

y - The Y coordinate value of the marker's position.

imageFileName - The image file name on the same system as IMF.

AcetateImageMarker

public AcetateImageMarker(double x,
                          double y,
                          java.lang.String imageFileName,
                          java.lang.String label)

Creates new AcetateSimpleMarker

Parameters:

x - The X coordinate value of the marker's position.

y - The Y coordinate value of the marker's position.

imageFileName - The image file name on the same system as IMF.

label - The label, if any. Null OK.

Method Detail

clone

public java.lang.Object clone()

Creates a clone of this object. Must be cast back to the correct object type before using.

Specified by:

clone in interface AcetateObject

Returns:

The clone of this object.

getCopy

public AcetateImageMarker getCopy()

Creates a copy of this object.

Returns:

The copy of this object.

draw

public void draw(java.awt.Graphics2D graphics,
                 java.awt.geom.AffineTransform pageTransform,
                 java.util.Locale locale)

Draws the graphic on the specified graphics device.

Specified by:

draw in interface AcetateObject

Parameters:

graphics - The graphics.

pageTransform - The page to map coordinate transformation matrix.

locale - The locale, null OK, not used by this routine.

getShape

public Geometry getShape()

The geometry of this object, a point in this case.

Specified by:

getShape in interface AcetateObject

Returns:

The geometry.

setImageFileName

public void setImageFileName(java.lang.String fileName)

The text of the marker's label, or null.

Parameters:

fileName - The image file, relative to IMF.

setLabel

public void setLabel(java.lang.String label)

The text of the marker's label, or null.

Parameters:

label - The text for the label.

setLabelBackgroundColor

public void setLabelBackgroundColor(java.awt.Color color)

The color of the label text background, if any.

Parameters:

color - The color.

setLabelFont

public void setLabelFont(java.awt.Font font)

The font of the label text, if any.

Parameters:

font - The font.

setLabelFontColor

public void setLabelFontColor(java.awt.Color color)

The color of the label text, if any.

Parameters:

color - The color.

isNamed

public boolean isNamed(java.lang.String name)

Returns an indicator of whether this object is named the same as the parameter.

Specified by:

isNamed in interface AcetateObject

Parameters:

name - The name.

Returns:

True if the name is the same, otherwise false.

setName

public void setName(java.lang.String name)

Sets a name for this object.

Parameters:

name - A programmer specified name for this object.

getName

public java.lang.String getName()

Gets the progammer specified name for this object.

Specified by:

getName in interface AcetateObject

Returns:

The name, or "unnamed" if there isn't one set.

setObjectTag

public void setObjectTag(java.lang.Object tag)

Sets an object tag for this object.

Specified by:

setObjectTag in interface AcetateObject

Parameters:

tag - A programmer specified object to associate to this object.

getObjectTag

public java.lang.Object getObjectTag()

Gets the object tag.

Specified by:

getObjectTag in interface AcetateObject

Returns:

The object tag, or null if there isn't one set.

getObjectType

public int getObjectType()

Gets the object type enumerator

Specified by:

getObjectType in interface AcetateObject

Returns:

ACETATE_OBJECT_TYPE_IMAGE_MARKER

setPixelOffset

public void setPixelOffset(int x,
                           int y)

Sets the offset from the origin of the image.

Parameters:

x - The horizontal offset.

y - The vertical offset.

setPosition

public void setPosition(Point point)

Sets the position of the object.

Parameters:

point - The position.

setPosition

public void setPosition(double x,
                        double y)

Sets the position of the object.

Parameters:

x - The X coordinate value.

y - The Y coordinate value.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property.

Specified by:

getProperty in interface AcetateObject

Parameters:

name - The property name

Returns:

The property value, or null.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Specified by:

setProperty in interface AcetateObject

Parameters:

name - The property name

value - The property value.

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns a Set containing the property names.

Specified by:

getPropertyNames in interface AcetateObject

Returns:

The set containing the names, or null.

hasProperties

public boolean hasProperties()

Returns an indicator of whether the object has programmer defined properties.

Specified by:

hasProperties in interface AcetateObject

Returns:

True if properties exist, otherwise false.

setUnits

public void setUnits(int units)

Sets the units of the acetate object.

Parameters:

units - The units of the acetate object, either ACETATE_OBJECT_UNITS_PIXEL or ACETATE_OBJECT_UNITS_DATABASE.