Package io.jmix.flowui.kit.meta.component.preview

Interface StudioPreviewComponentLoader

All Known Implementing Classes:

StudioFullCalendarPreviewLoader, StudioGeoMapComponentPreviewLoader, StudioKanbanComponentPreviewLoader, StudioStandardComponentsPreviewLoader, StudioSupersetDashboardPreviewLoader

public interface StudioPreviewComponentLoader

Vaadin component loader for Studio view designer preview.

Register new loaders via SPI in META-INF/services/io.jmix.flowui.kit.meta.component.preview.StudioPreviewComponentLoader

See Also:

• StudioPreviewComponentProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VIEW_SCHEMA

Method Summary

Modifier and Type	Method	Description
boolean	isSupported(org.dom4j.Element element)	Define the element that this loader can load.
com.vaadin.flow.component.Component	load(org.dom4j.Element componentElement, org.dom4j.Element viewElement)	Create vaadin component from component xml element.
default Optional<Boolean>	loadBoolean(org.dom4j.Element element, String attributeName)
default void	loadBoolean(org.dom4j.Element element, String attributeName, Consumer<Boolean> setter)
default void	loadClassNames(com.vaadin.flow.component.HasStyle component, org.dom4j.Element element)
default Optional<Double>	loadDouble(org.dom4j.Element element, String attributeName)
default void	loadDouble(org.dom4j.Element element, String attributeName, Consumer<Double> setter)
default void	loadEnabled(com.vaadin.flow.component.HasEnabled component, org.dom4j.Element element)
default <T extends Enum<T>> Optional<T>	loadEnum(org.dom4j.Element element, Class<T> type, String attributeName)
default <T extends Enum<T>> void	loadEnum(org.dom4j.Element element, Class<T> type, String attributeName, Consumer<T> setter)
default void	loadHeight(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default Optional<Integer>	loadInteger(org.dom4j.Element element, String attributeName)
default void	loadInteger(org.dom4j.Element element, String attributeName, Consumer<Integer> setter)
default void	loadMaxHeight(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default void	loadMaxWidth(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default void	loadMinHeight(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default void	loadMinWidth(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default void	loadSizeAttributes(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default Optional<String>	loadString(org.dom4j.Element element, String attributeName)
default Optional<String>	loadString(org.dom4j.Element element, String attributeName, boolean emptyToNull)
default void	loadString(org.dom4j.Element element, String attributeName, Consumer<String> setter)
default void	loadWidth(com.vaadin.flow.component.HasSize component, org.dom4j.Element element)
default List<String>	split(String names)
default void	split(String names, Consumer<String> setter)

Field Details

VIEW_SCHEMA

static final String VIEW_SCHEMA

See Also:

• Constant Field Values

Method Details

isSupported

boolean isSupported(org.dom4j.Element element)

Define the element that this loader can load.

load

@Nullable
com.vaadin.flow.component.Component load(org.dom4j.Element componentElement,
 org.dom4j.Element viewElement)

Create vaadin component from component xml element.

Parameters:

componentElement - xml element of component

viewElement - xml element of view containing componentElement

See Also:

• Element

loadString

default Optional<String> loadString(org.dom4j.Element element,
 String attributeName)

loadString

default Optional<String> loadString(org.dom4j.Element element,
 String attributeName,
 boolean emptyToNull)

loadBoolean

default Optional<Boolean> loadBoolean(org.dom4j.Element element,
 String attributeName)

loadInteger

default Optional<Integer> loadInteger(org.dom4j.Element element,
 String attributeName)

loadDouble

default Optional<Double> loadDouble(org.dom4j.Element element,
 String attributeName)

loadEnum

default <T extends Enum<T>> Optional<T> loadEnum(org.dom4j.Element element,
 Class<T> type,
 String attributeName)

loadString

default void loadString(org.dom4j.Element element,
 String attributeName,
 Consumer<String> setter)

loadBoolean

default void loadBoolean(org.dom4j.Element element,
 String attributeName,
 Consumer<Boolean> setter)

loadInteger

default void loadInteger(org.dom4j.Element element,
 String attributeName,
 Consumer<Integer> setter)

loadDouble

default void loadDouble(org.dom4j.Element element,
 String attributeName,
 Consumer<Double> setter)

loadEnum

default <T extends Enum<T>> void loadEnum(org.dom4j.Element element,
 Class<T> type,
 String attributeName,
 Consumer<T> setter)

loadWidth

default void loadWidth(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadMaxWidth

default void loadMaxWidth(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadMinWidth

default void loadMinWidth(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadHeight

default void loadHeight(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadMaxHeight

default void loadMaxHeight(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadMinHeight

default void loadMinHeight(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadSizeAttributes

default void loadSizeAttributes(com.vaadin.flow.component.HasSize component,
 org.dom4j.Element element)

loadEnabled

default void loadEnabled(com.vaadin.flow.component.HasEnabled component,
 org.dom4j.Element element)

loadClassNames

default void loadClassNames(com.vaadin.flow.component.HasStyle component,
 org.dom4j.Element element)

split

default void split(String names,
 Consumer<String> setter)

split

default List<String> split(String names)