[3880] | 1 | // License: GPL. For details, see LICENSE file.
|
---|
| 2 | package org.openstreetmap.josm.gui.mappaint;
|
---|
| 3 |
|
---|
| 4 | import static org.openstreetmap.josm.tools.Utils.equal;
|
---|
| 5 |
|
---|
| 6 | import java.awt.Color;
|
---|
| 7 | import java.awt.Font;
|
---|
[3987] | 8 |
|
---|
[3899] | 9 | import org.openstreetmap.josm.data.osm.OsmPrimitive;
|
---|
[3987] | 10 | import org.openstreetmap.josm.gui.mappaint.LabelCompositionStrategy.DeriveLabelFromNameTagsCompositionStrategy;
|
---|
[4007] | 11 | import org.openstreetmap.josm.gui.mappaint.LabelCompositionStrategy.StaticLabelCompositionStrategy;
|
---|
[3987] | 12 | import org.openstreetmap.josm.gui.mappaint.LabelCompositionStrategy.TagLookupCompositionStrategy;
|
---|
[4007] | 13 | import org.openstreetmap.josm.gui.mappaint.MapPaintStyles.TagKeyReference;
|
---|
[3880] | 14 | import org.openstreetmap.josm.tools.CheckParameterUtil;
|
---|
[3979] | 15 | import org.openstreetmap.josm.tools.Utils;
|
---|
[3880] | 16 |
|
---|
[3987] | 17 | /**
|
---|
| 18 | * Represents the rendering style for a textual label placed somewhere on the map.
|
---|
| 19 | *
|
---|
| 20 | */
|
---|
[5342] | 21 | public class TextElement implements StyleKeys {
|
---|
[4415] | 22 | static public final LabelCompositionStrategy AUTO_LABEL_COMPOSITION_STRATEGY = new DeriveLabelFromNameTagsCompositionStrategy();
|
---|
[3987] | 23 |
|
---|
| 24 | /** the strategy for building the actual label value for a given a {@link OsmPrimitive}.
|
---|
| 25 | * Check for null before accessing.
|
---|
| 26 | */
|
---|
| 27 | public LabelCompositionStrategy labelCompositionStrategy;
|
---|
| 28 | /** the font to be used when rendering*/
|
---|
[3880] | 29 | public Font font;
|
---|
| 30 | public int xOffset;
|
---|
| 31 | public int yOffset;
|
---|
| 32 | public Color color;
|
---|
[3979] | 33 | public Float haloRadius;
|
---|
| 34 | public Color haloColor;
|
---|
[3880] | 35 |
|
---|
[3987] | 36 | /**
|
---|
| 37 | * Creates a new text element
|
---|
[6070] | 38 | *
|
---|
[3987] | 39 | * @param strategy the strategy indicating how the text is composed for a specific {@link OsmPrimitive} to be rendered.
|
---|
| 40 | * If null, no label is rendered.
|
---|
| 41 | * @param font the font to be used. Must not be null.
|
---|
| 42 | * @param xOffset
|
---|
| 43 | * @param yOffset
|
---|
| 44 | * @param color the color to be used. Must not be null
|
---|
| 45 | * @param haloRadius
|
---|
| 46 | * @param haloColor
|
---|
| 47 | */
|
---|
| 48 | public TextElement(LabelCompositionStrategy strategy, Font font, int xOffset, int yOffset, Color color, Float haloRadius, Color haloColor) {
|
---|
[3880] | 49 | CheckParameterUtil.ensureParameterNotNull(font);
|
---|
| 50 | CheckParameterUtil.ensureParameterNotNull(color);
|
---|
[3987] | 51 | labelCompositionStrategy = strategy;
|
---|
[3880] | 52 | this.font = font;
|
---|
| 53 | this.xOffset = xOffset;
|
---|
| 54 | this.yOffset = yOffset;
|
---|
| 55 | this.color = color;
|
---|
[3979] | 56 | this.haloRadius = haloRadius;
|
---|
| 57 | this.haloColor = haloColor;
|
---|
[3880] | 58 | }
|
---|
| 59 |
|
---|
[3987] | 60 | /**
|
---|
| 61 | * Copy constructor
|
---|
[6070] | 62 | *
|
---|
[3987] | 63 | * @param other the other element.
|
---|
| 64 | */
|
---|
[3979] | 65 | public TextElement(TextElement other) {
|
---|
[3987] | 66 | this.labelCompositionStrategy = other.labelCompositionStrategy;
|
---|
[3979] | 67 | this.font = other.font;
|
---|
| 68 | this.xOffset = other.xOffset;
|
---|
| 69 | this.yOffset = other.yOffset;
|
---|
| 70 | this.color = other.color;
|
---|
| 71 | this.haloColor = other.haloColor;
|
---|
| 72 | this.haloRadius = other.haloRadius;
|
---|
| 73 | }
|
---|
| 74 |
|
---|
[3987] | 75 | /**
|
---|
| 76 | * Derives a suitable label composition strategy from the style properties in
|
---|
| 77 | * {@code c}.
|
---|
[6070] | 78 | *
|
---|
[3987] | 79 | * @param c the style properties
|
---|
| 80 | * @return the label composition strategy
|
---|
| 81 | */
|
---|
[3992] | 82 | protected static LabelCompositionStrategy buildLabelCompositionStrategy(Cascade c, boolean defaultAnnotate){
|
---|
[4007] | 83 | /*
|
---|
| 84 | * If the cascade includes a TagKeyReference we will lookup the rendered label
|
---|
| 85 | * from a tag value.
|
---|
| 86 | */
|
---|
[5342] | 87 | TagKeyReference tkr = c.get(TEXT, null, TagKeyReference.class, true);
|
---|
[4007] | 88 | if (tkr != null)
|
---|
| 89 | return new TagLookupCompositionStrategy(tkr.key);
|
---|
| 90 |
|
---|
| 91 | /*
|
---|
| 92 | * Check whether the label composition strategy is given by
|
---|
| 93 | * a keyword
|
---|
| 94 | */
|
---|
[5342] | 95 | Keyword keyword = c.get(TEXT, null, Keyword.class, true);
|
---|
[4007] | 96 | if (equal(keyword, Keyword.AUTO))
|
---|
[3987] | 97 | return AUTO_LABEL_COMPOSITION_STRATEGY;
|
---|
[4007] | 98 |
|
---|
| 99 | /*
|
---|
| 100 | * Do we have a static text label?
|
---|
| 101 | */
|
---|
[5342] | 102 | String text = c.get(TEXT, null, String.class, true);
|
---|
[4007] | 103 | if (text != null)
|
---|
| 104 | return new StaticLabelCompositionStrategy(text);
|
---|
| 105 | return defaultAnnotate ? AUTO_LABEL_COMPOSITION_STRATEGY : null;
|
---|
[3987] | 106 | }
|
---|
[3880] | 107 |
|
---|
[3987] | 108 | /**
|
---|
| 109 | * Builds a text element from style properties in {@code c} and the
|
---|
| 110 | * default text color {@code defaultTextColor}
|
---|
[6070] | 111 | *
|
---|
[3987] | 112 | * @param c the style properties
|
---|
| 113 | * @param defaultTextColor the default text color. Must not be null.
|
---|
[4074] | 114 | * @param defaultAnnotate true, if a text label shall be rendered by default, even if the style sheet
|
---|
| 115 | * doesn't include respective style declarations
|
---|
[3987] | 116 | * @return the text element or null, if the style properties don't include
|
---|
| 117 | * properties for text rendering
|
---|
| 118 | * @throws IllegalArgumentException thrown if {@code defaultTextColor} is null
|
---|
| 119 | */
|
---|
[3992] | 120 | public static TextElement create(Cascade c, Color defaultTextColor, boolean defaultAnnotate) throws IllegalArgumentException{
|
---|
[3987] | 121 | CheckParameterUtil.ensureParameterNotNull(defaultTextColor);
|
---|
| 122 |
|
---|
[3992] | 123 | LabelCompositionStrategy strategy = buildLabelCompositionStrategy(c, defaultAnnotate);
|
---|
[4281] | 124 | if (strategy == null) return null;
|
---|
[3880] | 125 | Font font = ElemStyle.getFont(c);
|
---|
[3882] | 126 |
|
---|
| 127 | float xOffset = 0;
|
---|
| 128 | float yOffset = 0;
|
---|
| 129 | float[] offset = c.get("text-offset", null, float[].class);
|
---|
| 130 | if (offset != null) {
|
---|
| 131 | if (offset.length == 1) {
|
---|
| 132 | yOffset = offset[0];
|
---|
| 133 | } else if (offset.length >= 2) {
|
---|
| 134 | xOffset = offset[0];
|
---|
| 135 | yOffset = offset[1];
|
---|
| 136 | }
|
---|
| 137 | }
|
---|
| 138 | xOffset = c.get("text-offset-x", xOffset, Float.class);
|
---|
| 139 | yOffset = c.get("text-offset-y", yOffset, Float.class);
|
---|
[3987] | 140 |
|
---|
| 141 | Color color = c.get("text-color", defaultTextColor, Color.class);
|
---|
[3979] | 142 | float alpha = c.get("text-opacity", 1f, Float.class);
|
---|
| 143 | color = new Color(color.getRed(), color.getGreen(),
|
---|
| 144 | color.getBlue(), Utils.color_float2int(alpha));
|
---|
| 145 |
|
---|
| 146 | Float haloRadius = c.get("text-halo-radius", null, Float.class);
|
---|
| 147 | if (haloRadius != null && haloRadius <= 0) {
|
---|
| 148 | haloRadius = null;
|
---|
| 149 | }
|
---|
| 150 | Color haloColor = null;
|
---|
| 151 | if (haloRadius != null) {
|
---|
| 152 | haloColor = c.get("text-halo-color", Utils.complement(color), Color.class);
|
---|
| 153 | float haloAlpha = c.get("text-halo-opacity", 1f, Float.class);
|
---|
| 154 | haloColor = new Color(haloColor.getRed(), haloColor.getGreen(),
|
---|
| 155 | haloColor.getBlue(), Utils.color_float2int(haloAlpha));
|
---|
| 156 | }
|
---|
| 157 |
|
---|
[3987] | 158 | return new TextElement(strategy, font, (int) xOffset, - (int) yOffset, color, haloRadius, haloColor);
|
---|
[3880] | 159 | }
|
---|
| 160 |
|
---|
[3987] | 161 | /**
|
---|
| 162 | * Replies the label to be rendered for the primitive {@code osm}.
|
---|
[6070] | 163 | *
|
---|
[4310] | 164 | * @param osm the OSM object
|
---|
[3987] | 165 | * @return the label, or null, if {@code osm} is null or if no label can be
|
---|
| 166 | * derived for {@code osm}
|
---|
| 167 | */
|
---|
| 168 | public String getString(OsmPrimitive osm) {
|
---|
| 169 | if (labelCompositionStrategy == null) return null;
|
---|
| 170 | return labelCompositionStrategy.compose(osm);
|
---|
| 171 | }
|
---|
| 172 |
|
---|
[3880] | 173 | @Override
|
---|
[3987] | 174 | public String toString() {
|
---|
[4003] | 175 | return "TextElement{" + toStringImpl() + '}';
|
---|
| 176 | }
|
---|
| 177 |
|
---|
| 178 | protected String toStringImpl() {
|
---|
[3987] | 179 | StringBuilder sb = new StringBuilder();
|
---|
[4003] | 180 | sb.append("labelCompositionStrategy=" + labelCompositionStrategy);
|
---|
| 181 | sb.append(" font=" + font);
|
---|
| 182 | if (xOffset != 0) {
|
---|
| 183 | sb.append(" xOffset=" + xOffset);
|
---|
| 184 | }
|
---|
| 185 | if (yOffset != 0) {
|
---|
| 186 | sb.append(" yOffset=" + yOffset);
|
---|
| 187 | }
|
---|
| 188 | sb.append(" color=" + Utils.toString(color));
|
---|
| 189 | if (haloRadius != null) {
|
---|
| 190 | sb.append(" haloRadius=" + haloRadius);
|
---|
| 191 | sb.append(" haloColor=" + haloColor);
|
---|
| 192 | }
|
---|
[3987] | 193 | return sb.toString();
|
---|
[3880] | 194 | }
|
---|
| 195 |
|
---|
| 196 | @Override
|
---|
| 197 | public int hashCode() {
|
---|
| 198 | int hash = 3;
|
---|
[3987] | 199 | hash = 79 * hash + (labelCompositionStrategy != null ? labelCompositionStrategy.hashCode() : 0);
|
---|
[3880] | 200 | hash = 79 * hash + font.hashCode();
|
---|
| 201 | hash = 79 * hash + xOffset;
|
---|
| 202 | hash = 79 * hash + yOffset;
|
---|
| 203 | hash = 79 * hash + color.hashCode();
|
---|
[3979] | 204 | hash = 79 * hash + (haloRadius != null ? Float.floatToIntBits(haloRadius) : 0);
|
---|
| 205 | hash = 79 * hash + (haloColor != null ? haloColor.hashCode() : 0);
|
---|
[3880] | 206 | return hash;
|
---|
| 207 | }
|
---|
| 208 |
|
---|
[3987] | 209 | @Override
|
---|
| 210 | public boolean equals(Object obj) {
|
---|
| 211 | if (obj == null || getClass() != obj.getClass())
|
---|
| 212 | return false;
|
---|
| 213 | final TextElement other = (TextElement) obj;
|
---|
| 214 | return equal(labelCompositionStrategy, other.labelCompositionStrategy) &&
|
---|
[4074] | 215 | equal(font, other.font) &&
|
---|
| 216 | xOffset == other.xOffset &&
|
---|
| 217 | yOffset == other.yOffset &&
|
---|
| 218 | equal(color, other.color) &&
|
---|
| 219 | equal(haloRadius, other.haloRadius) &&
|
---|
| 220 | equal(haloColor, other.haloColor);
|
---|
[3899] | 221 | }
|
---|
[3880] | 222 | }
|
---|