Package com.storedobject.vaadin

Class DetailComponent

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div>

com.storedobject.vaadin.DetailComponent

All Implemented Interfaces:

HasSize, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable

@Tag("div")
public class DetailComponent
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div>
implements HasSize

A component with a "header" and a "detail" part. The "detail" part is normally hidden and only the "header" part is visible. The visibility of the "detail" part can be toggled by clicking on the "header" part.

Author:

Syam (Initial version was written by Anand Jeypal)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DetailComponent.ToggledEvent	Class that represents the "toggled event".
static interface	DetailComponent.ToggleListener	Interface for the toggle listener.

Constructor Summary

Constructors

Constructor	Description
DetailComponent()	Constructor with blank header.
DetailComponent(com.vaadin.flow.component.Component header, com.vaadin.flow.component.Component... content)	Constructor.
DetailComponent(String header, com.vaadin.flow.component.Component... content)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addContent(com.vaadin.flow.component.Component... components)	Add components to the content section.
com.vaadin.flow.shared.Registration	addToggleListener(DetailComponent.ToggleListener toggleListener)	Add content toggle listener.
void	clearContent()	Clear the content section.
void	collapse()	Collapse the content section.
protected com.vaadin.flow.component.HasComponents	createHeader(String headerText)	Create the header portion.
void	expand()	Expand the content section.
com.vaadin.flow.component.html.Div	getContentLayout()	Get the content layout.
protected final com.vaadin.flow.component.html.Div	initContent()
void	setContent(com.vaadin.flow.component.Component... components)	Set components to the content section.
void	setHeader(com.vaadin.flow.component.Component header)	Set the header.
void	setHeader(String header)	Set the header.
void	toggle()	Toggle the content section.

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

getChildren, getContent, getElement

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

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, 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.storedobject.vaadin.HasSize

setHeight, setWidth

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

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

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

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

Constructor Details

DetailComponent

public DetailComponent()

Constructor with blank header.

DetailComponent

public DetailComponent(String header,
 com.vaadin.flow.component.Component... content)

Constructor.

Parameters:

header - Header text

content - Content

DetailComponent

public DetailComponent(com.vaadin.flow.component.Component header,
 com.vaadin.flow.component.Component... content)

Constructor.

Parameters:

header - Header component

content - Content

Method Details

initContent

protected final com.vaadin.flow.component.html.Div initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.Div>

setHeader

public void setHeader(com.vaadin.flow.component.Component header)

Set the header.

Parameters:

header - Header

setHeader

public void setHeader(String header)

Set the header.

Parameters:

header - Header

getContentLayout

public com.vaadin.flow.component.html.Div getContentLayout()

Get the content layout.

Returns:

The content section.

addContent

public void addContent(com.vaadin.flow.component.Component... components)

Add components to the content section.

Parameters:

components - Component to add

setContent

public void setContent(com.vaadin.flow.component.Component... components)

Set components to the content section.

Parameters:

components - Components to set

clearContent

public void clearContent()

Clear the content section.

createHeader

protected com.vaadin.flow.component.HasComponents createHeader(String headerText)

Create the header portion. By default it creates an H3.

Parameters:

headerText - Header text to be set

Returns:

Header component to set.

collapse

public void collapse()

Collapse the content section.

expand

public void expand()

Expand the content section.

toggle

public void toggle()

Toggle the content section.

addToggleListener

public com.vaadin.flow.shared.Registration addToggleListener(DetailComponent.ToggleListener toggleListener)

Add content toggle listener.

Parameters:

toggleListener - Listener

Returns:

Registration.