com.kheops.jmap.client.layers

Class MouseOverConfiguration

java.lang.Object

com.kheops.jmap.metadata.LocalizedObject

com.kheops.jmap.client.layers.MouseOverConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MouseOverConfiguration
extends LocalizedObject
implements java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	backgroundColor
protected java.lang.String	mouseOverText
protected boolean	mouseOverVisible
protected boolean	preventTextDuplication

Constructor Summary

Constructors

Constructor and Description
MouseOverConfiguration()
MouseOverConfiguration(java.lang.String mouseOverText) Constructs a new MouseOverConfiguration using the specified text.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.awt.Color	getBackgroundColor() Returns the current background color of the mouseover bubble.
double	getMaximumVisibleScale()
double	getMinimumVisibleScale()
java.lang.String	getMouseOverText() Returns the mouseover text value for the layer.
java.lang.String	getMouseOverText(java.util.Locale locale) Returns the mouseover text value for for a specific locale.
boolean	isMouseOverVisible() Returns true if the mouse over is active.
boolean	isPreventTextDuplication() Returns whether or not text duplication prevention is enabled.
void	removeTranslationsOtherThan(java.util.Locale[] locales) Removes any Locale from this object that are not in the specified locales.
void	setBackgroundColor(java.awt.Color backgroundColor) Sets the background color of the mouse over bubble.
void	setMaximumVisibleScale(double maximumVisibleScale)
void	setMinimumVisibleScale(double minimumVisibleScale)
void	setMouseOverText(java.lang.String mouseOverText) Sets the mouseover text with the specified string.
void	setMouseOverText(java.lang.String mouseOverText, java.util.Locale locale) Sets the mouseover text with the specified string for a specific locale.
void	setMouseOverVisible(boolean mouseOverVisible) Enable / disable the mouse over without loosing the current configuration.
void	setPreventTextDuplication(boolean preventTextDuplication) Enables or disable the text duplication.

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

getAvailableLocales, getTranslation, isTranslationExists, setTranslation, updateTranslations

Methods inherited from class java.lang.Object

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

Field Detail

mouseOverText

protected java.lang.String mouseOverText

preventTextDuplication

protected boolean preventTextDuplication

backgroundColor

protected java.awt.Color backgroundColor

mouseOverVisible

protected boolean mouseOverVisible

Constructor Detail

MouseOverConfiguration

public MouseOverConfiguration()

MouseOverConfiguration

public MouseOverConfiguration(java.lang.String mouseOverText)

Constructs a new MouseOverConfiguration using the specified text. The other attributes will have default values.

Parameters:

mouseOverText - the new mouseover text

Method Detail

setMouseOverText

public void setMouseOverText(java.lang.String mouseOverText)

Sets the mouseover text with the specified string. This text is used to produce mouseover messages on the map.

Parameters:

mouseOverText - the new mouseover text

setMouseOverText

public void setMouseOverText(java.lang.String mouseOverText,
                             java.util.Locale locale)

Sets the mouseover text with the specified string for a specific locale. This text is used to produce mouseover messages on the map.

Parameters:

mouseOverText - the new mouseover text

locale -

getMouseOverText

public java.lang.String getMouseOverText()

Returns the mouseover text value for the layer.

Returns:

the mouseover text

getMouseOverText

public java.lang.String getMouseOverText(java.util.Locale locale)

Returns the mouseover text value for for a specific locale.

Parameters:

locale -

Returns:

the mouseover text

isPreventTextDuplication

public boolean isPreventTextDuplication()

Returns whether or not text duplication prevention is enabled.

Returns:

whether or not text duplication prevention is enabled.

setPreventTextDuplication

public void setPreventTextDuplication(boolean preventTextDuplication)

Enables or disable the text duplication. If enabled, 2 or more elements with the same mouse over text will result in only one output.

Parameters:

preventTextDuplication - the new state

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the current background color of the mouseover bubble.

Returns:

the current background color

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

Sets the background color of the mouse over bubble.

Parameters:

backgroundColor - a new background color

isMouseOverVisible

public boolean isMouseOverVisible()

Returns true if the mouse over is active.

Returns:

true is mouse over is active

setMouseOverVisible

public void setMouseOverVisible(boolean mouseOverVisible)

Enable / disable the mouse over without loosing the current configuration.

Parameters:

mouseOverVisible -

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getMinimumVisibleScale

public double getMinimumVisibleScale()

setMinimumVisibleScale

public void setMinimumVisibleScale(double minimumVisibleScale)

getMaximumVisibleScale

public double getMaximumVisibleScale()

setMaximumVisibleScale

public void setMaximumVisibleScale(double maximumVisibleScale)

removeTranslationsOtherThan

public void removeTranslationsOtherThan(java.util.Locale[] locales)

Description copied from class: LocalizedObject

Removes any Locale from this object that are not in the specified locales. locales[0] should be the default language

Overrides:

removeTranslationsOtherThan in class LocalizedObject