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

Class StyleElement

java.lang.Object

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

All Implemented Interfaces:

StyleKeys

Direct Known Subclasses:

AreaElement, AreaIconElement, BoxTextElement, LineElement, NodeElement, RepeatImageElement, TextElement

public abstract class StyleElement
extends java.lang.Object
implements StyleKeys

Class that defines how objects (OsmPrimitive) should be drawn on the map. Several subclasses of this abstract class implement different drawing features, like icons for a node or area fill. This class and all its subclasses are immutable and tend to get shared when multiple objects have the same style (in order to save memory, see StyleCache.intern()).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	StyleElement.FontDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	defaultFontName
private static java.lang.Float	defaultFontSize
boolean	defaultSelectedHandling	A flag indicating that the selection color handling should be done automatically
private static java.util.Map<StyleElement.FontDescriptor,java.awt.Font>	FONT_MAP
protected static int	ICON_HEIGHT_IDX
protected static int	ICON_IMAGE_IDX
protected static int	ICON_OFFSET_X_IDX
protected static int	ICON_OFFSET_Y_IDX
protected static int	ICON_OPACITY_IDX
protected static int	ICON_WIDTH_IDX
boolean	isModifier	false, if style can serve as main style for the primitive; true, if it is a highlight or modifier
private static java.lang.Object	lock
float	majorZIndex	The major z index of this style element
float	objectZIndex	The object z index
float	zIndex	The z index as set by the user

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

Modifier	Constructor	Description
protected	StyleElement(float majorZIndex, float zIndex, float objectZIndex, boolean isModifier, boolean defaultSelectedHandling)	Construct a new StyleElement
protected	StyleElement(Cascade c, float defaultMajorZindex)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
private static java.awt.Font	getCachedFont(java.lang.String name, int style, int size)
private static java.lang.String	getDefaultFontName()
private static java.lang.Float	getDefaultFontSize()
protected static java.awt.Font	getFont(Cascade c, java.lang.String s)
protected static java.lang.Float	getWidth(Cascade c, java.lang.String key, java.lang.Float relativeTo)	Get a property value of type Width
int	hashCode()
boolean	isProperLineStyle()	Check if this is a style that makes the line visible to the user
abstract void	paintPrimitive(IPrimitive primitive, MapPaintSettings paintSettings, StyledMapRenderer painter, boolean selected, boolean outermember, boolean member)	draws a primitive
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ICON_IMAGE_IDX

protected static final int ICON_IMAGE_IDX

See Also:

Constant Field Values

ICON_WIDTH_IDX

protected static final int ICON_WIDTH_IDX

See Also:

Constant Field Values

ICON_HEIGHT_IDX

protected static final int ICON_HEIGHT_IDX

See Also:

Constant Field Values

ICON_OPACITY_IDX

protected static final int ICON_OPACITY_IDX

See Also:

Constant Field Values

ICON_OFFSET_X_IDX

protected static final int ICON_OFFSET_X_IDX

See Also:

Constant Field Values

ICON_OFFSET_Y_IDX

protected static final int ICON_OFFSET_Y_IDX

See Also:

Constant Field Values

majorZIndex

public float majorZIndex

The major z index of this style element

zIndex

public float zIndex

The z index as set by the user

objectZIndex

public float objectZIndex

The object z index

isModifier

public boolean isModifier

false, if style can serve as main style for the primitive; true, if it is a highlight or modifier

defaultSelectedHandling

public boolean defaultSelectedHandling

A flag indicating that the selection color handling should be done automatically

defaultFontName

private static volatile java.lang.String defaultFontName

defaultFontSize

private static volatile java.lang.Float defaultFontSize

lock

private static final java.lang.Object lock

FONT_MAP

private static final java.util.Map<StyleElement.FontDescriptor,java.awt.Font> FONT_MAP

Constructor Detail

StyleElement

protected StyleElement(float majorZIndex,
                       float zIndex,
                       float objectZIndex,
                       boolean isModifier,
                       boolean defaultSelectedHandling)

Construct a new StyleElement

Parameters:

majorZIndex - like z-index, but higher priority

zIndex - order the objects are drawn

objectZIndex - like z-index, but lower priority

isModifier - if false, a default line or node symbol is generated

defaultSelectedHandling - true if default behavior for selected objects is enabled, false if a style for selected state is given explicitly

StyleElement

protected StyleElement(Cascade c,
                       float defaultMajorZindex)

Method Detail

paintPrimitive

public abstract void paintPrimitive(IPrimitive primitive,
                                    MapPaintSettings paintSettings,
                                    StyledMapRenderer painter,
                                    boolean selected,
                                    boolean outermember,
                                    boolean member)

draws a primitive

Parameters:

primitive - primitive to draw

paintSettings - 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

Since:

13662 (signature)

isProperLineStyle

public boolean isProperLineStyle()

Check if this is a style that makes the line visible to the user

Returns:

true for line styles

getWidth

protected static java.lang.Float getWidth(Cascade c,
                                          java.lang.String key,
                                          java.lang.Float relativeTo)

Get a property value of type Width

Parameters:

c - the cascade

key - property key for the width value

relativeTo - reference width. Only needed, when relative width syntax is used, e.g. "+4".

Returns:

width

getDefaultFontSize

private static java.lang.Float getDefaultFontSize()

getDefaultFontName

private static java.lang.String getDefaultFontName()

getCachedFont

private static java.awt.Font getCachedFont(java.lang.String name,
                                           int style,
                                           int size)

getFont

protected static java.awt.Font getFont(Cascade c,
                                       java.lang.String s)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object