com.teamdev.jxmaps

Class MapTypeStyler

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.MapTypeStyler

All Implemented Interfaces:

java.lang.Cloneable

public class MapTypeStyler
extends MapObject

Represents map type styler. A styler affects how a map's elements will be styled. Each MapTypeStyler should contain one and only one key. If more than one key is specified in a single MapTypeStyler, all but one will be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MapTypeStyler.ArrayProperty

Constructor Summary

Constructors

Constructor and Description
MapTypeStyler() Creates new MapTypeStyler object.
MapTypeStyler(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColor() Returns value of color property.
double	getGamma() Returns value of gamma property.
java.lang.String	getHue() Returns value of hue property.
boolean	getInvertLightness() Returns value of invertLightness property.
double	getLightness() Returns value of lightness property.
double	getSaturation() Returns value of saturation property.
java.lang.String	getVisibility() Returns value of visibility property.
double	getWeight() Returns value of weight property.
void	setColor(java.lang.String color) Sets new value for color property.
void	setGamma(double gamma) Sets new value for gamma property
void	setHue(java.lang.String hue) Sets new value for hue property.
void	setInvertLightness(boolean invert) Sets new value for invertLightness property.
void	setLightness(double lightness) Sets new value for lightness property.
void	setSaturation(double saturation) Sets new value for styles property.
void	setVisibility(java.lang.String visibility) Sets new value for visibility property.
void	setWeight(double weight) Sets new value for weight property.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

MapTypeStyler

public MapTypeStyler()

Creates new MapTypeStyler object.

MapTypeStyler

@Deprecated
public MapTypeStyler(Map map)

Deprecated.

Creates new MapTypeStyler object.

Parameters:

map - owner Map object

Method Detail

getColor

public java.lang.String getColor()

Returns value of color property.

Sets the color of the feature. Valid values: An RGB hex string, i.e. '#ff0000'.

Returns:

property value

See Also:

setColor(java.lang.String)

setColor

public void setColor(java.lang.String color)

Sets new value for color property.

Parameters:

color - new property value

See Also:

getColor()

getGamma

public double getGamma()

Returns value of gamma property.

Modifies the gamma by raising the lightness to the given power. Valid values: Floating point numbers, [0.01, 10], with 1.0 representing no change.

Returns:

property value

See Also:

setGamma(double)

setGamma

public void setGamma(double gamma)

Sets new value for gamma property

Parameters:

gamma - new property value.

See Also:

getGamma()

getHue

public java.lang.String getHue()

Returns value of hue property.

Sets the hue of the feature to match the hue of the color supplied. Note that the saturation and lightness of the feature is conserved, which means that the feature will not match the color supplied exactly. Valid values: An RGB hex string, i.e. '#ff0000'.

Returns:

property value

See Also:

setHue(java.lang.String)

setHue

public void setHue(java.lang.String hue)

Sets new value for hue property.

Parameters:

hue - new property value

See Also:

getHue()

getInvertLightness

public boolean getInvertLightness()

Returns value of invertLightness property.

A value of true will invert the lightness of the feature while preserving the hue and saturation.

Returns:

property value

See Also:

setInvertLightness(boolean)

setInvertLightness

public void setInvertLightness(boolean invert)

Sets new value for invertLightness property.

Parameters:

invert - new property value

See Also:

getInvertLightness()

getLightness

public double getLightness()

Returns value of lightness property.

Shifts lightness of colors by a percentage of the original value if decreasing and a percentage of the remaining value if increasing. Valid values: [-100, 100].

Returns:

property value

See Also:

setLightness(double)

setLightness

public void setLightness(double lightness)

Sets new value for lightness property.

Parameters:

lightness - new property value

See Also:

getLightness()

getSaturation

public double getSaturation()

Returns value of saturation property.

Shifts the saturation of colors by a percentage of the original value if decreasing and a percentage of the remaining value if increasing. Valid values: [-100, 100].

Returns:

property value

See Also:

setSaturation(double)

setSaturation

public void setSaturation(double saturation)

Sets new value for styles property.

Parameters:

saturation - new property value

See Also:

getSaturation()

getVisibility

public java.lang.String getVisibility()

Returns value of visibility property.

Sets the visibility of the feature. Valid values: 'on', 'off' or 'simplified'.

Returns:

property value

See Also:

setVisibility(java.lang.String)

setVisibility

public void setVisibility(java.lang.String visibility)

Sets new value for visibility property.

Parameters:

visibility - new property value

See Also:

getVisibility()

getWeight

public double getWeight()

Returns value of weight property.

Sets the weight of the feature, in pixels. Valid values: Integers greater than or equal to zero.

Returns:

property value

See Also:

setWeight(double)

setWeight

public void setWeight(double weight)

Sets new value for weight property.

Parameters:

weight - new property value

See Also:

getWeight()