org.wicketstuff.openlayers3.api.style

Class Circle

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.style.Style

org.wicketstuff.openlayers3.api.style.Circle

All Implemented Interfaces:

Serializable, IJavascriptObject

public class Circle
extends Style

Provides a class that models a circle style.

See Also:

Serialized Form

Field Summary

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

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
Circle(Fill fill, Number radius, boolean snapToPixel, Stroke stroke) Creates a new instance.
Circle(Fill fill, Number radius, Stroke stroke) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Circle	fill(Fill fill) Sets the fill for the style.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
Number	getRadius() Returns the radius of the circle.
Circle	image(Image image) Sets the image for this style.
boolean	isSnapToPixel() Returns the snap to pixel value.
Circle	radius(Number radius) Sets the radius of the circle.
String	renderAttributesJs()
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setRadius(Number radius) Sets the radius of the circle.
void	setSnapToPixel(boolean snapToPixel) Sets the snap to pixel value.
Circle	snapToPixel(boolean snapToPixel) Sets the snap to pixel value.
Circle	stroke(Stroke stroke) Sets the stroke for this style.
Circle	text(Text text) Sets the text for this style.
Style	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

Constructor Detail

Circle

public Circle(Fill fill,
              Number radius,
              Stroke stroke)

Creates a new instance.

Parameters:

fill - The fill for the circle

radius - The radius of the circle

stroke - The stroke for the circle

Circle

public Circle(Fill fill,
              Number radius,
              boolean snapToPixel,
              Stroke stroke)

Creates a new instance.

Parameters:

fill - The fill for the circle

radius - The radius of the circle

snapToPixel - Indicates if pixels or fractional values are used

stroke - The stroke for the circle

Method Detail

fill

public Circle 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 Circle 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 Circle 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 Circle 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 Style 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

getRadius

public Number getRadius()

Returns the radius of the circle.

Returns:

Current value

setRadius

public void setRadius(Number radius)

Sets the radius of the circle.

Parameters:

radius - New value

radius

public Circle radius(Number radius)

Sets the radius of the circle.

Parameters:

radius - New value

Returns:

This instance

isSnapToPixel

public boolean isSnapToPixel()

Returns the snap to pixel value.

Returns:

Current value

setSnapToPixel

public void setSnapToPixel(boolean snapToPixel)

Sets the snap to pixel value.

Parameters:

snapToPixel - New value

snapToPixel

public Circle snapToPixel(boolean snapToPixel)

Sets the snap to pixel value.

Parameters:

snapToPixel - New value

Returns:

This instace

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