public final class MapRendererFactory extends Object
MapRendererFactory manages a list of map renderer classes and associated meta data (display name, description).
Plugins can implement and supply their own map renderers.
Sample code in a plugin
public class MyMapRenderer extends AbstractMapRenderer {
// ....
}
// to be called when the plugin is created
MapRendererFactory factory = MapRendererFactory.getInstance();
factory.register(MyMapRenderer.class, "My map renderer", "This is is a fast map renderer");
factory.activate(MyMapRenderer.class);
| Modifier and Type | Class and Description |
|---|---|
static class |
MapRendererFactory.Descriptor |
static class |
MapRendererFactory.MapRendererFactoryException |
| Modifier and Type | Field and Description |
|---|---|
private Class<? extends AbstractMapRenderer> |
activeRenderer |
private List<MapRendererFactory.Descriptor> |
descriptors |
private static MapRendererFactory |
instance |
static String |
PREF_KEY_RENDERER_CLASS_NAME
preference key for the renderer class name.
|
| Modifier | Constructor and Description |
|---|---|
private |
MapRendererFactory() |
| Modifier and Type | Method and Description |
|---|---|
void |
activate(Class<? extends AbstractMapRenderer> renderer)
Activates a map renderer class.
|
void |
activateDefault()
Activates the default map renderer.
|
private void |
activateMapRenderer(String rendererClassName) |
AbstractMapRenderer |
createActiveRenderer(Graphics2D g,
NavigatableComponent viewport,
boolean isInactiveMode)
Creates an instance of the currently active renderer.
|
static MapRendererFactory |
getInstance()
Replies the unique instance
|
List<MapRendererFactory.Descriptor> |
getMapRendererDescriptors()
Replies the (unmodifiable) list of map renderer descriptors.
|
boolean |
isRegistered(Class<? extends AbstractMapRenderer> renderer)
Replies true, if
Renderer is already a registered map renderer
class. |
boolean |
isWireframeMapRendererActive()
Replies true, if currently the wireframe map renderer is active.
|
private static Class<?> |
loadRendererClass(String className) |
void |
register(Class<? extends AbstractMapRenderer> renderer,
String displayName,
String description)
Registers a map renderer class.
|
private void |
registerDefaultRenderers() |
void |
unregister(Class<? extends AbstractMapRenderer> renderer)
Unregisters a map renderer class.
|
public static final String PREF_KEY_RENDERER_CLASS_NAME
StyledMapRendererprivate static MapRendererFactory instance
private final List<MapRendererFactory.Descriptor> descriptors
private Class<? extends AbstractMapRenderer> activeRenderer
private MapRendererFactory()
public static MapRendererFactory getInstance()
private static Class<?> loadRendererClass(String className)
private void activateMapRenderer(String rendererClassName)
private void registerDefaultRenderers()
public boolean isRegistered(Class<? extends AbstractMapRenderer> renderer)
Replies true, if Renderer is already a registered map renderer
class.
renderer - the map renderer class. Must not be null.Renderer is already a registered map renderer
classIllegalArgumentException - if renderer is nullpublic void register(Class<? extends AbstractMapRenderer> renderer, String displayName, String description)
Registers a map renderer class.
renderer - the map renderer class. Must not be null.displayName - the display name to be displayed in UIs (i.e. in the preference dialog)description - the descriptionIllegalArgumentException - if renderer is nullIllegalStateException - if renderer is already registeredpublic void unregister(Class<? extends AbstractMapRenderer> renderer)
Unregisters a map renderer class.
If the respective class is also the active renderer, the renderer is reset to the default renderer.
renderer - the map renderer class. Must not be null.public void activate(Class<? extends AbstractMapRenderer> renderer)
Activates a map renderer class.
The renderer class must already be registered.
renderer - the map renderer class. Must not be null.IllegalArgumentException - if renderer is nullIllegalStateException - if renderer isn't registered yetpublic void activateDefault()
Activates the default map renderer.
IllegalStateException - if the default renderer StyledMapRenderer isn't registeredpublic AbstractMapRenderer createActiveRenderer(Graphics2D g, NavigatableComponent viewport, boolean isInactiveMode) throws MapRendererFactory.MapRendererFactoryException
Creates an instance of the currently active renderer.
g - Graphicsviewport - Navigatable componentisInactiveMode - true if the paint visitor shall render OSM objects such that they look inactiveMapRendererFactory.MapRendererFactoryException - if creating an instance failsAbstractMapRenderer.AbstractMapRenderer(Graphics2D, NavigatableComponent, boolean)public List<MapRendererFactory.Descriptor> getMapRendererDescriptors()
Replies the (unmodifiable) list of map renderer descriptors.
public boolean isWireframeMapRendererActive()
Replies true, if currently the wireframe map renderer is active. Otherwise, false.
There is a specific method for WireframeMapRenderer for legacy support.
Until 03/2011 there were only two possible map renderers in JOSM: the wireframe
renderer and the styled renderer. For the time being there are still UI elements
(menu entries, etc.) which toggle between these two renderers only.