Package com.levigo.jadice.web.demo.common.client

Class DemoTooltipGenerator

java.lang.Object

com.levigo.jadice.web.demo.common.client.DemoTooltipGenerator

All Implemented Interfaces:

AnnotationTooltipGenerator

public class DemoTooltipGenerator
extends Object
implements AnnotationTooltipGenerator

An example of an AnnotationTooltipGenerator which creates tooltips for annotations in the enterprise demo.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.gwt.i18n.shared.DateTimeFormat	timeFormat

Constructor Summary

Constructors

Constructor	Description
DemoTooltipGenerator()

Method Summary

Modifier and Type	Method	Description
com.google.gwt.safehtml.shared.SafeHtml	createTooltipText(Document document, Annotation annotation)	Creates the tooltip text for the given annotation.
boolean	isEnabled(Document document, Annotation annotation)	Checks if this AnnotationTooltipGenerator is enabled/active for the given annotation.

Methods inherited from class java.lang.Object

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

Field Details

timeFormat

protected com.google.gwt.i18n.shared.DateTimeFormat timeFormat

Constructor Details

DemoTooltipGenerator

public DemoTooltipGenerator()

Method Details

createTooltipText

public com.google.gwt.safehtml.shared.SafeHtml createTooltipText(Document document,
 Annotation annotation)

Description copied from interface: AnnotationTooltipGenerator

Creates the tooltip text for the given annotation.

Specified by:

createTooltipText in interface AnnotationTooltipGenerator

Parameters:

document - the corresponding Document

annotation - the annotation to create the tooltip for

Returns:

a SafeHtml object with the tooltip text, or null if no tooltip shall be shown.

isEnabled

public boolean isEnabled(Document document,
 Annotation annotation)

Description copied from interface: AnnotationTooltipGenerator

Checks if this AnnotationTooltipGenerator is enabled/active for the given annotation. This method is called before the tooltip is created via AnnotationTooltipGenerator.createTooltipText(Document, Annotation).

Subclasses could, for example, check for a specific Annotation type to just provide tooltips for those annotation types.

Specified by:

isEnabled in interface AnnotationTooltipGenerator

Parameters:

document - the corresponding Document

annotation - the annotation which is in question to create a tooltip for

Returns:

true: AnnotationTooltipGenerator.createTooltipText(Document, Annotation) will be called for this annotation; false else