org.vaadin.jonatan.contexthelp

Class DefaultHelpProvider

java.lang.Object

org.vaadin.jonatan.contexthelp.DefaultHelpProvider

All Implemented Interfaces:

Serializable, HelpProvider

public class DefaultHelpProvider
extends Object
implements HelpProvider, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultHelpProvider()

Method Summary

Modifier and Type	Method and Description
void	addHelpForId(String id, String help)
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.
void	setPlacementOfId(String debugId, Placement placement)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHelpProvider

public DefaultHelpProvider()

Method Detail

getHtmlForId

public String getHtmlForId(String id)

Description copied from interface: HelpProvider

Returns a HTML-formatted string for the specified ID.

Specified by:

getHtmlForId in interface HelpProvider

Parameters:

id - the id of the text to provide.

Returns:

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

getPlacementForId

public Placement getPlacementForId(String id)

Description copied from interface: HelpProvider

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

Specified by:

getPlacementForId in interface HelpProvider

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.

addHelpForId

public void addHelpForId(String id,
                         String help)

setPlacementOfId

public void setPlacementOfId(String debugId,
                             Placement placement)