org.vaadin.jonatan.contexthelp

Interface HelpProvider

All Known Implementing Classes:

DefaultHelpProvider

public interface HelpProvider

Method Summary

Modifier and Type	Method and Description
String	getHtmlForId(String id) Returns a HTML-formatted string for the specified ID.
Placement	getPlacementForId(String id) Returns the placement of the help text that is to be used for the component with the provided ID.

Method Detail

getHtmlForId

String getHtmlForId(String id)

Returns a HTML-formatted string for the specified ID.

Parameters:

id - the id of the text to provide.

Returns:

the HTML formatted help text for the provided ID, null if none found.

getPlacementForId

Placement getPlacementForId(String id)

Returns the placement of the help text that is to be used for the component with the provided ID.

Parameters:

id - the id of the component for which to provide the placement.

Returns:

the placement of the help text for the component with the provided ID, null if none specified.