com.ontimize.util.gis.client.viewer.actions
Class OnMouseOverShowTooltip

java.lang.Object
  com.ontimize.util.gis.client.viewer.actions.OnMouseOverShowTooltip

All Implemented Interfaces:

IGisViewerOnMouseOverAction

public class OnMouseOverShowTooltip
extends java.lang.Object
implements IGisViewerOnMouseOverAction

Class to show a tooltip text when passing the mouse over a layer element

Parameters:

Name	Description	Required
tooltipText	Tooltip text to use. This text will be translated trought the application bundle	Yes
tooltipColumns	Column names (separated by ";") of the values to use in the tooltip	Yes

Sample code:

<OnMouseOverAction
     actionClass="com.ontimize.util.gis.client.viewer.actions.OnMouseOverShowTooltip">
     <Attribute name="tooltipText" value="NameTooltip" />
     <Attribute name="tooltipColumns" value="name;surname" />
</OnMouseOverAction>

Field Summary

protected java.util.Hashtable<java.lang.String,java.lang.Object>	initParams
protected java.lang.String	tooltipCols
protected java.lang.String	tooltipText

Fields inherited from interface com.ontimize.util.gis.client.interfaces.IGisViewerOnMouseOverAction

XML_ACTION_CLASS, XML_HTMLTIP_PATH, XML_IMAGE_BYTEA_COLUMN, XML_IMAGE_PATH_COLUMN, XML_IMAGE_TITLE_COLUMN, XML_TOOLTIP_COLUMNS, XML_TOOLTIP_TEXT

Constructor Summary

OnMouseOverShowTooltip()

OnMouseOverShowTooltip(java.util.Hashtable<java.lang.String,java.lang.Object> parameters)

Method Summary

boolean	doAction(java.lang.Object data, IGisViewer gisViewer, java.awt.event.MouseEvent ev) Action enabling method.
java.util.Hashtable<java.lang.String,java.lang.Object>	getInitParams() Get the configuration parameters for the current gis viewer listener
protected java.lang.String	getTooltipForData(java.util.Hashtable data, java.util.ResourceBundle bundle)
protected void	init(java.util.Hashtable<java.lang.String,java.lang.Object> parameters)
void	undoAction(IGisViewer gisViewer) Action disabling method This method is called when the mouse is not more over an element of the current layer

Methods inherited from class java.lang.Object

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

Field Detail

initParams

protected java.util.Hashtable<java.lang.String,java.lang.Object> initParams

tooltipText

protected java.lang.String tooltipText

tooltipCols

protected java.lang.String tooltipCols

Constructor Detail

OnMouseOverShowTooltip

public OnMouseOverShowTooltip()

OnMouseOverShowTooltip

public OnMouseOverShowTooltip(java.util.Hashtable<java.lang.String,java.lang.Object> parameters)

Method Detail

init

protected void init(java.util.Hashtable<java.lang.String,java.lang.Object> parameters)

doAction

public boolean doAction(java.lang.Object data,
                        IGisViewer gisViewer,
                        java.awt.event.MouseEvent ev)

Description copied from interface: IGisViewerOnMouseOverAction

Action enabling method. The class must validate the data in order to run the implemented action.
This method is called when the mouse is over an element of the current layer

Specified by:

doAction in interface IGisViewerOnMouseOverAction

Parameters:

data - Highlighted element data

gisViewer - Gis viewer reference

ev - event with the actual cursor state and position

Returns:

action performed

getTooltipForData

protected java.lang.String getTooltipForData(java.util.Hashtable data,
                                             java.util.ResourceBundle bundle)

undoAction

public void undoAction(IGisViewer gisViewer)

Description copied from interface: IGisViewerOnMouseOverAction

Action disabling method
This method is called when the mouse is not more over an element of the current layer

Specified by:

undoAction in interface IGisViewerOnMouseOverAction

Parameters:

gisViewer - Gis viewer reference

getInitParams

public java.util.Hashtable<java.lang.String,java.lang.Object> getInitParams()

Description copied from interface: IGisViewerOnMouseOverAction

Get the configuration parameters for the current gis viewer listener

Specified by:

getInitParams in interface IGisViewerOnMouseOverAction

Returns:

Configuration parameters