org.wicketstuff.openlayers3.api

Class JavascriptObject

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

All Implemented Interfaces:

IJavascriptObject

Direct Known Subclasses:

Coordinate, Feature, Feature, Fill, Image, Interaction, Layer, Loader, Map, Point, Projection, Source, Stroke, Style, Text, View

public abstract class JavascriptObject
extends Object
implements IJavascriptObject

Provides an interface that all Javascript objects must implement in order to be rendered properly.

Field Summary

Fields

Modifier and Type	Field and Description
static long	counter Counter for generating instance identifiers.
static String	JS_GLOBAL Global variable for holding all of our Javascript objects and data.
static Map<Object,String>	objectIds Map for starting object Ids.

Constructor Summary

Constructors

Constructor and Description
JavascriptObject() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	escapeQuoteJs(String text) Escapes single quotation marks in the provided String.
String	getJsId() Returns a String with the unique ID used to identify this object.
String	getJsIdWithSuffix(String suffix) Returns a String with the unique ID used to identify this object with the suffix appended.
abstract String	getJsType() Returns a String with the type of Javascript object that this object represents.
abstract String	renderJs() Returns a String with containing the rendered Javascript code for this object.

Methods inherited from class java.lang.Object

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

Field Detail

JS_GLOBAL

public static final String JS_GLOBAL

Global variable for holding all of our Javascript objects and data.

See Also:

Constant Field Values

counter

public static long counter

Counter for generating instance identifiers.

objectIds

public static Map<Object,String> objectIds

Map for starting object Ids.

Constructor Detail

JavascriptObject

public JavascriptObject()

Creates a new instance.

Method Detail

getJsType

public abstract String getJsType()

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

Returns:

String with the Javascript object type

getJsId

public String getJsId()

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

Specified by:

getJsId in interface IJavascriptObject

Returns:

String with the object's unique ID

getJsIdWithSuffix

public String getJsIdWithSuffix(String suffix)

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

Returns:

String with the object's unique ID

renderJs

public abstract String renderJs()

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

Specified by:

renderJs in interface IJavascriptObject

Returns:

String with rendered Javascript code

escapeQuoteJs

protected String escapeQuoteJs(String text)

Escapes single quotation marks in the provided String. When outputting Javascript code, we're using single quotation marks to surround the content.

Parameters:

text - Text to escape

Returns:

String with escaped text