org.wicketstuff.openlayers3.api

Class Map

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.Map

All Implemented Interfaces:

Serializable, IJavascriptObject

public class Map
extends JavascriptObject
implements Serializable

Provides an object that models an OpenLayer Map instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Map.RenderType Provides an enumeration of the valid render types.

Field Summary

Fields inherited from class org.wicketstuff.openlayers3.api.JavascriptObject

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
Map(List<Layer> layers) Creates a new instance.
Map(List<Layer> layers, List<Overlay> overlays) Creates a new instance.
Map(List<Layer> layers, List<Overlay> overlays, View view) Creates a new instance.
Map(List<Layer> layers, View view) Creates a new instance.
Map(Map.RenderType renderer, List<Layer> layers) Creates a new instance.
Map(Map.RenderType renderer, List<Layer> layers, List<Overlay> overlays, View view) Creates a new instance.
Map(Map.RenderType renderer, List<Layer> layers, List<Overlay> overlays, View view, List<Interaction> interactions) Creates a new instance.
Map(Map.RenderType renderer, List<Layer> layers, View view) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<Interaction>	getInteractions()
String	getJsId() Returns a String with the unique ID used to identify this object.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
List<Layer>	getLayers() Returns the layers for this map.
List<Overlay>	getOverlays() Returns the overlays for this map.
Map.RenderType	getRenderer() Returns the renderer for this map.
String	getTarget() Returns the target element ID to which this map is tied.
View	getView() Returns the view for this map.
Map	interactions(List<Interaction> interactions)
Map	Layers(List<Layer> layers) Sets the layers for this map.
Map	overlays(List<Overlay> overlays) Sets the overlays for this map.
Map	renderer(Map.RenderType renderer) Sets the renderer for this map.
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setInteractions(List<Interaction> interactions)
void	setLayers(List<Layer> layers) Sets the layers for this map.
void	setOverlays(List<Overlay> overlays) Sets the overlays for this map.
void	setRenderer(Map.RenderType renderer) Sets the renderer for this map.
void	setTarget(String target) Sets the target Wicket element for this map.
void	setView(View view) Sets the view for this map.
Map	view(View view) Sets the view for this map.

Methods inherited from class org.wicketstuff.openlayers3.api.JavascriptObject

escapeQuoteJs, getJsIdWithSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

Map

public Map(List<Layer> layers)

Creates a new instance.

Parameters:

layers - Layers for this map

Map

public Map(Map.RenderType renderer,
           List<Layer> layers)

Creates a new instance.

Parameters:

renderer - The renderer for this map

layers - Layers for this map

Map

public Map(List<Layer> layers,
           View view)

Creates a new instance.

Parameters:

layers - The layers for this map

view - The view for this map

Map

public Map(Map.RenderType renderer,
           List<Layer> layers,
           View view)

Creates a new instance.

Parameters:

renderer - The renderer for this map

layers - The layers for this map

view - The view for this map

Map

public Map(List<Layer> layers,
           List<Overlay> overlays,
           View view)

Creates a new instance.

Parameters:

layers - The layers for this map

overlays - The overlays for this map

view - The view for this map

Map

public Map(List<Layer> layers,
           List<Overlay> overlays)

Creates a new instance.

Parameters:

layers - The layers for this map

overlays - The overlays for this map

Map

public Map(Map.RenderType renderer,
           List<Layer> layers,
           List<Overlay> overlays,
           View view)

Creates a new instance.

Parameters:

renderer - The renderer for this map

layers - The layers for this map

overlays - The overlays for this map

view - The view for this map

Map

public Map(Map.RenderType renderer,
           List<Layer> layers,
           List<Overlay> overlays,
           View view,
           List<Interaction> interactions)

Creates a new instance.

Parameters:

renderer - The renderer for this map

layers - The layers for this map

overlays - The overlays for this map

view - The view for this map

interactions - Interactions for the map

Method Detail

getTarget

public String getTarget()

Returns the target element ID to which this map is tied.

Returns:

Wicket element ID

setTarget

public void setTarget(String target)

Sets the target Wicket element for this map. Normally this is called by Wicket during configuration time.

Parameters:

target - Target Wicket element ID

getRenderer

public Map.RenderType getRenderer()

Returns the renderer for this map.

Returns:

Renderer

setRenderer

public void setRenderer(Map.RenderType renderer)

Sets the renderer for this map.

Parameters:

renderer - Renderer

getLayers

public List<Layer> getLayers()

Returns the layers for this map.

Returns:

List of layers

setLayers

public void setLayers(List<Layer> layers)

Sets the layers for this map.

Parameters:

layers - List of layers

getOverlays

public List<Overlay> getOverlays()

Returns the overlays for this map.

Returns:

List of overlays

setOverlays

public void setOverlays(List<Overlay> overlays)

Sets the overlays for this map.

Parameters:

overlays - List of overlays

getView

public View getView()

Returns the view for this map.

Returns:

View

setView

public void setView(View view)

Sets the view for this map.

Parameters:

view - View for this map

view

public Map view(View view)

Sets the view for this map.

Parameters:

view - View for this map

Returns:

This instance

overlays

public Map overlays(List<Overlay> overlays)

Sets the overlays for this map.

Parameters:

overlays - List of overlays

Returns:

This instance

renderer

public Map renderer(Map.RenderType renderer)

Sets the renderer for this map.

Parameters:

renderer - Render for this map

Returns:

This instance

Layers

public Map Layers(List<Layer> layers)

Sets the layers for this map.

Parameters:

layers - List of layers

Returns:

This instance

getInteractions

public List<Interaction> getInteractions()

setInteractions

public void setInteractions(List<Interaction> interactions)

interactions

public Map interactions(List<Interaction> interactions)

getJsType

public String getJsType()

Description copied from class: JavascriptObject

Returns a String with the type of Javascript object that this object represents. This will be used when creating new instances.

Specified by:

getJsType in interface IJavascriptObject

Specified by:

getJsType in class JavascriptObject

Returns:

String with the Javascript object type

getJsId

public String getJsId()

Description copied from class: JavascriptObject

Returns a String with the unique ID used to identify this object.

Specified by:

getJsId in interface IJavascriptObject

Overrides:

getJsId in class JavascriptObject

Returns:

String with the object's unique ID

renderJs

public String renderJs()

Description copied from class: JavascriptObject

Returns a String with containing the rendered Javascript code for this object.

Specified by:

renderJs in interface IJavascriptObject

Specified by:

renderJs in class JavascriptObject

Returns:

String with rendered Javascript code