org.wicketstuff.openlayers3.api.style

Class ClusterStyle

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.style.Style

org.wicketstuff.openlayers3.api.style.ClusterStyle

All Implemented Interfaces:

Serializable, IJavascriptObject

public class ClusterStyle
extends Style

Provides a style for clusters.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	DEFAULT_MAXIMUM_RADIUS Default maximum radius.
static Integer	DEFAULT_MINIMUM_RADIUS Default minimum radius.

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

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
ClusterStyle(Circle circle, Text text) Creates a new instance.
ClusterStyle(Circle circle, Text text, Number minimumRadius, Number maximumRadius) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
ClusterStyle	circle(Circle circle) Sets the circle style.
ClusterStyle	fill(Fill fill) Sets the fill for the style.
Circle	getCircle() Returns the circle style.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
Number	getMaximumRadius() Returns the maximum radius.
Number	getMinimumRadius() Returns the minimum radius.
ClusterStyle	image(Image image) Sets the image for this style.
ClusterStyle	maximumRadius(Number maximumRadius) Sets the maximum radius.
ClusterStyle	minimumRadius(Number minimumRadius) Sets the minimum radius.
String	renderAttributesJs()
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setCircle(Circle circle) Sets the circle style.
void	setMaximumRadius(Number maximumRadius) Sets the maximum radius.
void	setMinimumRadius(Number minimumRadius) Sets the minimum radius.
ClusterStyle	stroke(Stroke stroke) Sets the stroke for this style.
ClusterStyle	text(Text text) Sets the text for this style.
ClusterStyle	zIndex(Number zIndex) Sets the z-index for this style.

Methods inherited from class org.wicketstuff.openlayers3.api.style.Style

getFill, getImage, getStroke, getText, getzIndex, setFill, setImage, setStroke, setText, setzIndex

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

Field Detail

DEFAULT_MINIMUM_RADIUS

public static final Integer DEFAULT_MINIMUM_RADIUS

Default minimum radius.

DEFAULT_MAXIMUM_RADIUS

public static final Integer DEFAULT_MAXIMUM_RADIUS

Default maximum radius.

Constructor Detail

ClusterStyle

public ClusterStyle(Circle circle,
            Text text)

Creates a new instance.

Parameters:

circle - Circle style used when drawing clusters

text - Text style used when drawing clusters

ClusterStyle

public ClusterStyle(Circle circle,
            Text text,
            Number minimumRadius,
            Number maximumRadius)

Creates a new instance.

Parameters:

circle - Circle style used when drawing clusters

text - Text style used when drawing clusters

minimumRadius - Minimum radius of clusters

maximumRadius - Maximum radius of clusters

Method Detail

fill

public ClusterStyle fill(Fill fill)

Description copied from class: Style

Sets the fill for the style.

Overrides:

fill in class Style

Parameters:

fill - New value

Returns:

This instance

image

public ClusterStyle image(Image image)

Description copied from class: Style

Sets the image for this style.

Overrides:

image in class Style

Parameters:

image - New value

Returns:

This instance

stroke

public ClusterStyle stroke(Stroke stroke)

Description copied from class: Style

Sets the stroke for this style.

Overrides:

stroke in class Style

Parameters:

stroke - New value

Returns:

This instance

text

public ClusterStyle text(Text text)

Description copied from class: Style

Sets the text for this style.

Overrides:

text in class Style

Parameters:

text - New value

Returns:

This instance

zIndex

public ClusterStyle zIndex(Number zIndex)

Description copied from class: Style

Sets the z-index for this style.

Overrides:

zIndex in class Style

Parameters:

zIndex - New value

Returns:

This instance

getCircle

public Circle getCircle()

Returns the circle style.

Returns:

Current value

setCircle

public void setCircle(Circle circle)

Sets the circle style.

Parameters:

circle - New value

circle

public ClusterStyle circle(Circle circle)

Sets the circle style.

Parameters:

circle - New value

Returns:

This instance

getMinimumRadius

public Number getMinimumRadius()

Returns the minimum radius.

Returns:

Current value

setMinimumRadius

public void setMinimumRadius(Number minimumRadius)

Sets the minimum radius.

Parameters:

minimumRadius - New value

minimumRadius

public ClusterStyle minimumRadius(Number minimumRadius)

Sets the minimum radius.

Parameters:

minimumRadius - New value

Returns:

This instance

getMaximumRadius

public Number getMaximumRadius()

Returns the maximum radius.

Returns:

Current value

setMaximumRadius

public void setMaximumRadius(Number maximumRadius)

Sets the maximum radius.

Parameters:

maximumRadius - New value

maximumRadius

public ClusterStyle maximumRadius(Number maximumRadius)

Sets the maximum radius.

Parameters:

maximumRadius - 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

Overrides:

getJsType in class Style

Returns:

String with the Javascript object type

renderAttributesJs

public String renderAttributesJs()

Overrides:

renderAttributesJs in class Style

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

Overrides:

renderJs in class Style

Returns:

String with rendered Javascript code