ContextHelp

Provides contextual help for Vaadin applications.

View larger

Close

ContextHelp is a component allowing you to provide contextual help for your forms and/or fields in an application. ContextHelp shows a bubble containing your specified help text when the user presses F1 (or a configurable hotkey). The bubble opens right next to your field, with a small arrow pointing at the field.

ContextHelp also supports opening the help bubble programmatically and follow focus.

Sample code

ContextHelp contextHelp = new ContextHelp();
layout.addComponent(contextHelp);

TextField foo = new TextField("foo");
TextField bar = new TextField("bar");
layout.addComponent(foo);
layout.addComponent(bar);

contextHelp.addHelpForComponent(bar, "The text field allows you to write many, many, many, many, many things.");
contextHelp.addHelpForComponent(foo, "<b>foo</b> can be <i>formatted</i> using standard <b style='font-size: 20px; color: red;'>HTML</b> and inline <b>CSS</b>.");

ContextHelp contextHelp = new ContextHelp();
contextHelp.extend(UI.getCurrent());    // only needed once for each UI

TextField foo = new TextField("foo");
TextField bar = new TextField("bar");
layout.addComponent(foo);
layout.addComponent(bar);

contextHelp.addHelpForComponent(bar, "The text field allows you to write many, many, many, many, many things.");
contextHelp.addHelpForComponent(foo, "<b>foo</b> can be <i>formatted</i> using standard <b style='font-size: 20px; color: red;'>HTML</b> and inline <b>CSS</b>.");

Links

• Discussion
• Documentation
• Issue Tracker
• Source Code
• Live demo

Compatibility