Package org.opencms.widgets

Class CmsLocationPickerWidgetValue

java.lang.Object

org.opencms.widgets.CmsLocationPickerWidgetValue

public class CmsLocationPickerWidgetValue
extends Object

A value of the google map widget.

This is the parsed value of an element of the type String using the widget GoogleMapWidget. lat:50.953412,lng:6.956534,zoom:13,width:400,height:300,mode:dynamic,type:hybrid

Available options are:

• lat:50.953412: the latitude
• lng:6.956534: the longitude
• zoom:7: initial zoom level
• width:300: map width in pixels or %
• height:200: map height in pixels or %
• mode:'static': the front-end map's mode should be dynamic or static
• type:'hybrid': the map type, which can be normal, hybrid, satellite and physical

Since:

7.0.5

Version:

$Revision: 1.1 $

Author:

Michael Moossen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsLocationPickerWidgetValue.MapMode	Enumeration class for defining the map mode.
static enum	CmsLocationPickerWidgetValue.MapType	Enumeration class for defining the map types.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_HEIGHT	The default map height in pixels.
static final float	DEFAULT_LAT	The default latitude.
static final float	DEFAULT_LNG	The default longitude.
static final CmsLocationPickerWidgetValue.MapMode	DEFAULT_MODE	The default map mode.
static final CmsLocationPickerWidgetValue.MapType	DEFAULT_TYPE	The default map type.
static final int	DEFAULT_WIDTH	The default map width in pixels.
static final int	DEFAULT_ZOOM	The default zoom level.
static final String	OPTION_HEIGHT	Option height.
static final String	OPTION_LAT	Option lat.
static final String	OPTION_LNG	Option lng.
static final String	OPTION_MODE	Option mode.
static final String	OPTION_TYPE	Option type.
static final String	OPTION_WIDTH	Option width.
static final String	OPTION_ZOOM	Option zoom.

Constructor Summary

Constructors

Constructor	Description
CmsLocationPickerWidgetValue()	Creates a new empty widget option object.
CmsLocationPickerWidgetValue(String value)	Creates a new widget value object, configured by the given value String.

Method Summary

Modifier and Type	Method	Description
int	getHeight()	Returns the height.
float	getLat()	Returns the lat.
float	getLng()	Returns the longitude.
CmsLocationPickerWidgetValue.MapMode	getMode()	Returns the mode.
CmsLocationPickerWidgetValue.MapType	getType()	Returns the type.
int	getWidth()	Returns the width.
int	getZoom()	Returns the zoom.
protected void	parseOptions(String configuration)	Parses the given configuration String.
void	setHeight(int height)	Sets the height.
void	setLat(float lat)	Sets the latitude.
void	setLng(float lng)	Sets the longitude.
void	setMode(CmsLocationPickerWidgetValue.MapMode mode)	Sets the mode.
void	setType(CmsLocationPickerWidgetValue.MapType type)	Sets the type.
void	setWidth(int width)	Sets the width.
void	setWrappedValue(String value)	Sets the value that is wrapped.
void	setZoom(int zoom)	Sets the zoom.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

The default map height in pixels.

See Also:

• Constant Field Values

DEFAULT_LAT

public static final float DEFAULT_LAT

The default latitude.

See Also:

• Constant Field Values

DEFAULT_LNG

public static final float DEFAULT_LNG

The default longitude.

See Also:

• Constant Field Values

DEFAULT_MODE

public static final CmsLocationPickerWidgetValue.MapMode DEFAULT_MODE

The default map mode.

DEFAULT_TYPE

public static final CmsLocationPickerWidgetValue.MapType DEFAULT_TYPE

The default map type.

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

The default map width in pixels.

See Also:

• Constant Field Values

DEFAULT_ZOOM

public static final int DEFAULT_ZOOM

The default zoom level.

See Also:

• Constant Field Values

OPTION_HEIGHT

public static final String OPTION_HEIGHT

Option height.

See Also:

• Constant Field Values

OPTION_LAT

public static final String OPTION_LAT

Option lat.

See Also:

• Constant Field Values

OPTION_LNG

public static final String OPTION_LNG

Option lng.

See Also:

• Constant Field Values

OPTION_MODE

public static final String OPTION_MODE

Option mode.

See Also:

• Constant Field Values

OPTION_TYPE

public static final String OPTION_TYPE

Option type.

See Also:

• Constant Field Values

OPTION_WIDTH

public static final String OPTION_WIDTH

Option width.

See Also:

• Constant Field Values

OPTION_ZOOM

public static final String OPTION_ZOOM

Option zoom.

See Also:

• Constant Field Values

Constructor Details

CmsLocationPickerWidgetValue

public CmsLocationPickerWidgetValue()

Creates a new empty widget option object.

CmsLocationPickerWidgetValue

public CmsLocationPickerWidgetValue(String value)

Creates a new widget value object, configured by the given value String.

Parameters:

value - the value String to parse

Method Details

getHeight

public int getHeight()

Returns the height.

Returns:

the height

getLat

public float getLat()

Returns the lat.

Returns:

the lat

getLng

public float getLng()

Returns the longitude.

Returns:

the longitude

getMode

public CmsLocationPickerWidgetValue.MapMode getMode()

Returns the mode.

Returns:

the mode

getType

public CmsLocationPickerWidgetValue.MapType getType()

Returns the type.

Returns:

the type

getWidth

public int getWidth()

Returns the width.

Returns:

the width

getZoom

public int getZoom()

Returns the zoom.

Returns:

the zoom

setHeight

public void setHeight(int height)

Sets the height.

Parameters:

height - the height to set

setLat

public void setLat(float lat)

Sets the latitude.

Parameters:

lat - the latitude to set

setLng

public void setLng(float lng)

Sets the longitude.

Parameters:

lng - the longitude to set

setMode

public void setMode(CmsLocationPickerWidgetValue.MapMode mode)

Sets the mode.

Parameters:

mode - the mode to set

setType

public void setType(CmsLocationPickerWidgetValue.MapType type)

Sets the type.

Parameters:

type - the type to set

setWidth

public void setWidth(int width)

Sets the width.

Parameters:

width - the width to set

setWrappedValue

public void setWrappedValue(String value)

Sets the value that is wrapped. The method is added for convenient usage of the class in JSPs. In a formatter JSP you can use

 <jsp:useBean id="map" class="org.opencms.widgets.CmsLocationPickerWidgetValue" />
 <jsp:setProperty name="map" property="wrappedValue" value="${content.value.Map}" />
 

instead of setting the value directly via the constructor.

Parameters:

value - The string value that should be wrapped as CmsLocationPickerWidgetValue.

setZoom

public void setZoom(int zoom)

Sets the zoom.

Parameters:

zoom - the zoom to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

parseOptions

protected void parseOptions(String configuration)

Parses the given configuration String.

Parameters:

configuration - the configuration String to parse