com.moximedia.ows.acetate
Class AcetateText

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

All Implemented Interfaces:

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

public class AcetateText

extends java.lang.Object

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

Acetate object type to display text on the map.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AcetateText()
Creates new AcetateText

AcetateText(java.lang.String text)
Creates new AcetateText

AcetateText(java.lang.String text, java.awt.Font font, java.awt.Color color, Point position, int halignment, int valignment, int units)
Creates a new AcetateText object with detailed parameters.

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.
AcetateText	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() Returns the object type.
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() Returns the object geometry.
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	setAlignment(int halignment, int valignment) Sets the text alignment.
void	setColor(java.awt.Color color) Sets the marker color.
void	setFont(java.awt.Font font) Sets the font used for the marker.
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	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

AcetateText

public AcetateText()

Creates new AcetateText

AcetateText

public AcetateText(java.lang.String text)

Creates new AcetateText

Parameters:

text - The text string.

AcetateText

public AcetateText(java.lang.String text,
                   java.awt.Font font,
                   java.awt.Color color,
                   Point position,
                   int halignment,
                   int valignment,
                   int units)

Creates a new AcetateText object with detailed parameters.

Parameters:

text - The text string.

font - The font.

color - The font color.

position - The position to put the text.

halignment - The horizontal alignment.

valignment - The vertical alignment.

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

Method Detail

setAlignment

public void setAlignment(int halignment,
                         int valignment)

Sets the text alignment.

Parameters:

halignment - The horizontal alignment.

valignment - The vertical alignment.

clone

public java.lang.Object clone()

Creates a clone of this object. Must be cast back to the correct object type before using. Consider using getCopy() instead.

Specified by:

clone in interface AcetateObject

Returns:

The clone of this object.

getCopy

public AcetateText getCopy()

Creates a copy of this object.

Returns:

The copy of this object.

setColor

public void setColor(java.awt.Color color)

Sets the marker color.

Parameters:

color - The color.

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.

setFont

public void setFont(java.awt.Font font)

Sets the font used for the marker.

Parameters:

font - The font.

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()

Returns the object type.

Specified by:

getObjectType in interface AcetateObject

Returns:

Always returns ACETATE_OBJECT_TYPE_TEXT

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.

getShape

public Geometry getShape()

Returns the object geometry.

Specified by:

getShape in interface AcetateObject

Returns:

The geometry, a point.

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.