com.rapidclipse.framework.server.webapi

Class JavascriptTemplate<M extends com.vaadin.flow.templatemodel.TemplateModel>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

com.rapidclipse.framework.server.webapi.JavascriptTemplate<M>

Type Parameters:

M -

All Implemented Interfaces:

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

Direct Known Subclasses:

Geolocation, Network, Online, Payment, Screen, Touch, Video, Visibility

public abstract class JavascriptTemplate<M extends com.vaadin.flow.templatemodel.TemplateModel>
extends com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

This class allows subclasses to register consumers for various javascript events. These are distinguished by their consumed type.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavascriptTemplate()
protected	JavascriptTemplate(com.vaadin.flow.component.HasElement parent)

Method Summary

Modifier and Type	Method and Description
protected void	clearConsumers() Clear the consumers map.
protected <T extends Serializable> void	notifyConsumers(Class<T> type, T object) Notify all the consumers of the given class type to consume the given value.
protected <T extends Serializable> com.vaadin.flow.shared.Registration	registerConsumer(Class<T> type, com.vaadin.flow.function.SerializableConsumer<T> consumer) Add a new consumer to the set of consumers for the specified type.
protected <T extends Serializable> com.vaadin.flow.shared.Registration	registerConsumer(Class<T> type, com.vaadin.flow.function.SerializableConsumer<T> consumer, Runnable firstAddedCallback, Runnable lastRemovedCallback) Add a new consumer to the set of consumers for the specified type.
protected <T extends Serializable> void	unregisterAllConsumers(Class<T> type)
protected <T extends Serializable> void	unregisterAllConsumers(Class<T> type, Runnable unregisterCallback)

Methods inherited from class com.vaadin.flow.component.polymertemplate.PolymerTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModel, getModelType, getModelType, getStateNode, initModel, isSupportedClass

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

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, 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.AttachNotifier

addAttachListener

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

addDetachListener

Constructor Detail

JavascriptTemplate

protected JavascriptTemplate()

JavascriptTemplate

protected JavascriptTemplate(com.vaadin.flow.component.HasElement parent)

Method Detail

registerConsumer

protected <T extends Serializable> com.vaadin.flow.shared.Registration registerConsumer(Class<T> type,
                                                                                        com.vaadin.flow.function.SerializableConsumer<T> consumer)

Add a new consumer to the set of consumers for the specified type. The consumer can be remove with the returned registration.

Parameters:

type - Class type of the consumed value.

consumer - The consumer that should be added to the consumer set.

registerConsumer

protected <T extends Serializable> com.vaadin.flow.shared.Registration registerConsumer(Class<T> type,
                                                                                        com.vaadin.flow.function.SerializableConsumer<T> consumer,
                                                                                        Runnable firstAddedCallback,
                                                                                        Runnable lastRemovedCallback)

Add a new consumer to the set of consumers for the specified type. The consumer can be remove with the returned registration.

Parameters:

type - Class type of the consumed value.

firstAddedCallback - called before the first consumer for the type is registered

lastRemovedCallback - called after the last consumer for the type was removed

consumer - The consumer that should be added to the consumer set.

unregisterAllConsumers

protected <T extends Serializable> void unregisterAllConsumers(Class<T> type)

unregisterAllConsumers

protected <T extends Serializable> void unregisterAllConsumers(Class<T> type,
                                                               Runnable unregisterCallback)

notifyConsumers

protected <T extends Serializable> void notifyConsumers(Class<T> type,
                                                        T object)

Notify all the consumers of the given class type to consume the given value.

Parameters:

type - The class type of the consumers that should be notified.

object - The object that should be consumed by the consumers.

clearConsumers

protected void clearConsumers()

Clear the consumers map.