org.wicketstuff.openlayers3.api.style

Class Icon

java.lang.Object

org.wicketstuff.openlayers3.api.JavascriptObject

org.wicketstuff.openlayers3.api.style.Image

org.wicketstuff.openlayers3.api.style.Icon

All Implemented Interfaces:

Serializable, IJavascriptObject

public class Icon
extends Image

Provides a class that models an icon style for vector features.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Icon.Origin Enumeration of value anchor origin values.
static class	Icon.Unit Enumeration of valid units by which the anchor's "X" or "Y" value is specified.

Field Summary

Fields

Modifier and Type	Field and Description
static Coordinate	DEFAULT_COORDINATE Default anchor coordinate for new instances (center the icon relative to the feature).

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

counter, JS_GLOBAL, objectIds

Constructor Summary

Constructors

Constructor and Description
Icon(Coordinate anchor, Icon.Origin anchorOrigin, Icon.Unit anchorXUnits, Icon.Unit anchorYUnits, Number opacity, String src, CorsPolicy crossOrigin) Creates a new instance.
Icon(Coordinate anchor, String src) Creates a new instance.
Icon(String src) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Icon	anchor(Coordinate anchor) Sets the anchor's coordinate.
Icon	anchorOrigin(Icon.Origin anchorOrigin) Sets the position of the anchor relative to the feature.
Icon	anchorXUnits(Icon.Unit anchorXUnits) Sets the unit for calculating the anchor's "X" position.
Icon	anchorYUnits(Icon.Unit anchorYUnits) Sets the unit for calculating the anchor's "Y" position.
Icon	crossOrigin(CorsPolicy crossOrigin) Sets the CORS (Cross Origin Resource Sharing) policy for this icon.
Coordinate	getAnchor() Returns the anchor's coordinate.
Icon.Origin	getAnchorOrigin() Sets the position of the anchor relative to the feature.
Icon.Unit	getAnchorXUnits() Returns the unit for calculating the anchor's "X" position.
Icon.Unit	getAnchorYUnits() Returns the unit for calculating the anchor's "Y" position.
CorsPolicy	getCrossOrigin() Returns the CORS (Cross Origin Resource Sharing) policy for this icon.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
Number	getOpacity() Returns the opacity of the icon.
String	getSrc() Returns the URL is the image for the icon.
Icon	opacity(Number opacity) Sets the opacity of the icon.
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
Icon	rotation(Number number) Sets the rotation of the image.
Icon	scale(Number scale) Sets the scale of the image.
void	setAnchor(Coordinate anchor) Sets the anchor's coordinate.
void	setAnchorOrigin(Icon.Origin anchorOrigin) Sets the position of the anchor relative to the feature.
void	setAnchorXUnits(Icon.Unit anchorXUnits) Sets the unit for calculating the anchor's "X" position.
void	setAnchorYUnits(Icon.Unit anchorYUnits) Sets the unit for calculating the anchor's "Y" position.
void	setCrossOrigin(CorsPolicy crossOrigin) Sets the CORS (Cross Origin Resource Sharing) policy for this icon.
void	setOpacity(Number opacity) Sets the opacity of the icon.
void	setSrc(String src) Sets the URL with the image for the icon.
Icon	src(String src) Sets the URL with the image for the icon.

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

getRotation, getScale, renderAttributesJs, setRotation, setScale

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_COORDINATE

public static final Coordinate DEFAULT_COORDINATE

Default anchor coordinate for new instances (center the icon relative to the feature).

Constructor Detail

Icon

public Icon(String src)

Creates a new instance.

Parameters:

src - String with the URL for the image for this icon

Icon

public Icon(Coordinate anchor,
    String src)

Creates a new instance.

Parameters:

anchor - Anchor position for this icon

src - String with the URL for the image for this icon

Icon

public Icon(Coordinate anchor,
    Icon.Origin anchorOrigin,
    Icon.Unit anchorXUnits,
    Icon.Unit anchorYUnits,
    Number opacity,
    String src,
    CorsPolicy crossOrigin)

Creates a new instance.

Parameters:

anchor - Anchor position for this icon

anchorOrigin - Position of the anchor relative to the feature

anchorXUnits - Unit for calculating the anchor's "X" position

anchorYUnits - Unit for calculating the anchor's "Y" position

opacity - Opacity of the icon

src - String with the URL for the image for this icon

crossOrigin - CORS policy

Method Detail

getAnchor

public Coordinate getAnchor()

Returns the anchor's coordinate.

Returns:

Coordinate

setAnchor

public void setAnchor(Coordinate anchor)

Sets the anchor's coordinate.

Parameters:

anchor - New value

anchor

public Icon anchor(Coordinate anchor)

Sets the anchor's coordinate.

Parameters:

anchor - New value

Returns:

This instance

getAnchorOrigin

public Icon.Origin getAnchorOrigin()

Sets the position of the anchor relative to the feature.

Returns:

Anchor origin

setAnchorOrigin

public void setAnchorOrigin(Icon.Origin anchorOrigin)

Sets the position of the anchor relative to the feature.

Parameters:

anchorOrigin - New value

anchorOrigin

public Icon anchorOrigin(Icon.Origin anchorOrigin)

Sets the position of the anchor relative to the feature.

Parameters:

anchorOrigin - New value

Returns:

This instancep

getAnchorXUnits

public Icon.Unit getAnchorXUnits()

Returns the unit for calculating the anchor's "X" position.

Returns:

Anchor "X" unit

setAnchorXUnits

public void setAnchorXUnits(Icon.Unit anchorXUnits)

Sets the unit for calculating the anchor's "X" position.

Parameters:

anchorXUnits -

anchorXUnits

public Icon anchorXUnits(Icon.Unit anchorXUnits)

Sets the unit for calculating the anchor's "X" position.

Parameters:

anchorXUnits - New value

Returns:

This instance

getAnchorYUnits

public Icon.Unit getAnchorYUnits()

Returns the unit for calculating the anchor's "Y" position.

Returns:

Unit for calculating the anchor's "Y" position

setAnchorYUnits

public void setAnchorYUnits(Icon.Unit anchorYUnits)

Sets the unit for calculating the anchor's "Y" position.

Parameters:

anchorYUnits - New value

anchorYUnits

public Icon anchorYUnits(Icon.Unit anchorYUnits)

Sets the unit for calculating the anchor's "Y" position.

Parameters:

anchorYUnits - New value

Returns:

This instance

getOpacity

public Number getOpacity()

Returns the opacity of the icon.

Returns:

Opacity of the icon

setOpacity

public void setOpacity(Number opacity)

Sets the opacity of the icon.

Parameters:

opacity - New value

opacity

public Icon opacity(Number opacity)

Sets the opacity of the icon.

Parameters:

opacity - New value

Returns:

This instance

getSrc

public String getSrc()

Returns the URL is the image for the icon.

Returns:

String with the URL for the image

setSrc

public void setSrc(String src)

Sets the URL with the image for the icon.

Parameters:

src - New value

src

public Icon src(String src)

Sets the URL with the image for the icon.

Parameters:

src - New value

Returns:

This instance

getCrossOrigin

public CorsPolicy getCrossOrigin()

Returns the CORS (Cross Origin Resource Sharing) policy for this icon.

Returns:

CORS policy

setCrossOrigin

public void setCrossOrigin(CorsPolicy crossOrigin)

Sets the CORS (Cross Origin Resource Sharing) policy for this icon.

Parameters:

crossOrigin - CORS policy

crossOrigin

public Icon crossOrigin(CorsPolicy crossOrigin)

Sets the CORS (Cross Origin Resource Sharing) policy for this icon.

Parameters:

crossOrigin - CORS policy

Returns:

This instance

rotation

public Icon rotation(Number number)

Description copied from class: Image

Sets the rotation of the image.

Overrides:

rotation in class Image

Parameters:

number - New value

Returns:

This instance

scale

public Icon scale(Number scale)

Description copied from class: Image

Sets the scale of the image.

Overrides:

scale in class Image

Parameters:

scale - 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 Image

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

Overrides:

renderJs in class Image

Returns:

String with rendered Javascript code