org.wicketstuff.openlayers3.api.source

Class BingMaps

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.source.Source

org.wicketstuff.openlayers3.api.source.BingMaps

All Implemented Interfaces:

Serializable, IJavascriptObject

public class BingMaps
extends Source

Provides an object that models a Bing Maps source of map data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BingMaps.Culture Provides an enumeration of Bing Maps culture codes.
static class	BingMaps.ImagerySet Provides an enumeration of the valid Bing Maps imagery types.

Field Summary

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

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
BingMaps(BingMaps.Culture culture, String key, BingMaps.ImagerySet imagerySet) Creates a new instance.
BingMaps(String key, BingMaps.ImagerySet imagerySet) Creates a new instance with the default culture.

Method Summary

Methods

Modifier and Type	Method and Description
BingMaps	culture(BingMaps.Culture culture) Sets the culture for this instance.
BingMaps.Culture	getCulture() Returns the culture for this instance.
BingMaps.ImagerySet	getImagerySet() Returns the imagery set for this instance.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
String	getKey() Returns the Bing Maps API key for this instance.
BingMaps	imagerySet(BingMaps.ImagerySet imagerySet) Sets the imagery set for this instance.
BingMaps	key(String key) Sets the Bing Maps API key for this instance.
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setCulture(BingMaps.Culture culture) Sets the culture for this instance.
void	setImagerySet(BingMaps.ImagerySet imagerySet) Sets the imagery set for this instance.
void	setKey(String key) Sets the Bing Maps API key for this instance.

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

escapeQuoteJs, getJsId, getJsIdWithSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

BingMaps

public BingMaps(String key,
        BingMaps.ImagerySet imagerySet)

Creates a new instance with the default culture.

Parameters:

key - Bing Maps API key

imagerySet - Imagery set type to display

BingMaps

public BingMaps(BingMaps.Culture culture,
        String key,
        BingMaps.ImagerySet imagerySet)

Creates a new instance.

Parameters:

culture - Culture, used for displaying labels, etc.

key - The Bing Maps API key

imagerySet - Imagery set type to display

Method Detail

getCulture

public BingMaps.Culture getCulture()

Returns the culture for this instance.

Returns:

Culture for this instance

setCulture

public void setCulture(BingMaps.Culture culture)

Sets the culture for this instance.

Parameters:

culture - New value

culture

public BingMaps culture(BingMaps.Culture culture)

Sets the culture for this instance.

Parameters:

culture - New value

Returns:

This instance

getKey

public String getKey()

Returns the Bing Maps API key for this instance.

Returns:

Current value

setKey

public void setKey(String key)

Sets the Bing Maps API key for this instance.

Parameters:

key - New value

key

public BingMaps key(String key)

Sets the Bing Maps API key for this instance.

Parameters:

key - New value

Returns:

This instance

getImagerySet

public BingMaps.ImagerySet getImagerySet()

Returns the imagery set for this instance.

Returns:

Current value

setImagerySet

public void setImagerySet(BingMaps.ImagerySet imagerySet)

Sets the imagery set for this instance.

Parameters:

imagerySet - New value

imagerySet

public BingMaps imagerySet(BingMaps.ImagerySet imagerySet)

Sets the imagery set for this instance.

Parameters:

imagerySet - New value

Returns:

This instance

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 Source

Returns:

String with the Javascript object type

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 Source

Returns:

String with rendered Javascript code