Package org.opencms.gwt.client.util
Class CmsToolTipHandler
java.lang.Object
org.opencms.gwt.client.util.CmsToolTipHandler
- All Implemented Interfaces:
com.google.gwt.event.dom.client.MouseMoveHandler
,com.google.gwt.event.dom.client.MouseOutHandler
,com.google.gwt.event.dom.client.MouseOverHandler
,com.google.gwt.event.shared.EventHandler
public class CmsToolTipHandler
extends Object
implements com.google.gwt.event.dom.client.MouseOverHandler, com.google.gwt.event.dom.client.MouseMoveHandler, com.google.gwt.event.dom.client.MouseOutHandler
A tool-tip handler. Allowing to show any HTML as a tool-tip on mouse over.
- Since:
- 8.0.0
-
Constructor Summary
ConstructorsConstructorDescriptionCmsToolTipHandler
(com.google.gwt.event.dom.client.HasAllMouseHandlers target, String toolTipHtml) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes the tool-tip and mouse move and out handlers.Returns the tool-tip HTML.boolean
Returns if the tool-tip is showing.void
onMouseMove
(com.google.gwt.event.dom.client.MouseMoveEvent event) void
onMouseOut
(com.google.gwt.event.dom.client.MouseOutEvent event) void
onMouseOver
(com.google.gwt.event.dom.client.MouseOverEvent event) void
Removes this tool-tip handler completely.void
setOffsetLeft
(int offsetLeft) Sets the tool-tip left offset.void
setOffsetTop
(int offsetTop) Sets the tool-tip top offset.void
setToolTipHtml
(String toolTipHtml) Sets the tool-tip HTML.
-
Constructor Details
-
CmsToolTipHandler
public CmsToolTipHandler(com.google.gwt.event.dom.client.HasAllMouseHandlers target, String toolTipHtml) Constructor. Adds the tool-tip handler to the target.- Parameters:
target
- the target to show the tool-tip ontoolTipHtml
- the tool-tip content
-
-
Method Details
-
clearShowing
Removes the tool-tip and mouse move and out handlers. -
getToolTipHtml
Returns the tool-tip HTML.- Returns:
- the tool-tip HTML
-
isShowing
Returns if the tool-tip is showing.- Returns:
true
if the tool-tip is showing
-
onMouseMove
- Specified by:
onMouseMove
in interfacecom.google.gwt.event.dom.client.MouseMoveHandler
- See Also:
-
MouseMoveHandler.onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent)
-
onMouseOut
- Specified by:
onMouseOut
in interfacecom.google.gwt.event.dom.client.MouseOutHandler
- See Also:
-
MouseOutHandler.onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent)
-
onMouseOver
- Specified by:
onMouseOver
in interfacecom.google.gwt.event.dom.client.MouseOverHandler
- See Also:
-
MouseOverHandler.onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent)
-
removeHandler
Removes this tool-tip handler completely. This instance will not be reusable. -
setOffsetLeft
Sets the tool-tip left offset.- Parameters:
offsetLeft
- the tool-tip left offset to set
-
setOffsetTop
Sets the tool-tip top offset.- Parameters:
offsetTop
- the tool-tip top offset to set
-
setToolTipHtml
Sets the tool-tip HTML.- Parameters:
toolTipHtml
- the tool-tip HTML to set
-