com.vaadin.ui
Interface TooltipConfiguration

All Superinterfaces:

java.io.Serializable

public interface TooltipConfiguration
extends java.io.Serializable

Provides method for configuring the tooltip.

Since:

7.1

Author:

Vaadin Ltd

Method Summary

int	getCloseTimeout() Returns the time (in ms) the tooltip should be displayed after an event that will cause it to be closed (e.g.
int	getMaxWidth() Returns the maximum width of the tooltip popup.
int	getOpenDelay() Returns the time (in ms) that should elapse after an event triggering tooltip showing has occurred (e.g.
int	getQuickOpenDelay() Returns the time (in ms) that should elapse before a tooltip will be shown, in the situation when a tooltip has very recently been shown (within getQuickOpenDelay() ms).
int	getQuickOpenTimeout() Returns the time (in ms) during which getQuickOpenDelay() should be used instead of getOpenDelay().
void	setCloseTimeout(int closeTimeout) Sets the time (in ms) the tooltip should be displayed after an event that will cause it to be closed (e.g.
void	setMaxWidth(int maxWidth) Sets the maximum width of the tooltip popup.
void	setOpenDelay(int openDelay) Sets the time (in ms) that should elapse after an event triggering tooltip showing has occurred (e.g.
void	setQuickOpenDelay(int quickOpenDelay) Sets the time (in ms) that should elapse before a tooltip will be shown, in the situation when a tooltip has very recently been shown (within getQuickOpenDelay() ms).
void	setQuickOpenTimeout(int quickOpenTimeout) Sets the time (in ms) that determines when getQuickOpenDelay() should be used instead of getOpenDelay().

Method Detail

getCloseTimeout

int getCloseTimeout()

Returns the time (in ms) the tooltip should be displayed after an event that will cause it to be closed (e.g. mouse click outside the component, key down).

Returns:

The close timeout

setCloseTimeout

void setCloseTimeout(int closeTimeout)

Sets the time (in ms) the tooltip should be displayed after an event that will cause it to be closed (e.g. mouse click outside the component, key down).

Parameters:

closeTimeout - The close timeout

getQuickOpenTimeout

int getQuickOpenTimeout()

Returns the time (in ms) during which getQuickOpenDelay() should be used instead of getOpenDelay(). The quick open delay is used when the tooltip has very recently been shown, is currently hidden but about to be shown again.

Returns:

The quick open timeout

setQuickOpenTimeout

void setQuickOpenTimeout(int quickOpenTimeout)

Sets the time (in ms) that determines when getQuickOpenDelay() should be used instead of getOpenDelay(). The quick open delay is used when the tooltip has very recently been shown, is currently hidden but about to be shown again.

Parameters:

quickOpenTimeout - The quick open timeout

getQuickOpenDelay

int getQuickOpenDelay()

Returns the time (in ms) that should elapse before a tooltip will be shown, in the situation when a tooltip has very recently been shown (within getQuickOpenDelay() ms).

Returns:

The quick open delay

setQuickOpenDelay

void setQuickOpenDelay(int quickOpenDelay)

Sets the time (in ms) that should elapse before a tooltip will be shown, in the situation when a tooltip has very recently been shown (within getQuickOpenDelay() ms).

Parameters:

quickOpenDelay - The quick open delay

getOpenDelay

int getOpenDelay()

Returns the time (in ms) that should elapse after an event triggering tooltip showing has occurred (e.g. mouse over) before the tooltip is shown. If a tooltip has recently been shown, then getQuickOpenDelay() is used instead of this.

Returns:

The open delay

setOpenDelay

void setOpenDelay(int openDelay)

Sets the time (in ms) that should elapse after an event triggering tooltip showing has occurred (e.g. mouse over) before the tooltip is shown. If a tooltip has recently been shown, then getQuickOpenDelay() is used instead of this.

Parameters:

openDelay - The open delay

getMaxWidth

int getMaxWidth()

Returns the maximum width of the tooltip popup.

Returns:

The maximum width the tooltip popup

setMaxWidth

void setMaxWidth(int maxWidth)

Sets the maximum width of the tooltip popup.

Parameters:

maxWidth - The maximum width the tooltip popup