Package com.vaadin.flow.component.details

Class Details

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.details.Details

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, HasTooltip, Serializable

Direct Known Subclasses:

AccordionPanel

@Tag("vaadin-details")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.3.2") @NpmPackage(value="@vaadin/details",version="23.3.2") @NpmPackage(value="@vaadin/vaadin-details",version="23.3.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/details/src/vaadin-details.js")
public class Details
extends Component
implements HasEnabled, HasTheme, HasStyle, HasSize, HasTooltip

Details is an expandable panel for showing and hiding content from the user to make the UI less crowded. Details consists of a summary and a content area.

The Summary is the part that is always visible, and typically describes the contents, for example, with a title. Clicking on the summary toggles the content area’s visibility. The summary supports rich content and can contain any component. This can be utilized for example to indicate the status of the corresponding content.

The content area is the collapsible part of Details. It can contain any component. When the content area is collapsed, the content is invisible and inaccessible by keyboard or screen reader.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Details.OpenedChangeEvent

Constructor Summary

Constructors

Constructor	Description
Details()	Initializes a new Details component.
Details(Component summary)	Initializes a new Details using the provided summary.
Details(Component summary, Component content)	Initializes a new Details using the provided summary and content.
Details(Component summary, Component... components)	Initializes a new Details using the provided summary and content components.
Details(String summary)	Initializes a new Details using the provided summary.
Details(String summary, Component content)	Initializes a new Details using the provided summary and content.
Details(String summary, Component... components)	Initializes a new Details using the provided summary and content components.

Method Summary

Modifier and Type	Method	Description
void	addContent(Component... components)	Adds components to the content section
Registration	addOpenedChangeListener(ComponentEventListener<Details.OpenedChangeEvent> listener)	Adds a listener for opened-changed events fired by the webcomponent.
void	addThemeVariants(DetailsVariant... variants)	Adds theme variants to the component.
Stream<Component>	getContent()	Returns the content components which were added via setContent(Component) or via addContent(Component...)
Component	getSummary()	Returns summary component which was set via setSummary(Component) or setSummaryText(String)
String	getSummaryText()
boolean	isOpened()	See setOpened(boolean)
void	removeThemeVariants(DetailsVariant... variants)	Removes theme variants from the component.
void	setContent(Component content)	Sets the component content
void	setOpened(boolean opened)	True if the details are opened and the content is displayed
void	setSummary(Component summary)	Sets the component summary
void	setSummaryText(String summary)	Creates a text wrapper and sets a summary via setSummary(Component)

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Constructor Detail

Details

public Details()

Initializes a new Details component.

Details

public Details(String summary)

Initializes a new Details using the provided summary.

Parameters:

summary - the summary component to set.

See Also:

setSummaryText(String)

Details

public Details(Component summary)

Initializes a new Details using the provided summary.

Parameters:

summary - the summary component to set.

See Also:

setSummary(Component)

Details

public Details(String summary,
               Component content)

Initializes a new Details using the provided summary and content.

Parameters:

summary - the summary text to set.

content - the content component to set.

See Also:

setSummaryText(String), setContent(Component)

Details

public Details(Component summary,
               Component content)

Initializes a new Details using the provided summary and content.

Parameters:

summary - the summary component to set.

content - the content component to set.

See Also:

setSummary(Component), setContent(Component)

Details

public Details(String summary,
               Component... components)

Initializes a new Details using the provided summary and content components.

Parameters:

summary - the summary text to set.

components - the content components to set.

See Also:

setSummaryText(String), addContent(Component...)

Details

public Details(Component summary,
               Component... components)

Initializes a new Details using the provided summary and content components.

Parameters:

summary - the summary component to set.

components - the content components to set.

See Also:

setSummary(Component), addContent(Component...)

Method Detail

setSummary

public void setSummary(Component summary)

Sets the component summary

Parameters:

summary - the summary component to set, or null to remove any previously set summary

See Also:

getSummary()

getSummary

public Component getSummary()

Returns summary component which was set via setSummary(Component) or setSummaryText(String)

Returns:

the summary component, null if nothing was set

setSummaryText

public void setSummaryText(String summary)

Creates a text wrapper and sets a summary via setSummary(Component)

getSummaryText

public String getSummaryText()

Returns:

summary section content as string (empty string if nothing was set)

setContent

public void setContent(Component content)

Sets the component content

Parameters:

content - the content of the component to set, or null to remove any previously set content

See Also:

getContent()

addContent

public void addContent(Component... components)

Adds components to the content section

Parameters:

components - the components to add

See Also:

getContent()

getContent

public Stream<Component> getContent()

Returns the content components which were added via setContent(Component) or via addContent(Component...)

Returns:

the child components of the content section

isOpened

@Synchronize(property="opened",
             value="opened-changed")
public boolean isOpened()

See setOpened(boolean)

Returns:

whether details are expanded or collapsed

setOpened

public void setOpened(boolean opened)

True if the details are opened and the content is displayed

Parameters:

opened - the boolean value to set

addThemeVariants

public void addThemeVariants(DetailsVariant... variants)

Adds theme variants to the component.

Parameters:

variants - theme variants to add

removeThemeVariants

public void removeThemeVariants(DetailsVariant... variants)

Removes theme variants from the component.

Parameters:

variants - theme variants to remove

addOpenedChangeListener

public Registration addOpenedChangeListener(ComponentEventListener<Details.OpenedChangeEvent> listener)

Adds a listener for opened-changed events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener