Package org.openstreetmap.josm.gui.mappaint.styleelement

Class BoxTextElement

java.lang.Object

org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement

org.openstreetmap.josm.gui.mappaint.styleelement.BoxTextElement

All Implemented Interfaces:

StyleKeys

public class BoxTextElement
extends StyleElement

Text style attached to a style with a bounding box, like an icon or a symbol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BoxTextElement.BoxProvider	Something that provides us with a BoxTextElement.BoxProviderResult
static class	BoxTextElement.BoxProviderResult	A box rectangle with a flag if it is temporary.
static class	BoxTextElement.HorizontalTextAlignment	MapCSS text-anchor-horizontal
static class	BoxTextElement.SimpleBoxProvider	A BoxTextElement.BoxProvider that always returns the same non-temporary rectangle
static class	BoxTextElement.VerticalTextAlignment	MapCSS text-anchor-vertical

Field Summary

Fields

Modifier and Type	Field	Description
protected BoxTextElement.BoxProvider	boxProvider
private static java.awt.Color	defaultTextColorCache	Caches the default text color from the preferences.
BoxTextElement.HorizontalTextAlignment	hAlign	The BoxTextElement.HorizontalTextAlignment for this text.
TextLabel	text	The text this element should display.
BoxTextElement.VerticalTextAlignment	vAlign	The BoxTextElement.VerticalTextAlignment for this text.
int	xOffset	The x offset of the text.
int	yOffset	The y offset of the text.

Fields inherited from class org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement

defaultSelectedHandling, ICON_HEIGHT_IDX, ICON_IMAGE_IDX, ICON_OFFSET_X_IDX, ICON_OFFSET_Y_IDX, ICON_OPACITY_IDX, ICON_WIDTH_IDX, isModifier, majorZIndex, objectZIndex, zIndex

Fields inherited from interface org.openstreetmap.josm.gui.mappaint.StyleKeys

COLOR, DASHES, DASHES_BACKGROUND_COLOR, DASHES_BACKGROUND_OPACITY, DASHES_OFFSET, FILL_COLOR, FILL_EXTENT, FILL_EXTENT_THRESHOLD, FILL_IMAGE, FILL_OPACITY, FONT_FAMILY, FONT_SIZE, FONT_STYLE, FONT_WEIGHT, ICON_HEIGHT, ICON_IMAGE, ICON_OFFSET_X, ICON_OFFSET_Y, ICON_OPACITY, ICON_POSITION, ICON_ROTATION, ICON_WIDTH, LINECAP, LINEJOIN, MAJOR_Z_INDEX, MITERLIMIT, MODIFIER, OBJECT_Z_INDEX, OFFSET, OPACITY, REAL_WIDTH, REPEAT_IMAGE, REPEAT_IMAGE_ALIGN, REPEAT_IMAGE_HEIGHT, REPEAT_IMAGE_OFFSET, REPEAT_IMAGE_OPACITY, REPEAT_IMAGE_PHASE, REPEAT_IMAGE_SPACING, REPEAT_IMAGE_WIDTH, TEXT, TEXT_ANCHOR_HORIZONTAL, TEXT_ANCHOR_VERTICAL, TEXT_COLOR, TEXT_HALO_COLOR, TEXT_HALO_OPACITY, TEXT_HALO_RADIUS, TEXT_OFFSET, TEXT_OFFSET_X, TEXT_OFFSET_Y, TEXT_OPACITY, TEXT_POSITION, TEXT_ROTATION, WAY_DIRECTION_ARROWS, WIDTH, Z_INDEX

Constructor Summary

Constructors

Constructor	Description
BoxTextElement(Cascade c, TextLabel text, BoxTextElement.BoxProvider boxProvider, int offsetX, int offsetY, BoxTextElement.HorizontalTextAlignment hAlign, BoxTextElement.VerticalTextAlignment vAlign)	Create a new BoxTextElement

Method Summary

Modifier and Type	Method	Description
static BoxTextElement	create(Environment env, BoxTextElement.BoxProvider boxProvider)	Create a new BoxTextElement with a boxprovider and a box.
boolean	equals(java.lang.Object obj)
java.awt.Rectangle	getBox()	Get the box in which the content should be drawn.
int	hashCode()
private static void	initDefaultParameters()
void	paintPrimitive(IPrimitive osm, MapPaintSettings settings, StyledMapRenderer painter, boolean selected, boolean outermember, boolean member)	draws a primitive
java.lang.String	toString()

Methods inherited from class org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement

getFont, getWidth, isProperLineStyle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

defaultTextColorCache

private static volatile java.awt.Color defaultTextColorCache

Caches the default text color from the preferences. FIXME: the cache isn't updated if the user changes the preference during a JOSM session. There should be preference listener updating this cache.

text

public TextLabel text

The text this element should display.

xOffset

public int xOffset

The x offset of the text.

yOffset

public int yOffset

The y offset of the text. In screen space (inverted to user space)

hAlign

public BoxTextElement.HorizontalTextAlignment hAlign

The BoxTextElement.HorizontalTextAlignment for this text.

vAlign

public BoxTextElement.VerticalTextAlignment vAlign

The BoxTextElement.VerticalTextAlignment for this text.

boxProvider

protected BoxTextElement.BoxProvider boxProvider

Constructor Detail

BoxTextElement

public BoxTextElement(Cascade c,
                      TextLabel text,
                      BoxTextElement.BoxProvider boxProvider,
                      int offsetX,
                      int offsetY,
                      BoxTextElement.HorizontalTextAlignment hAlign,
                      BoxTextElement.VerticalTextAlignment vAlign)

Create a new BoxTextElement

Parameters:

c - The current cascade

text - The text to display

boxProvider - The box provider to use

offsetX - x offset, in screen space

offsetY - y offset, in screen space

hAlign - The BoxTextElement.HorizontalTextAlignment

vAlign - The BoxTextElement.VerticalTextAlignment

Method Detail

create

public static BoxTextElement create(Environment env,
                                    BoxTextElement.BoxProvider boxProvider)

Create a new BoxTextElement with a boxprovider and a box.

Parameters:

env - The MapCSS environment

boxProvider - The box provider.

Returns:

A new BoxTextElement or null if the creation failed.

getBox

public java.awt.Rectangle getBox()

Get the box in which the content should be drawn.

Returns:

The box.

initDefaultParameters

private static void initDefaultParameters()

paintPrimitive

public void paintPrimitive(IPrimitive osm,
                           MapPaintSettings settings,
                           StyledMapRenderer painter,
                           boolean selected,
                           boolean outermember,
                           boolean member)

Description copied from class: StyleElement

draws a primitive

Specified by:

paintPrimitive in class StyleElement

Parameters:

osm - primitive to draw

settings - paint settings

painter - painter

selected - true, if primitive is selected

outermember - true, if primitive is not selected and outer member of a selected multipolygon relation

member - true, if primitive is not selected and member of a selected relation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class StyleElement

hashCode

public int hashCode()

Overrides:

hashCode in class StyleElement

toString

public java.lang.String toString()

Overrides:

toString in class StyleElement