Changeset 11137 in josm for trunk


Ignore:
Timestamp:
2016-10-17T13:24:58+02:00 (3 years ago)
Author:
bastiK
Message:

javadoc

Location:
trunk/src/org/openstreetmap/josm/gui/mappaint
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/mappaint/ElemStyles.java

    r10611 r11137  
    3535import org.openstreetmap.josm.tools.Utils;
    3636
     37/**
     38 * Generates a list of {@link StyleElement}s for a primitive, to
     39 * be drawn on the map.
     40 * There are several steps to derive the list of elements for display:
     41 * <ol>
     42 * <li>{@link #generateStyles(OsmPrimitive, double, boolean)} applies the
     43 * {@link StyleSource}s one after another to get a key-value map of MapCSS
     44 * properties. Then a preliminary set of StyleElements is derived from the
     45 * properties map.</li>
     46 * <li>{@link #getImpl(OsmPrimitive, double, NavigatableComponent)} handles the
     47 * different forms of multipolygon tagging.</li>
     48 * <li>{@link #getStyleCacheWithRange(OsmPrimitive, double, NavigatableComponent)}
     49 * adds a default StyleElement for primitives that would be invisible otherwise.
     50 * (For example untagged nodes and ways.)</li>
     51 * </ol>
     52 * The results are cached with respect to the current scale.
     53 *
     54 * Use {@link #setStyleSources(Collection)} to select the StyleSources that are
     55 * applied.
     56 */
    3757public class ElemStyles implements PreferenceChangedListener {
    3858    private final List<StyleSource> styleSources;
  • trunk/src/org/openstreetmap/josm/gui/mappaint/Keyword.java

    r9371 r11137  
    55import java.util.Objects;
    66
     7/**
     8 * A MapCSS keyword.
     9 *
     10 * For example "<code>round</code>" is a keyword in
     11 * <pre>linecap: round;</pre>
     12 * Keywords are similar to a Java enum value. In accordance with the CSS
     13 * specification, they are parsed case insensitive.
     14 */
    715public class Keyword {
    816    public final String val;
  • trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java

    r11042 r11137  
    4141
    4242/**
    43  * This class manages the ElemStyles instance. The object you get with
    44  * getStyles() is read only, any manipulation happens via one of
    45  * the wrapper methods here. (readFromPreferences, moveStyles, ...)
     43 * This class manages the list of available map paint styles and gives access to
     44 * the ElemStyles singleton.
    4645 *
    47  * On change, mapPaintSylesUpdated() is fired for all listeners.
     46 * On change, {@link MapPaintSylesUpdateListener#mapPaintStylesUpdated()} is fired
     47 * for all listeners.
    4848 */
    4949public final class MapPaintStyles {
     
    6060
    6161    /**
    62      * Returns the {@link ElemStyles} instance.
    63      * @return the {@code ElemStyles} instance
     62     * Returns the {@link ElemStyles} singleton instance.
     63     *
     64     * The returned object is read only, any manipulation happens via one of
     65     * the other wrapper methods in this class. ({@link #readFromPreferences},
     66     * {@link #moveStyles}, ...)
     67     * @return the {@code ElemStyles} singleton instance
    6468     */
    6569    public static ElemStyles getStyles() {
Note: See TracChangeset for help on using the changeset viewer.