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

Interface PositionForAreaStrategy

All Known Implementing Classes:

CompletelyInsideAreaStrategy, OnLineStrategy, PartiallyInsideAreaStrategy

public interface PositionForAreaStrategy

This strategy defines how to place a label or icon inside the area.

Since:

11722, 11748 moved to own file

Method Summary

Modifier and Type	Method	Description
MapViewPositionAndRotation	findLabelPlacement(MapViewPath path, java.awt.geom.Rectangle2D nb)	Finds the correct position of a label / icon inside the area.
static PositionForAreaStrategy	forKeyword(Keyword keyword)	Gets a strategy for the given keyword.
static PositionForAreaStrategy	forKeyword(Keyword keyword, PositionForAreaStrategy defaultStrategy)	Gets a strategy for the given keyword.
default java.util.List<java.awt.font.GlyphVector>	generateGlyphVectors(MapViewPath path, java.awt.geom.Rectangle2D nb, java.util.List<java.awt.font.GlyphVector> gvs, boolean isDoubleTranslationBug)	Generates the transformed glyph vectors for the given text.
boolean	supportsGlyphVector()	Checks whether this placement strategy supports more detailed (rotation / ...) placement using a glyph vector.
PositionForAreaStrategy	withAddedOffset(java.awt.geom.Point2D addToOffset)	Create a new instance of the same strategy adding a offset

Method Detail

findLabelPlacement

MapViewPositionAndRotation findLabelPlacement(MapViewPath path,
                                              java.awt.geom.Rectangle2D nb)

Finds the correct position of a label / icon inside the area.

Parameters:

path - The area to search in

nb - The bounding box of the thing we are searching a place for.

Returns:

The position as rectangle with the same dimension as nb. null if none was found.

supportsGlyphVector

boolean supportsGlyphVector()

Checks whether this placement strategy supports more detailed (rotation / ...) placement using a glyph vector.

Returns:

true if it is supported.

generateGlyphVectors

default java.util.List<java.awt.font.GlyphVector> generateGlyphVectors(MapViewPath path,
                                                                       java.awt.geom.Rectangle2D nb,
                                                                       java.util.List<java.awt.font.GlyphVector> gvs,
                                                                       boolean isDoubleTranslationBug)

Generates the transformed glyph vectors for the given text.

Parameters:

path - The path to place the text along

nb - The bounds of the text

gvs - The glyph vectors for the text. May be modified

isDoubleTranslationBug - true to fix a glyph placement bug.

Returns:

The glyph vectors.

Throws:

java.lang.UnsupportedOperationException - if supportsGlyphVector() returns false

forKeyword

static PositionForAreaStrategy forKeyword(Keyword keyword)

Gets a strategy for the given keyword.

Parameters:

keyword - The text position keyword.

Returns:

The strategy or line if none was specified.

Since:

11722

forKeyword

static PositionForAreaStrategy forKeyword(Keyword keyword,
                                          PositionForAreaStrategy defaultStrategy)

Gets a strategy for the given keyword.

Parameters:

keyword - The text position keyword.

defaultStrategy - The default if no strategy was recognized.

Returns:

The strategy or line if none was specified.

Since:

11722

withAddedOffset

PositionForAreaStrategy withAddedOffset(java.awt.geom.Point2D addToOffset)

Create a new instance of the same strategy adding a offset

Parameters:

addToOffset - The offset to add

Returns:

The new strategy

Since:

12476