org.geomajas.configuration

Class LabelStyleInfo

java.lang.Object

org.geomajas.configuration.LabelStyleInfo

All Implemented Interfaces:

Serializable, IsInfo

@Api(allMethods=true)
public class LabelStyleInfo
extends Object
implements IsInfo

Information about how to access and how to render the label attribute.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME_ID A special constant to be passed to setLabelAttributeName(String), denoting that the id should be used as the label text instead of a normal attribute value.

Constructor Summary

Constructors

Constructor and Description
LabelStyleInfo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Are the two objects equal?
FeatureStyleInfo	getBackgroundStyle() Get the background style for the labels.
String	getCacheId() String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result.
FontStyleInfo	getFontStyle() Get font style for label.
String	getLabelAttributeName() Get label attribute name.
String	getLabelValueExpression() Get label value expression.
int	hashCode() Calculate object hash code.
void	setBackgroundStyle(FeatureStyleInfo backgroundStyle) Set background style for labels.
void	setFontStyle(FontStyleInfo fontStyle) Set font style for label.
void	setLabelAttributeName(String labelAttributeName) Set label attribute name.
void	setLabelValueExpression(String labelValueExpression) Set label value expression.
String	toString() String representation of object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTRIBUTE_NAME_ID

public static final String ATTRIBUTE_NAME_ID

A special constant to be passed to setLabelAttributeName(String), denoting that the id should be used as the label text instead of a normal attribute value.

Since:

1.10.0

See Also:

Constant Field Values

Constructor Detail

LabelStyleInfo

public LabelStyleInfo()

Method Detail

getLabelAttributeName

public String getLabelAttributeName()

Get label attribute name.

Returns:

label attribute name

setLabelAttributeName

public void setLabelAttributeName(String labelAttributeName)

Set label attribute name.

Parameters:

labelAttributeName - label attribute name

getLabelValueExpression

public String getLabelValueExpression()

Get label value expression. The expression is evaluated by the configured FeatureExpressionService.

Returns:

label value expression

Since:

1.10.0

setLabelValueExpression

public void setLabelValueExpression(String labelValueExpression)

Set label value expression. The expression is evaluated by the configured FeatureExpressionService.

Parameters:

labelValueExpression - label value expression

Since:

1.10.0

getFontStyle

public FontStyleInfo getFontStyle()

Get font style for label.

Returns:

font style

setFontStyle

public void setFontStyle(FontStyleInfo fontStyle)

Set font style for label.

Parameters:

fontStyle - font style

getBackgroundStyle

public FeatureStyleInfo getBackgroundStyle()

Get the background style for the labels.

Returns:

background style for label

setBackgroundStyle

public void setBackgroundStyle(FeatureStyleInfo backgroundStyle)

Set background style for labels.

Parameters:

backgroundStyle - background style for label

getCacheId

public String getCacheId()

String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result. It is typically used as basis for calculation of hash codes (like MD5, SHA1, SHA2 etc) of (collections of) objects.

Returns:

cacheId

Since:

1.8.0

toString

public String toString()

String representation of object.

Overrides:

toString in class Object

Returns:

string representation of object

Since:

1.8.0

equals

public boolean equals(Object o)

Are the two objects equal?

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

true when objects are equal

Since:

1.8.0

hashCode

public int hashCode()

Calculate object hash code.

Overrides:

hashCode in class Object

Returns:

hash code

Since:

1.8.0