com.partnersoft.maps.ephemera

Class TextEphemeron

java.lang.Object

com.partnersoft.maps.ephemera.TextEphemeron

All Implemented Interfaces:

Ephemeron

Direct Known Subclasses:

AbstractUpdatingTextEphemeron

public class TextEphemeron
extends java.lang.Object
implements Ephemeron

Draws passed text using passed text style.

Copyright 2007 Paul Reavis

Author:

Rich Stepanski

Field Summary

Fields

Modifier and Type	Field and Description
protected int	alignment
protected boolean	isPixels
protected MapSet	mapset
protected int	offsetX
protected int	offsetY
protected int	rotation
protected java.lang.String	text
protected java.lang.String	textStyle

Constructor Summary

Constructors

Constructor and Description
TextEphemeron(MapSet mapset, java.lang.String text, java.lang.String textStyle, int offsetX, int offsetY, int alignment, int rotation) Creates a new TextEphemeron.
TextEphemeron(MapSet mapset, java.lang.String text, java.lang.String textStyle, int offsetX, int offsetY, int alignment, int rotation, boolean isPixels) Creates a new TextEphemeron.
TextEphemeron(java.lang.String text, java.lang.String textStyle) Creates a new TextEphemeron.
TextEphemeron(java.lang.String text, java.lang.String textStyle, int offsetX, int offsetY, int alignment) Creates a new TextEphemeron.
TextEphemeron(java.lang.String text, java.lang.String textStyle, int offsetX, int offsetY, int alignment, int rotation) Creates a new TextEphemeron.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(DrawingSurface surface, MapViewFrame frame, XyPoint mousePosition) Draw appropriate graphics on the given surface with the given frame, mouse position, and any implementation-specific internal state.

Methods inherited from class java.lang.Object

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

Field Detail

text

protected java.lang.String text

textStyle

protected java.lang.String textStyle

offsetX

protected int offsetX

offsetY

protected int offsetY

alignment

protected int alignment

rotation

protected int rotation

mapset

protected MapSet mapset

isPixels

protected boolean isPixels

Constructor Detail

TextEphemeron

public TextEphemeron(java.lang.String text,
             java.lang.String textStyle,
             int offsetX,
             int offsetY,
             int alignment,
             int rotation)

Creates a new TextEphemeron. Will draw passed text using passed textStyle and arguments. Starting X,Y is mouse position. Text style is assumed to live in ephemera mapset styles.

Parameters:

text - - text to be drawn

textStyle - - text style to use for text

offsetX - - X offset to use when drawing text in pixels.

offsetY - - Y offset to use when drawing text in pixels.

alignment - - alignment to use.

rotation - - rotation to use.

TextEphemeron

public TextEphemeron(MapSet mapset,
             java.lang.String text,
             java.lang.String textStyle,
             int offsetX,
             int offsetY,
             int alignment,
             int rotation)

Creates a new TextEphemeron. Will draw passed text using passed textStyle and arguments. Starting X,Y is mouse position. Text style is assumed to live in passed mapset or ephemera mapset if mapset is null.

Parameters:

mapset - - mapset containing styles to draw.

text - - text to be drawn.

textStyle - - text style to use for text.

offsetX - - X offset to use when drawing text in pixels.

offsetY - - Y offset to use when drawing text in pixels.

alignment - - alignment to use.

rotation - - rotation to use.

TextEphemeron

public TextEphemeron(MapSet mapset,
             java.lang.String text,
             java.lang.String textStyle,
             int offsetX,
             int offsetY,
             int alignment,
             int rotation,
             boolean isPixels)

Creates a new TextEphemeron. Will draw passed text using passed textStyle and arguments. Starting X,Y is mouse position. Text style is assumed to live in passed mapset or ephemera mapset if mapset is null.

Parameters:

mapset - - mapset containing styles to draw.

text - - text to be drawn.

textStyle - - text style to use for text.

offsetX - - X offset to use when drawing text.

offsetY - - Y offset to use when drawing text.

alignment - - alignment to use.

rotation - - rotation to use.

isPixels - - T/F to use offset as pixels. True for pixels.

TextEphemeron

public TextEphemeron(java.lang.String text,
             java.lang.String textStyle,
             int offsetX,
             int offsetY,
             int alignment)

Creates a new TextEphemeron. Will draw passed text using passed textStyle and arguments. Starting X,Y is mouse position.Text style is assumed to live in ephemera mapset styles.

Parameters:

text - - text to be drawn

textStyle - - text style to use for text

offsetX - - X offset to use when drawing text in pixels.

offsetY - - Y offset to use when drawing text in pixels.

alignment - - alignment to use

TextEphemeron

public TextEphemeron(java.lang.String text,
             java.lang.String textStyle)

Creates a new TextEphemeron. Will draw passed text using passed textStyle and arguments. Will draw text 10 pixels above mouse position.Text style is assumed to live in ephemera mapset styles.

Parameters:

text - - text to be drawn

textStyle - - text style to use for text

Method Detail

draw

public void draw(DrawingSurface surface,
        MapViewFrame frame,
        XyPoint mousePosition)

Description copied from interface: Ephemeron

Draw appropriate graphics on the given surface with the given frame, mouse position, and any implementation-specific internal state. The drawing surface is set up with the given frame, and is in map coordinates (not pixels).

Specified by:

draw in interface Ephemeron