com.vaadin.fluent.api

Interface FluentComponent<THIS extends FluentComponent<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.shared.Connector, FluentSizeable<THIS>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentAbstractColorPicker<THIS>, FluentAbstractComponent<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>, FluentComponent.FluentFocusable<C>, FluentComponentContainer<THIS>, FluentComposite<THIS>, FluentCssLayout<THIS>, FluentCustomField<THIS,T>, FluentCustomLayout<THIS>, FluentDateField<THIS>, FluentDateTimeField<THIS>, FluentFormLayout<THIS>, FluentGrid<THIS,ITEM>, FluentGridLayout<THIS>, FluentHasComponents<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentHasFilterableDataProvider<THIS,ITEM,FILTER>, FluentHasHierarchicalDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentHasValueChangeMode<THIS>, FluentHorizontalLayout<THIS>, FluentInlineDateField<THIS>, FluentLabel<THIS>, FluentLayout<THIS>, FluentLink<THIS>, FluentListSelect<THIS,ITEM>, FluentMedia<THIS>, FluentMenuBar<THIS>, FluentNativeSelect<THIS,ITEM>, FluentPanel<THIS>, FluentPopupView<THIS>, FluentProgressBar<THIS>, FluentRadioButtonGroup<THIS,ITEM>, FluentRichTextArea<THIS>, FluentSingleComponentContainer<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 FluentComponent<THIS extends FluentComponent<THIS>>
extends com.vaadin.ui.Component, FluentSizeable<THIS>

The base interface for fluent versions of Component

See Also:

Component

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>> A Focusable complemented by fluent setters.

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) Sets the caption of the component.
default THIS	withEnabled(boolean enabled) Enables or disables the component.
default THIS	withIcon(com.vaadin.server.Resource icon) Sets the icon of the component.
default THIS	withId(String id) Adds an unique id for component that is used in the client-side for testing purposes.
default THIS	withParent(com.vaadin.ui.HasComponents parent) Sets the parent connector of the component.
default THIS	withPrimaryStyleName(String style) Changes the primary style name of the component.
default THIS	withStyleName(String... styles) Adds one or more style names to this component by using one or multiple parameters.
default THIS	withStyleName(String style) Sets one or more user-defined style names of the component, replacing any previous user-defined styles.
default THIS	withVisible(boolean visible) Sets the visibility of the component.

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

Method Detail

withCaption

default THIS withCaption(String caption)

Sets the caption of the component.

A caption is an explanatory textual label accompanying a user interface component, usually shown above, left of, or inside the component. Icon (see setIcon() is closely related to caption and is usually displayed horizontally before or after it, depending on the component and the containing layout.

The caption can usually also be given as the first parameter to a constructor, though some components do not support it.

 RichTextArea area = new RichTextArea();
 area.setCaption("You can edit stuff here");
 area.setValue("<h1>Helpful Heading</h1>"
         + "<p>All this is for you to edit.</p>");
 

The contents of a caption are automatically quoted, so no raw HTML can be rendered in a caption. The validity of the used character encoding, usually UTF-8, is not checked.

The caption of a component is, by default, managed and displayed by the layout component or component container in which the component is placed. For example, the VerticalLayout component shows the captions left-aligned above the contained components, while the FormLayout component shows the captions on the left side of the vertically laid components, with the captions and their associated components left-aligned in their own columns. The CustomComponent does not manage the caption of its composition root, so if the root component has a caption, it will not be rendered. Some components, such as Button and Panel, manage the caption themselves and display it inside the component.

A reimplementation should call the superclass implementation.

Parameters:

caption - the new caption for the component. If the caption is null, no caption is shown and it does not normally take any space

Returns:

this (for method chaining)

See Also:

Component.setCaption(java.lang.String)

withEnabled

default THIS withEnabled(boolean enabled)

Enables or disables the component. The user can not interact with disabled components, which are shown with a style that indicates the status, usually shaded in light gray color. Components are enabled by default.

 Button enabled = new Button("Enabled");
 enabled.setEnabled(true); // The default
 layout.addComponent(enabled);

 Button disabled = new Button("Disabled");
 disabled.setEnabled(false);
 layout.addComponent(disabled);
 

Parameters:

enabled - a boolean value specifying if the component should be enabled or not

Returns:

this (for method chaining)

See Also:

Component.setEnabled(boolean)

withIcon

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

Sets the icon of the component.

An icon is an explanatory graphical label accompanying a user interface component, usually shown above, left of, or inside the component. Icon is closely related to caption (see setCaption()) and is usually displayed horizontally before or after it, depending on the component and the containing layout.

The image is loaded by the browser from a resource, typically a ThemeResource.

 // Component with an icon from a custom theme
 TextField name = new TextField("Name");
 name.setIcon(new ThemeResource("icons/user.png"));
 layout.addComponent(name);

 // Component with an icon from another theme ('runo')
 Button ok = new Button("OK");
 ok.setIcon(new ThemeResource("../runo/icons/16/ok.png"));
 layout.addComponent(ok);
 

The icon of a component is, by default, managed and displayed by the layout component or component container in which the component is placed. For example, the VerticalLayout component shows the icons left-aligned above the contained components, while the FormLayout component shows the icons on the left side of the vertically laid components, with the icons and their associated components left-aligned in their own columns. The CustomComponent does not manage the icon of its composition root, so if the root component has an icon, it will not be rendered.

An icon will be rendered inside an HTML element that has the v-icon CSS style class. The containing layout may enclose an icon and a caption inside elements related to the caption, such as v-caption .

Parameters:

icon - the icon of the component. If null, no icon is shown and it does not normally take any space.

Returns:

this (for method chaining)

See Also:

Component.setIcon(com.vaadin.server.Resource), Component.setCaption(String)

withId

default THIS withId(String id)

Adds an unique id for component that is used in the client-side for testing purposes. Keeping identifiers unique is the responsibility of the programmer.

Parameters:

id - An alphanumeric id

Returns:

this (for method chaining)

See Also:

Component.setId(java.lang.String)

withPrimaryStyleName

default THIS withPrimaryStyleName(String style)

Changes the primary style name of the component.

The primary style name identifies the component when applying the CSS theme to the Component. By changing the style name all CSS rules targeted for that style name will no longer apply, and might result in the component not working as intended.

To preserve the original style of the component when changing to a new primary style you should make your new primary style inherit the old primary style using the SASS @include directive. See more in the SASS tutorials.

Parameters:

style - The new primary style name

Returns:

this (for method chaining)

See Also:

Component.setPrimaryStyleName(java.lang.String)

withStyleName

default THIS withStyleName(String style)

Sets one or more user-defined style names of the component, replacing any previous user-defined styles. Multiple styles can be specified as a space-separated list of style names. The style names must be valid CSS class names and should not conflict with any built-in style names in Vaadin or GWT.

 Label label = new Label("This text has a lot of style");
 label.setStyleName("myonestyle myotherstyle");
 

Each style name will occur in two versions: one as specified and one that is prefixed with the style name of the component. For example, if you have a Button component and give it "mystyle" style, the component will have both "mystyle" and "v-button-mystyle" styles. You could then style the component either with:

 .myonestyle {background: blue;}
 

or

 .v-button-myonestyle {background: blue;}
 

It is normally a good practice to use addStyleName() rather than this setter, as different software abstraction layers can then add their own styles without accidentally removing those defined in other layers.

Parameters:

style - the new style or styles of the component as a space-separated list

Returns:

this for method chaining

See Also:

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

withStyleName

default THIS withStyleName(String... styles)

Adds one or more style names to this component by using one or multiple parameters.

Parameters:

styles - the style name or style names to be added to the component

Returns:

this for method chaining

See Also:

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

withVisible

default THIS withVisible(boolean visible)

Sets the visibility of the component.

Visible components are drawn in the user interface, while invisible ones are not. The effect is not merely a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent.

 TextField readonly = new TextField("Read-Only");
 readonly.setValue("You can't see this!");
 readonly.setVisible(false);
 layout.addComponent(readonly);
 

A component is visible only if all of its parents are also visible. If a component is explicitly set to be invisible, changes in the visibility of its parents will not change the visibility of the component.

Parameters:

visible - the boolean value specifying if the component should be visible after the call or not.

Returns:

this (for method chaining)

See Also:

Component.setVisible(boolean), Component.isVisible()

withParent

default THIS withParent(com.vaadin.ui.HasComponents parent)

Sets the parent connector of the component.

This method automatically calls Component.attach() if the component becomes attached to the session, regardless of whether it was attached previously. Conversely, if the component currently is attached to the session, ClientConnector.detach() is called for the connector before attaching it to a new parent.

This method is rarely called directly. ComponentContainer.addComponent(Component) or a HasComponents specific method is normally used for adding components to a parent and the used method will call this method implicitly.

Parameters:

parent - the parent connector

Returns:

this (for method chaining)

Throws:

IllegalStateException - if a parent is given even though the connector already has a parent

See Also:

Component.setParent(HasComponents)