com.vaadin.flow.demo

Class DemoView

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.demo.DemoView

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.HasUrlParameter<String>, Serializable

@Tag(value="div")
 @Theme(value=com.vaadin.flow.theme.lumo.Lumo.class)
 @StyleSheet(value="src/css/demo.css") @StyleSheet(value="src/css/prism.css")
public abstract class DemoView
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasComponents, com.vaadin.flow.router.HasUrlParameter<String>, com.vaadin.flow.component.HasStyle

Base class for all the Views that demo some component.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DemoView()

Method Summary

Modifier and Type	Method and Description
void	add(com.vaadin.flow.component.Component... components) No-op method so that we can use the line add(Component) in vaadin.com demos.
Card	addCard(String heading, com.vaadin.flow.component.Component... components) Creates and adds a new component card to the "Basic usage" tab in the view.
Card	addCard(String tabName, String heading, com.vaadin.flow.component.Component... components) Creates and adds a new component card to a specific tab in the view.
protected <T extends Enum<?>,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasTheme> void	addVariantsDemo(Supplier<C> componentSupplier, BiConsumer<C,T> addVariant, BiConsumer<C,T> removeVariant, Function<T,String> variantToThemeName, T... variants) Adds a demo that shows how the component looks like with specific variants applied.
protected abstract void	initView() Builds the content of the view.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	populateSources() When called the view should populate the given SourceContainer with sample source code to be shown.
void	setParameter(com.vaadin.flow.router.BeforeEvent event, String parameter)

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, 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.HasComponents

add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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

isEnabled, setEnabled

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

getElement

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

addAttachListener

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

addDetachListener

Constructor Detail

DemoView

protected DemoView()

Method Detail

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

initView

protected abstract void initView()

Builds the content of the view.

populateSources

public void populateSources()

When called the view should populate the given SourceContainer with sample source code to be shown.

addCard

public Card addCard(String heading,
                    com.vaadin.flow.component.Component... components)

Creates and adds a new component card to the "Basic usage" tab in the view. It automatically adds any source code examples with the same heading to the bottom of the card.

Parameters:

heading - the header text of the card, that is added to the layout. If null or empty, the header is not added

components - components to add on creation. If null or empty, the card is created without the components inside

Returns:

created component container card

See Also:

addCard(String, String, Component...)

addCard

public Card addCard(String tabName,
                    String heading,
                    com.vaadin.flow.component.Component... components)

Creates and adds a new component card to a specific tab in the view. It automatically adds any source code examples with the same heading to the bottom of the card.

The href of the tab is defined based on the tab name. For example, a tab named "Advanced usage" has the "advanced-tab" as href (all in lower case and with "-" in place of spaces and special characters).

Parameters:

tabName - the name of the tab that will contain the demo, not null

heading - the header text of the card, that is added to the layout. If null or empty, the header is not added

components - components to add on creation. If null or empty, the card is created without the components inside

Returns:

created component container card

setParameter

public void setParameter(com.vaadin.flow.router.BeforeEvent event,
                         @OptionalParameter
                         String parameter)

Specified by:

setParameter in interface com.vaadin.flow.router.HasUrlParameter<String>

addVariantsDemo

protected <T extends Enum<?>,C extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasTheme> void addVariantsDemo(Supplier<C> componentSupplier,
                                                                                                                                      BiConsumer<C,T> addVariant,
                                                                                                                                      BiConsumer<C,T> removeVariant,
                                                                                                                                      Function<T,String> variantToThemeName,
                                                                                                                                      T... variants)

Adds a demo that shows how the component looks like with specific variants applied.

Type Parameters:

T - variants' type

C - component's type

Parameters:

componentSupplier - a method that creates the component to which variants will be applied to

addVariant - a function that adds the new variant to the component

removeVariant - a function that removes the variant from the component

variantToThemeName - function that converts variant to an html theme name

variants - list of variants to show in the demos

add

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

No-op method so that we can use the line add(Component) in vaadin.com demos.

Specified by:

add in interface com.vaadin.flow.component.HasComponents