org.wicketstuff.openlayers3.api.overlay

Class Overlay

java.lang.Object

org.wicketstuff.openlayers3.api.overlay.Overlay

All Implemented Interfaces:

Serializable, IJavascriptObject

Direct Known Subclasses:

Popover, PopoverOverlay

public class Overlay
extends Object
implements IJavascriptObject, Serializable

Provides an object that models a map overlay.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Overlay.Positioning Enumeration of valid overlay positioning values.

Field Summary

Fields

Modifier and Type	Field and Description
static Overlay.Positioning	DEFAULT_POSITIONING Default positioning.
static Boolean	DEFAULT_STOP_EVENT Default stop event value.
protected org.apache.wicket.Component	element Wicket component tied to this overlay.
LongLat	position The position of the overlay in the map projection.
Overlay.Positioning	positioning Defines how the overlay is actually positioned with respect to its position property.
Boolean	stopEvent Whether event propagation to the map viewport should be stopped.

Constructor Summary

Constructors

Constructor and Description
Overlay() Creates a new instance.
Overlay(org.apache.wicket.Component component) Creates a new instance.
Overlay(org.apache.wicket.Component component, LongLat position) Creates a new instance.
Overlay(org.apache.wicket.Component component, LongLat position, Overlay.Positioning positioning) Creates a new instance.
Overlay(org.apache.wicket.Component component, LongLat position, Overlay.Positioning positioning, Boolean stopEvent) Creates a new instance.
Overlay(org.apache.wicket.Component component, Overlay.Positioning positioning) Creates a new instance.
Overlay(LongLat position) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Overlay	element(org.apache.wicket.Component element) Sets the element linked to this overlay.
protected String	escapeQuoteJs(String text) Escapes single quotation marks in the provided String.
org.apache.wicket.Component	getElement() Returns the element linked to this overlay.
String	getJsId() Returns a String with the unique ID used to identify this object.
String	getJsType() Returns a String with the type of Javascript object that this object represents.
LongLat	getPosition() Returns the position of the overlay.
Overlay.Positioning	getPositioning() Returns the positioning of this overlay.
Boolean	getStopEvent() Returns the stop event value.
Overlay	position(LongLat position) Sets the position of the overlay.
Overlay	positioning(Overlay.Positioning positioning) Sets the positioning of this overlay.
protected String	renderAttributesJs()
String	renderJs() Returns a String with containing the rendered Javascript code for this object.
void	setElement(org.apache.wicket.Component element) Sets the element linked to this overlay.
void	setPosition(LongLat position) Sets the position of the overlay.
void	setPositioning(Overlay.Positioning positioning) Sets the positioning of this overlay.
void	setStopEvent(Boolean stopEvent) Sets the stop event value.
Overlay	stopEvent(Boolean stopEvent) Sets the stop event value.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POSITIONING

public static final Overlay.Positioning DEFAULT_POSITIONING

Default positioning.

DEFAULT_STOP_EVENT

public static final Boolean DEFAULT_STOP_EVENT

Default stop event value.

position

public LongLat position

The position of the overlay in the map projection.

positioning

public Overlay.Positioning positioning

Defines how the overlay is actually positioned with respect to its position property.

stopEvent

public Boolean stopEvent

Whether event propagation to the map viewport should be stopped. Default is true. If true the overlay is placed in the same container as that of the controls (CSS class name ol-overlaycontainer-stopevent); if false it is placed in the container with CSS class name ol-overlaycontainer.

element

protected org.apache.wicket.Component element

Wicket component tied to this overlay.

Constructor Detail

Overlay

public Overlay()

Creates a new instance.

Overlay

public Overlay(LongLat position)

Creates a new instance.

Parameters:

position - The position of the overlay

Overlay

public Overlay(org.apache.wicket.Component component)

Creates a new instance.

Parameters:

component - The component linked to this overlay

Overlay

public Overlay(org.apache.wicket.Component component,
       LongLat position)

Creates a new instance.

Parameters:

component - The component linked to this overlay

position - The position of the overlay

Overlay

public Overlay(org.apache.wicket.Component component,
       Overlay.Positioning positioning)

Creates a new instance.

Parameters:

component - The component linked to this overlay

positioning - Defines how the overlay is actually positioned with respect to its position property.

Overlay

public Overlay(org.apache.wicket.Component component,
       LongLat position,
       Overlay.Positioning positioning)

Creates a new instance.

Parameters:

component - The component linked to this overlay

position - The position of the overlay

positioning - Defines how the overlay is actually positioned with respect to its position property.

Overlay

public Overlay(org.apache.wicket.Component component,
       LongLat position,
       Overlay.Positioning positioning,
       Boolean stopEvent)

Creates a new instance.

Parameters:

component - The component linked to this overlay

position - The position of the overlay

positioning - Defines how the overlay is actually positioned with respect to its position property.

stopEvent - Whether event propagation to the map viewport should be stopped. Default is true. If true the overlay is placed in the same container as that of the controls (CSS class name ol-overlaycontainer-stopevent); if false it is placed in the container with CSS class name ol-overlaycontainer.

Method Detail

getPosition

public LongLat getPosition()

Returns the position of the overlay.

Returns:

Coordinate with the overlay's position

setPosition

public void setPosition(LongLat position)

Sets the position of the overlay.

Parameters:

position - Coordinate for the overlay's position

position

public Overlay position(LongLat position)

Sets the position of the overlay.

Parameters:

position - Coordinate for the overlay's position

Returns:

This instance

getPositioning

public Overlay.Positioning getPositioning()

Returns the positioning of this overlay.

Returns:

Positioning value

setPositioning

public void setPositioning(Overlay.Positioning positioning)

Sets the positioning of this overlay.

Parameters:

positioning - New value

positioning

public Overlay positioning(Overlay.Positioning positioning)

Sets the positioning of this overlay.

Parameters:

positioning - New value

Returns:

This instance

getElement

public org.apache.wicket.Component getElement()

Returns the element linked to this overlay.

Returns:

Wicket component linked to this overlay

setElement

public void setElement(org.apache.wicket.Component element)

Sets the element linked to this overlay.

Parameters:

element - Wicket component linked to this overlay

element

public Overlay element(org.apache.wicket.Component element)

Sets the element linked to this overlay.

Parameters:

element - Wicket component linked to this overlay

Returns:

This instance

getStopEvent

public Boolean getStopEvent()

Returns the stop event value.

Returns:

Flag with the stop event value

setStopEvent

public void setStopEvent(Boolean stopEvent)

Sets the stop event value.

Parameters:

stopEvent - New value

stopEvent

public Overlay stopEvent(Boolean stopEvent)

Sets the stop event value.

Parameters:

stopEvent - New value

Returns:

This instance

getJsId

public String getJsId()

Description copied from interface: IJavascriptObject

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

getJsType

public String getJsType()

Description copied from interface: IJavascriptObject

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

renderJs

public String renderJs()

Description copied from interface: IJavascriptObject

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

Specified by:

renderJs in interface IJavascriptObject

Returns:

String with rendered Javascript code

renderAttributesJs

protected String renderAttributesJs()

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