org.openstreetmap.josm.gui.mappaint

Class MapPaintStyles

java.lang.Object

org.openstreetmap.josm.gui.mappaint.MapPaintStyles

public final class MapPaintStyles
extends java.lang.Object

This class manages the list of available map paint styles and gives access to the ElemStyles singleton. On change, MapPaintStyles.MapPaintSylesUpdateListener.mapPaintStylesUpdated() is fired for all listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapPaintStyles.IconReference IconReference is used to remember the associated style source for each icon URL.
static class	MapPaintStyles.MapPaintStyleLoader
static interface	MapPaintStyles.MapPaintSylesUpdateListener MapPaintSylesUpdateListener & related code (get informed when the list of MapPaint StyleSources changes)
static class	MapPaintStyles.TagKeyReference Value holder for a reference to a tag name.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Collection<java.lang.String>	DEPRECATED_IMAGE_NAMES
private static java.util.concurrent.CopyOnWriteArrayList<MapPaintStyles.MapPaintSylesUpdateListener>	listeners
private static ElemStyles	styles

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MapPaintStyles()

Method Summary

Modifier and Type	Method and Description
static void	addMapPaintSylesUpdateListener(MapPaintStyles.MapPaintSylesUpdateListener listener)
static StyleSource	addStyle(SourceEntry entry) Add a new map paint style.
static boolean	canMoveStyles(int[] sel, int i)
static void	fireMapPaintStyleEntryUpdated(int idx)
static void	fireMapPaintSylesUpdated()
private static StyleSource	fromSourceEntry(SourceEntry entry)
static javax.swing.ImageIcon	getIcon(MapPaintStyles.IconReference ref, int width, int height) Return scaled icon.
static ImageProvider	getIconProvider(MapPaintStyles.IconReference ref, boolean test) Image provider for icon.
static java.util.List<java.lang.String>	getIconSourceDirs(StyleSource source)
static javax.swing.ImageIcon	getNodeIcon(Tag tag)
static javax.swing.ImageIcon	getNodeIcon(Tag tag, boolean includeDeprecatedIcon) Returns the node icon that would be displayed for the given tag.
static javax.swing.ImageIcon	getNoIconIcon(StyleSource source) No icon with the given name was found, show a dummy icon instead
static ElemStyles	getStyles() Returns the ElemStyles singleton instance.
private static void	loadStyleForFirstTime(StyleSource source)
static void	moveStyles(int[] sel, int delta) Move position of entries in the current list of StyleSources
static void	readFromPreferences()
static void	reloadStyles(int... sel) reload styles preferences are the same, but the file source may have changed
static void	removeMapPaintSylesUpdateListener(MapPaintStyles.MapPaintSylesUpdateListener listener)
static void	toggleStyleActive(int... sel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEPRECATED_IMAGE_NAMES

private static final java.util.Collection<java.lang.String> DEPRECATED_IMAGE_NAMES

styles

private static ElemStyles styles

listeners

private static final java.util.concurrent.CopyOnWriteArrayList<MapPaintStyles.MapPaintSylesUpdateListener> listeners

Constructor Detail

MapPaintStyles

private MapPaintStyles()

Method Detail

getStyles

public static ElemStyles getStyles()

Returns the ElemStyles singleton instance. The returned object is read only, any manipulation happens via one of the other wrapper methods in this class. (readFromPreferences(), moveStyles(int[], int), ...)

Returns:

the ElemStyles singleton instance

getIconProvider

public static ImageProvider getIconProvider(MapPaintStyles.IconReference ref,
                                            boolean test)

Image provider for icon. Note that this is a provider only. A @link{ImageProvider#get()} call may still fail!

Parameters:

ref - reference to the requested icon

test - if true than the icon is request is tested

Returns:

image provider for icon (can be null when test is true).

Since:

8097

See Also:

getIcon(IconReference, int,int)

getIcon

public static javax.swing.ImageIcon getIcon(MapPaintStyles.IconReference ref,
                                            int width,
                                            int height)

Return scaled icon.

Parameters:

ref - reference to the requested icon

width - icon width or -1 for autoscale

height - icon height or -1 for autoscale

Returns:

image icon or null.

See Also:

getIconProvider(IconReference, boolean)

getNoIconIcon

public static javax.swing.ImageIcon getNoIconIcon(StyleSource source)

No icon with the given name was found, show a dummy icon instead

Parameters:

source - style source

Returns:

the icon misc/no_icon.png, in descending priority: - relative to source file - from user icon paths - josm's default icon can be null if the defaults are turned off by user

getNodeIcon

public static javax.swing.ImageIcon getNodeIcon(Tag tag)

getNodeIcon

public static javax.swing.ImageIcon getNodeIcon(Tag tag,
                                                boolean includeDeprecatedIcon)

Returns the node icon that would be displayed for the given tag.

Parameters:

tag - The tag to look an icon for

includeDeprecatedIcon - if true, the special deprecated icon will be returned if applicable

Returns:

null if no icon found, or if the icon is deprecated and not wanted

getIconSourceDirs

public static java.util.List<java.lang.String> getIconSourceDirs(StyleSource source)

readFromPreferences

public static void readFromPreferences()

loadStyleForFirstTime

private static void loadStyleForFirstTime(StyleSource source)

fromSourceEntry

private static StyleSource fromSourceEntry(SourceEntry entry)

reloadStyles

public static void reloadStyles(int... sel)

reload styles preferences are the same, but the file source may have changed

Parameters:

sel - the indices of styles to reload

moveStyles

public static void moveStyles(int[] sel,
                              int delta)

Move position of entries in the current list of StyleSources

Parameters:

sel - The indices of styles to be moved.

delta - The number of lines it should move. positive int moves down and negative moves up.

canMoveStyles

public static boolean canMoveStyles(int[] sel,
                                    int i)

toggleStyleActive

public static void toggleStyleActive(int... sel)

addStyle

public static StyleSource addStyle(SourceEntry entry)

Add a new map paint style.

Parameters:

entry - map paint style

Returns:

loaded style source, or null

addMapPaintSylesUpdateListener

public static void addMapPaintSylesUpdateListener(MapPaintStyles.MapPaintSylesUpdateListener listener)

removeMapPaintSylesUpdateListener

public static void removeMapPaintSylesUpdateListener(MapPaintStyles.MapPaintSylesUpdateListener listener)

fireMapPaintSylesUpdated

public static void fireMapPaintSylesUpdated()

fireMapPaintStyleEntryUpdated

public static void fireMapPaintStyleEntryUpdated(int idx)