org.vaadin.jonatan.contexthelp

Class ContextHelp

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

org.vaadin.jonatan.contexthelp.ContextHelp

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, Serializable

public class ContextHelp
extends com.vaadin.server.AbstractExtension

The ContextHelp component offers contextual help for fields or groups of fields. By default, the help bubbles are opened by the user by pressing the F1 key. You can also specify to programmatically open certain help bubbles (e.g. via a button click) or to have the help bubble follow focus.

Author:

Jonatan Kronqvist

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor and Description
ContextHelp()

Method Summary

Modifier and Type	Method and Description
void	addHelpForComponent(com.vaadin.ui.Component component, String help) Registers a help text for a given component.
void	addHelpForComponent(com.vaadin.ui.Component component, String help, Placement placement) Registers a help text for a given component.
void	extend(com.vaadin.ui.UI ui) Add this extension to the target UI.
int	getHelpKey()
HelpProvider	getHelpProvider()
ContextHelpState	getState()
void	hideHelp() Programmatically hide the help bubble.
boolean	isFollowFocus()
boolean	isHideOnBlur()
void	setFollowFocus(boolean followFocus) This setting causes the help bubble to be displayed when a field is focused, and removed when the focus moves away from the field.
void	setHelpKey(int helpKey) Sets the key that is used for opening the help bubble.
void	setHelpProvider(HelpProvider helpProvider) Sets the HelpProvider to be used for looking up help texts for components.
void	setHideOnBlur(boolean hideOnBlur) Set whether the bubble should be automatically hidden when the field is unfocused.
void	setPlacement(com.vaadin.ui.Component component, Placement placement) Specifies where the help bubble should be placed in relation to the component.
void	showHelpFor(com.vaadin.ui.Component component) Programmatically show the help bubble for a given component.

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

ContextHelp

public ContextHelp()

Method Detail

getState

public ContextHelpState getState()

Overrides:

getState in class com.vaadin.server.AbstractClientConnector

addHelpForComponent

public void addHelpForComponent(com.vaadin.ui.Component component,
                                String help)

Registers a help text for a given component. The help text is in HTML format and can be formatted as such and styled with inline CSS. It is also possible to provide classnames for elements in the HTML and provide the CSS rules in the Vaadin theme. Note that if this method is to be used only if you do not use a custom HelpProvider.

Parameters:

component - the component for which to register the help text.

help - the help text in HTML.

addHelpForComponent

public void addHelpForComponent(com.vaadin.ui.Component component,
                                String help,
                                Placement placement)

Registers a help text for a given component. The help text is in HTML format and can be formatted as such and styled with inline CSS. It is also possible to provide classnames for elements in the HTML and provide the CSS rules in the Vaadin theme. Note that if this method is to be used only if you do not use a custom HelpProvider.

Parameters:

component - the component for which to register the help text.

help - the help text in HTML.

placement - where the help bubble should be placed.

showHelpFor

public void showHelpFor(com.vaadin.ui.Component component)

Programmatically show the help bubble for a given component.

Parameters:

component - the component for which to show the help bubble.

hideHelp

public void hideHelp()

Programmatically hide the help bubble.

setFollowFocus

public void setFollowFocus(boolean followFocus)

This setting causes the help bubble to be displayed when a field is focused, and removed when the focus moves away from the field. If focus moves to a new field, the help bubble for this new field is shown.

Parameters:

followFocus - true (enabled) or false (disabled).

isFollowFocus

public boolean isFollowFocus()

Returns:

whether the help bubble follows focus or is opened with the F1 key.

setPlacement

public void setPlacement(com.vaadin.ui.Component component,
                         Placement placement)

Specifies where the help bubble should be placed in relation to the component. This is only active for the specified component. The default is to place the help bubble to the right of components and if it doesn't fit there, ContextHelp attempts to place it below followed by above the component. Note that if this method is to be used only if you do not use a custom HelpProvider.

Parameters:

component - the component for which to define the placement of the help bubble.

placement - the placement of the help bubble.

setHelpKey

public void setHelpKey(int helpKey)

Sets the key that is used for opening the help bubble. Use the key codes found in ShortcutAction.KeyCode

Parameters:

helpKey - the key code for the key that opens the help bubble.

getHelpKey

public int getHelpKey()

Returns:

the key code for the key that opens the help bubble.

isHideOnBlur

public boolean isHideOnBlur()

Returns:

whether the bubble is automatically hidden when the field is unfocused.

setHideOnBlur

public void setHideOnBlur(boolean hideOnBlur)

Set whether the bubble should be automatically hidden when the field is unfocused. This feature is still EXPERIMENTAL, as hiding of the bubble lags in some instances when the component it is attached to is removed (navigated away from) if you don't hide the bubble manually before switching views.

Parameters:

hideOnBlur -

setHelpProvider

public void setHelpProvider(HelpProvider helpProvider)

Sets the HelpProvider to be used for looking up help texts for components. By default the DefaultHelpProvider is used.

Parameters:

helpProvider - the HelpProvider.

getHelpProvider

public HelpProvider getHelpProvider()

Returns:

The HelpProvider instance that is used for looking up help text for components.

extend

public void extend(com.vaadin.ui.UI ui)

Add this extension to the target UI.

Parameters:

ui - the connector to attach this extension to