com.vaadin.fluent.api

Interface FluentNotification<THIS extends com.vaadin.ui.Notification>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

Serializable

All Known Implementing Classes:

FNotification

public interface FluentNotification<THIS extends com.vaadin.ui.Notification>
extends Serializable

The base interface for fluent versions of Notification

See Also:

Notification

Method Summary

Modifier and Type	Method and Description
default THIS	withCaption(String caption) Sets the caption part of the notification message
default THIS	withDelayMsec(int delayMsec) Sets the delay before the notification disappears.
default THIS	withDescription(String description) Sets the description part of the notification message.
default THIS	withHtmlContentAllowed(boolean htmlContentAllowed) Sets whether html is allowed in the caption and description.
default THIS	withIcon(com.vaadin.server.Resource icon) Sets the icon part of the notification message.
default THIS	withPosition(com.vaadin.shared.Position position) Sets the position of the notification message.
default THIS	withStyleName(String styleName) Sets the style name for the notification message.

Method Detail

withCaption

default THIS withCaption(String caption)

Sets the caption part of the notification message

Parameters:

caption - The message caption

Returns:

this for method chaining

See Also:

Notification.setCaption(String)

withDelayMsec

default THIS withDelayMsec(int delayMsec)

Sets the delay before the notification disappears.

Parameters:

delayMsec - the desired delay in msec, -1 to require the user to click the message

Returns:

this for method chaining

See Also:

Notification.setDelayMsec(int)

withDescription

default THIS withDescription(String description)

Sets the description part of the notification message.

Parameters:

description - the description part of the notification message

Returns:

this for method chaining

See Also:

Notification.setDescription(String)

withHtmlContentAllowed

default THIS withHtmlContentAllowed(boolean htmlContentAllowed)

Sets whether html is allowed in the caption and description. If set to true, the texts are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the texts are passed to the browser as plain text.

Parameters:

htmlContentAllowed - true if the texts are used as html, false if used as plain text

Returns:

this for method chaining

See Also:

Notification.setHtmlContentAllowed(boolean)

withIcon

default THIS withIcon(com.vaadin.server.Resource icon)

Sets the icon part of the notification message.

Parameters:

icon - The desired message icon

Returns:

this for method chaining

See Also:

Notification.setIcon(Resource)

withPosition

default THIS withPosition(com.vaadin.shared.Position position)

Sets the position of the notification message.

Parameters:

position - The desired notification position

Returns:

this for method chaining

See Also:

Notification.setPosition(Position)

withStyleName

default THIS withStyleName(String styleName)

Sets the style name for the notification message.

Parameters:

styleName - The desired style name.

Returns:

this for method chaining

See Also:

Notification.setStyleName(String)