com.vaadin.fluent.api

Interface FluentComposite<THIS extends FluentComposite<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, FluentAbstractComponent<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentContextClickNotifier<THIS>, FluentHasComponents<THIS>, FluentSizeable<THIS>, com.vaadin.ui.HasComponents, Iterable<com.vaadin.ui.Component>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentTree<THIS,ITEM>

All Known Implementing Classes:

FTree

public interface FluentComposite<THIS extends FluentComposite<THIS>>
extends FluentAbstractComponent<THIS>, FluentHasComponents<THIS>

The base interface for fluent versions of Composite

See Also:

Composite

Nested Class Summary

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

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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) Sets the caption of the component.
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	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	withFullHeight() Sets the height to 100%.
default THIS	withFullSize() Sets the size to 100% x 100%.
default THIS	withFullWidth() Sets the width to 100%.
default THIS	withHeight(float height, com.vaadin.server.Sizeable.Unit unit) Sets the height of the object.
default THIS	withHeight(String height) Sets the height of the component using String presentation.
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	withPrimaryStyleName(String style) Changes the primary style name of the component.
default THIS	withSize(String width, String height)
default THIS	withStyleName(String style) Sets one or more user-defined style names of the component, replacing any previous user-defined styles.
default THIS	withStyleName(String style, boolean add) Adds or removes a style name.
default THIS	withUndefinedHeight() Clears any defined height
default THIS	withUndefinedSize() Clears any size settings.
default THIS	withUndefinedWidth() Clears any defined width
default THIS	withWidth(float width, com.vaadin.server.Sizeable.Unit unit) Sets the width of the object.
default THIS	withWidth(String width) Sets the width of the component using String presentation.

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

withData, withLocale, withResponsive, withShortcutListener

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

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

withEnabled, withParent, 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.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.

Specified by:

withCaption in interface FluentComponent<THIS extends FluentComposite<THIS>>

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:

Composite.setCaption(java.lang.String)

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 .

Specified by:

withIcon in interface FluentComponent<THIS extends FluentComposite<THIS>>

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:

Composite.setIcon(com.vaadin.server.Resource)

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.

Specified by:

withId in interface FluentComponent<THIS extends FluentComposite<THIS>>

Parameters:

id - An alphanumeric id

Returns:

this (for method chaining)

See Also:

Composite.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.

Specified by:

withPrimaryStyleName in interface FluentComponent<THIS extends FluentComposite<THIS>>

Parameters:

style - The new primary style name

Returns:

this (for method chaining)

See Also:

Composite.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.

Specified by:

withStyleName in interface FluentComponent<THIS extends FluentComposite<THIS>>

Parameters:

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

Returns:

this for method chaining

See Also:

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

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 Composite.addStyleName(String) or Composite.removeStyleName(String)

Specified by:

withStyleName in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>

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:

Composite.addStyleName(String), Composite.removeStyleName(String)

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.

Specified by:

withCaptionAsHtml in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>

Parameters:

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

Returns:

this (for method chaining)

See Also:

Composite.setCaptionAsHtml(boolean)

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.

Specified by:

withDescription in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>

Parameters:

description - the new description string for the component.

Returns:

this (for method chaining)

See Also:

Composite.setDescription(java.lang.String)

withDescription

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

Description copied from interface: FluentAbstractComponent

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.

Specified by:

withDescription in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>

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.

Specified by:

withComponentError in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>

Parameters:

componentError - the new ErrorMessage of the component.

Returns:

this (for method chaining)

See Also:

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

withHeight

default THIS withHeight(String height)

Sets the height of the component using String presentation. String presentation is similar to what is used in Cascading Style Sheets. Size can be length or percentage of available size. The empty string ("") or null will unset the height and set the units to pixels. See CSS specification for more details.

Specified by:

withHeight in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Parameters:

height - in CSS style string representation

Returns:

this (for method chaining)

See Also:

Composite.setHeight(java.lang.String)

withHeight

default THIS withHeight(float height,
                        com.vaadin.server.Sizeable.Unit unit)

Sets the height of the object. Negative number implies unspecified size (terminal is free to set the size).

Specified by:

withHeight in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Parameters:

height - the height of the object.

unit - the unit used for the width.

Returns:

this (for method chaining)

See Also:

Composite.setHeight(float, com.vaadin.server.Sizeable.Unit)

withWidth

default THIS withWidth(String width)

Sets the width of the component using String presentation. String presentation is similar to what is used in Cascading Style Sheets. Size can be length or percentage of available size. The empty string ("") or null will unset the width and set the units to pixels. See CSS specification for more details.

Specified by:

withWidth in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Parameters:

width - in CSS style string representation, null or empty string to reset

Returns:

this (for method chaining)

See Also:

Composite.setWidth(java.lang.String)

withWidth

default THIS withWidth(float width,
                       com.vaadin.server.Sizeable.Unit unit)

Sets the width of the object. Negative number implies unspecified size (terminal is free to set the size).

Specified by:

withWidth in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Parameters:

width - the width of the object.

unit - the unit used for the width.

Returns:

this (for method chaining)

See Also:

Composite.setWidth(float, com.vaadin.server.Sizeable.Unit)

withFullSize

default THIS withFullSize()

Sets the size to 100% x 100%.

Specified by:

withFullSize in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

See Also:

Composite.setSizeFull()

withFullWidth

default THIS withFullWidth()

Sets the width to 100%.

Specified by:

withFullWidth in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

withFullHeight

default THIS withFullHeight()

Sets the height to 100%.

Specified by:

withFullHeight in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

withUndefinedSize

default THIS withUndefinedSize()

Clears any size settings.

Specified by:

withUndefinedSize in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

See Also:

Composite.setSizeUndefined()

withUndefinedWidth

default THIS withUndefinedWidth()

Clears any defined width

Specified by:

withUndefinedWidth in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

See Also:

Composite.setWidthUndefined()

withUndefinedHeight

default THIS withUndefinedHeight()

Clears any defined height

Specified by:

withUndefinedHeight in interface FluentSizeable<THIS extends FluentComposite<THIS>>

Returns:

this (for method chaining)

See Also:

Composite.setHeightUndefined()

withSize

default THIS withSize(String width,
                      String height)

Specified by:

withSize in interface FluentSizeable<THIS extends FluentComposite<THIS>>

withCaption

default THIS withCaption(String caption,
                         boolean captionAsHtml)

Specified by:

withCaption in interface FluentAbstractComponent<THIS extends FluentComposite<THIS>>