com.vaadin.fluent.api

Interface FluentAbstractComponent<THIS extends FluentAbstractComponent<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentContextClickNotifier<THIS>, FluentSizeable<THIS>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentAbstractColorPicker<THIS>, FluentAbstractComponentContainer<THIS>, FluentAbstractDateField<THIS,FIELD,R>, FluentAbstractField<THIS,FIELD>, FluentAbstractFocusable<THIS>, FluentAbstractLayout<THIS>, FluentAbstractListing<THIS,ITEM>, FluentAbstractLocalDateField<THIS>, FluentAbstractLocalDateTimeField<THIS>, FluentAbstractMultiSelect<THIS,VALUE>, FluentAbstractOrderedLayout<THIS>, FluentAbstractSingleComponentContainer<THIS>, FluentAbstractSingleSelect<THIS,VALUE>, FluentAbstractTextField<THIS>, FluentAudio<THIS>, FluentButton<THIS>, FluentCheckBox<THIS>, FluentCheckBoxGroup<THIS,VALUE>, FluentComboBox<THIS,ITEM>, FluentComposite<THIS>, FluentCssLayout<THIS>, FluentCustomField<THIS,T>, FluentCustomLayout<THIS>, FluentDateField<THIS>, FluentDateTimeField<THIS>, FluentFormLayout<THIS>, FluentGrid<THIS,ITEM>, FluentGridLayout<THIS>, FluentHorizontalLayout<THIS>, FluentInlineDateField<THIS>, FluentLabel<THIS>, FluentLink<THIS>, FluentListSelect<THIS,ITEM>, FluentMedia<THIS>, FluentMenuBar<THIS>, FluentNativeSelect<THIS,ITEM>, FluentPanel<THIS>, FluentPopupView<THIS>, FluentProgressBar<THIS>, FluentRadioButtonGroup<THIS,ITEM>, FluentRichTextArea<THIS>, FluentSlider<THIS>, FluentSplitPanel<THIS>, FluentTabSheet<THIS>, FluentTextArea<THIS>, FluentTextField<THIS>, FluentTree<THIS,ITEM>, FluentTreeGrid<THIS,ITEM>, FluentTwinColSelect<THIS,ITEM>, FluentUpload<THIS>, FluentVerticalLayout<THIS>, FluentVideo<THIS>, FluentWindow<THIS>

All Known Implementing Classes:

FAccordion, FAudio, FButton, FCheckBox, FCheckBoxGroup, FColorPicker, FColorPickerArea, FComboBox, FCssLayout, FCustomLayout, FDateField, FDateTimeField, FFormLayout, FGrid, FGridLayout, FHorizontalLayout, FHorizontalSplitPanel, FInlineDateField, FLabel, FLink, FListSelect, FMenuBar, FNativeButton, FNativeSelect, FPanel, FPasswordField, FPopupView, FProgressBar, FRadioButtonGroup, FRichTextArea, FSlider, FTabSheet, FTextArea, FTextField, FTree, FTreeGrid, FTwinColSelect, FUpload, FVerticalLayout, FVerticalSplitPanel, FVideo, FWindow

public interface FluentAbstractComponent<THIS extends FluentAbstractComponent<THIS>>
extends FluentComponent<THIS>, FluentClientConnector<THIS>, FluentContextClickNotifier<THIS>

The base interface for fluent versions of AbstractComponent

See Also:

AbstractComponent

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

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

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withCaption(String caption, boolean captionAsHtml)
default THIS	withCaptionAsHtml(boolean captionAsHtml) Sets whether the caption is rendered as HTML.
default THIS	withComponentError(com.vaadin.server.ErrorMessage componentError) Sets the component'THIS error message.
default THIS	withData(Object data) Sets the data object, that can be used for any application specific data.
default THIS	withDescription(String description) Sets the component'THIS description.
default THIS	withDescription(String description, com.vaadin.shared.ui.ContentMode mode) Sets the component's description using given content mode.
default THIS	withLocale(Locale locale) Sets the locale of this component.
default THIS	withResponsive(boolean responsive) Toggles responsiveness of this component.
default THIS	withShortcutListener(com.vaadin.event.ShortcutListener shortcut) Registers a new shortcut listener for the component.
default THIS	withStyleName(String style, boolean add) Adds or removes a style name.

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Method Detail

withCaptionAsHtml

default THIS withCaptionAsHtml(boolean captionAsHtml)

Sets whether the caption is rendered as HTML.

If set to true, the captions are rendered in the browser as HTML and the developer is responsible for ensuring no harmful HTML is used. If set to false, the caption is rendered in the browser as plain text.

The default is false, i.e. to render that caption as plain text.

Parameters:

captionAsHtml - true if the captions are rendered as HTML, false if rendered as plain text

Returns:

this (for method chaining)

See Also:

AbstractComponent.setCaptionAsHtml(boolean)

withLocale

default THIS withLocale(Locale locale)

Sets the locale of this component.

 // Component for which the locale is meaningful
 InlineDateField date = new InlineDateField("Datum");

 // German language specified with ISO 639-1 language
 // code and ISO 3166-1 alpha-2 country code.
 date.setLocale(new Locale("de", "DE"));

 date.setResolution(DateField.RESOLUTION_DAY);
 layout.addComponent(date);
 

Parameters:

locale - the locale to become this component'THIS locale.

Returns:

this (for method chaining)

See Also:

AbstractComponent.setLocale(java.util.Locale)

withDescription

default THIS withDescription(String description)

Sets the component'THIS description. See Component.getDescription() for more information on what the description is. The description is displayed as HTML in tooltips or directly in certain components so care should be taken to avoid creating the possibility for HTML injection and possibly XSS vulnerabilities.

Parameters:

description - the new description string for the component.

Returns:

this (for method chaining)

See Also:

AbstractComponent.setDescription(java.lang.String)

withDescription

default THIS withDescription(String description,
                             com.vaadin.shared.ui.ContentMode mode)

Sets the component's description using given content mode. See Component.getDescription() for more information on what the description is.

If the content mode is ContentMode.HTML the description is displayed as HTML in tooltips or directly in certain components so care should be taken to avoid creating the possibility for HTML injection and possibly XSS vulnerabilities.

Parameters:

description - the new description string for the component.

mode - the content mode for the description

Returns:

this (for method chaining)

See Also:

AbstractComponent.setDescription(String, ContentMode)

withComponentError

default THIS withComponentError(com.vaadin.server.ErrorMessage componentError)

Sets the component'THIS error message.

Parameters:

componentError - the new ErrorMessage of the component.

Returns:

this (for method chaining)

See Also:

AbstractComponent.setComponentError(com.vaadin.server.ErrorMessage)

withData

default THIS withData(Object data)

Sets the data object, that can be used for any application specific data. The component does not use or modify this data.

Parameters:

data - the Application specific data.

Returns:

this (for method chaining)

See Also:

AbstractComponent.setData(java.lang.Object)

withShortcutListener

default THIS withShortcutListener(com.vaadin.event.ShortcutListener shortcut)

Registers a new shortcut listener for the component.

Parameters:

shortcut - the new Listener to be registered.

Returns:

this (for method chaining)

See Also:

AbstractComponent.addShortcutListener(com.vaadin.event.ShortcutListener)

withResponsive

default THIS withResponsive(boolean responsive)

Toggles responsiveness of this component.

Parameters:

responsive - boolean enables responsiveness, false disables

Returns:

this (for method chaining)

Since:

7.5.0

See Also:

AbstractComponent.setResponsive(boolean)

withStyleName

default THIS withStyleName(String style,
                           boolean add)

Adds or removes a style name. Multiple styles can be specified as a space-separated list of style names. If the add parameter is true, the style name is added to the component. If the add parameter is false, the style name is removed from the component.

Functionally this is equivalent to using Component.addStyleName(String) or Component.removeStyleName(String)

Parameters:

style - the style name to be added or removed

add - true to add the given style, false to remove it

Returns:

this for method chaining

See Also:

Component.addStyleName(String), Component.removeStyleName(String)

withCaption

default THIS withCaption(String caption,
                         boolean captionAsHtml)