com.rapidclipse.framework.server.webapi.visibility

Class Visibility

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<Visibility.VisibilityTemplateModel>

com.rapidclipse.framework.server.webapi.visibility.Visibility

All Implemented Interfaces:

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

@HtmlImport(value="frontend://webapi/visibility.html")
 @Tag(value="rap-visibility")
public class Visibility
extends JavascriptTemplate<Visibility.VisibilityTemplateModel>

With this class you can query the current visiblity of your application. You can also register listeners for when the visibility status has changed. For example if the application is running in the web browser and the web browser is minimized the visibility would be 'hidden'.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Visibility.VisibilityTemplateModel

Constructor Summary

Constructors

Constructor and Description
Visibility(com.vaadin.flow.component.HasElement parent)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addVisibilityChangeListener(com.vaadin.flow.function.SerializableConsumer<VisibilityState> onVisibilityReceived) Register a onVisibilityChange listener.
static void	getVisibilityState(Consumer<VisibilityState> onVisibilityStateReceived) Get the current visibility state of your application.
static void	isHidden(com.vaadin.flow.function.SerializableConsumer<Boolean> onStatusReceived) Asks the device if the application is currently hidden.
void	unregisterAllVisibilityChangeListeners() Unregister previously registered onVisibilityChange listeners.

Methods inherited from class com.rapidclipse.framework.server.webapi.JavascriptTemplate

clearConsumers, notifyConsumers, registerConsumer, registerConsumer, unregisterAllConsumers, unregisterAllConsumers

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

Visibility

public Visibility(com.vaadin.flow.component.HasElement parent)

Method Detail

addVisibilityChangeListener

public com.vaadin.flow.shared.Registration addVisibilityChangeListener(com.vaadin.flow.function.SerializableConsumer<VisibilityState> onVisibilityReceived)

Register a onVisibilityChange listener. This listener is triggered when the visibility of your application has changed. You can unregister this listener by using the returned Registration or by calling the unregisterAllVisibilityChangeListeners() method.

unregisterAllVisibilityChangeListeners

public void unregisterAllVisibilityChangeListeners()

Unregister previously registered onVisibilityChange listeners. This will also stop the client from sending more events to the server. To register such listener you can call the addVisibilityChangeListener(SerializableConsumer) method.

getVisibilityState

public static void getVisibilityState(Consumer<VisibilityState> onVisibilityStateReceived)

Get the current visibility state of your application.

Parameters:

onVisibilityStateReceived - The callback triggered when the visibility status was received from the client. It consumes said visibility state.

isHidden

public static void isHidden(com.vaadin.flow.function.SerializableConsumer<Boolean> onStatusReceived)

Asks the device if the application is currently hidden. This is a convinient method for the getVisibilityState(Consumer) method.

Parameters:

onStatusReceived - The callback triggered when the status is received from the client. It consumes said status.