com.github.ilyes4j.gwt.mdl.components.tooltips

Class Tooltip

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

com.github.ilyes4j.gwt.mdl.components.tooltips.Tooltip

All Implemented Interfaces:

IUpgrade, com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseOutHandler, com.google.gwt.event.dom.client.MouseOverHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>

public class Tooltip
extends com.google.gwt.user.client.ui.FlowPanel
implements com.google.gwt.event.dom.client.MouseOverHandler, com.google.gwt.event.dom.client.MouseOutHandler, com.google.gwt.event.dom.client.MouseDownHandler, IUpgrade

A material design tooltip.

Author:

Mohamed Ilyes DIMASSI

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Tooltip(com.google.gwt.user.client.ui.Widget widget, String text) Setup a tooltip instance below its target and with a standard font size.
Tooltip(com.google.gwt.user.client.ui.Widget widget, String text, TooltipPosition paramPosition) Setup a tooltip instance with a standard font size.
Tooltip(com.google.gwt.user.client.ui.Widget widget, String text, TooltipPosition paramPosition, TooltipStyle paramStyle) Setup a tooltip instance with all options to be indicated.

Method Summary

Methods

Modifier and Type	Method and Description
void	hide() remove the panel from its parent.
boolean	isHideOnClick()
boolean	isUpgraded()
void	onLoad()
void	onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)
void	onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent event)
void	onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent event)
void	setEnabled(boolean inputEnabled) Control whether the tooltip should be displayed.
void	setHideOnClick(boolean paramHideOnClick)
void	setTarget(com.google.gwt.user.client.ui.Widget paramTarget) Set the target of the tooltip.
void	setText(String text) Set the text to be displayed inside the tooltip.
void	show() attach the panel to its parent.
void	upgrade() Causes the component to be upgraded.

Methods inherited from class com.google.gwt.user.client.ui.FlowPanel

add, clear, insert, insert

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

Tooltip

public Tooltip(com.google.gwt.user.client.ui.Widget widget,
       String text,
       TooltipPosition paramPosition,
       TooltipStyle paramStyle)

Setup a tooltip instance with all options to be indicated.

Parameters:

widget - the target element for which the tooltip is displayed

text - the content of the tooltip

paramPosition - the anchoring option of the tooltip

paramStyle - the font size of the tooltip

Tooltip

public Tooltip(com.google.gwt.user.client.ui.Widget widget,
       String text,
       TooltipPosition paramPosition)

Setup a tooltip instance with a standard font size.

Parameters:

widget - the target element for which the tooltip is displayed

text - the content of the tooltip

paramPosition - the anchoring option of the tooltip

Tooltip

public Tooltip(com.google.gwt.user.client.ui.Widget widget,
       String text)

Setup a tooltip instance below its target and with a standard font size.

Parameters:

widget - the target element for which the tooltip is displayed

text - the content of the tooltip

Method Detail

setText

public void setText(String text)

Set the text to be displayed inside the tooltip.

Parameters:

text - the text to be displayed inside the tooltip

onMouseOut

public final void onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent event)

Specified by:

onMouseOut in interface com.google.gwt.event.dom.client.MouseOutHandler

onMouseOver

public final void onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent event)

Specified by:

onMouseOver in interface com.google.gwt.event.dom.client.MouseOverHandler

onMouseDown

public final void onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)

Specified by:

onMouseDown in interface com.google.gwt.event.dom.client.MouseDownHandler

isHideOnClick

public boolean isHideOnClick()

Returns:

whether the tooltip needs to be hidden when the mouse is pushed

setHideOnClick

public void setHideOnClick(boolean paramHideOnClick)

Parameters:

paramHideOnClick - determines if the tooltip needs to be hidden when the mouse is pushed

setEnabled

public void setEnabled(boolean inputEnabled)

Control whether the tooltip should be displayed. If the input value is true, the tooltip will show up next time the mouse is over the target element. If the tooltip is showing then it will be hidden immediately.

Parameters:

inputEnabled - controls whether the tooltip will show up when the mouse is over the target

setTarget

public void setTarget(com.google.gwt.user.client.ui.Widget paramTarget)

Set the target of the tooltip.

Parameters:

paramTarget - the target of the tooltip

onLoad

public void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

show

public void show()

attach the panel to its parent.

hide

public void hide()

remove the panel from its parent.

upgrade

public void upgrade()

Description copied from interface: IUpgrade

Causes the component to be upgraded.

Specified by:

upgrade in interface IUpgrade

isUpgraded

public boolean isUpgraded()

Specified by:

isUpgraded in interface IUpgrade

Returns:

the upgrade state of the component