1 package org.vaadin.jonatan.contexthelp; 2 3 import org.vaadin.jonatan.contexthelp.widgetset.client.ui.Placement; 4 5 public interface HelpProvider { 6 7 /** 8 * Returns a HTML-formatted string for the specified ID. 9 * 10 * @param id 11 * the id of the text to provide. 12 * @return the HTML formatted help text for the provided ID, null if none 13 * found. 14 */ 15 public String getHtmlForId(String id); 16 17 /** 18 * Returns the placement of the help text that is to be used for the 19 * component with the provided ID. 20 * 21 * @param id 22 * the id of the component for which to provide the placement. 23 * @return the placement of the help text for the component with the 24 * provided ID, null if none specified. 25 */ 26 public Placement getPlacementForId(String id); 27 }