com.rapidclipse.framework.server.webapi.screen

Class Screen

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<Screen.ScreenTemplateModel>

com.rapidclipse.framework.server.webapi.screen.Screen

All Implemented Interfaces:

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

@HtmlImport(value="frontend://webapi/screen.html")
 @Tag(value="rap-screen")
public class Screen
extends JavascriptTemplate<Screen.ScreenTemplateModel>

This class can request the browser to fullscreen specific elements and lock the screen orientation.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Screen.LockOrientation
static interface	Screen.ScreenTemplateModel

Constructor Summary

Constructors

Constructor and Description
Screen(com.vaadin.flow.component.HasElement target)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addFullscreenErrorListener(com.vaadin.flow.function.SerializableConsumer<FullscreenError> listener) This listener is triggered when a call to #requestFullscreen(Element, FullscreenOptions) returned an error.
com.vaadin.flow.shared.Registration	addFullscreenExitErrorListener(com.vaadin.flow.function.SerializableConsumer<FullscreenExitError> listener) This listener is triggered when a call to exitFullscreen() returned an error.
com.vaadin.flow.shared.Registration	addScreenOrientationListener(com.vaadin.flow.function.SerializableConsumer<ScreenOrientation> listener) Register a callback that is triggered everytime the devices screen orientation has changed.
void	exitFullscreen() This method can be called to exit a previously fullscreened element.
static void	fullscreenEnabled(com.vaadin.flow.function.SerializableConsumer<Boolean> callback) Asks the device if fullscreening is available.
static void	getScreenOrientation(Consumer<ScreenOrientation> callback) Ask the device in which screen orientation it currently is.
static void	lockScreenOrientation(Screen.LockOrientation orientation) Lock the current screen orientation.
void	requestFullscreen(FullscreenOptions options) Asks the user agent to place the target element (and, by extension, its descendants) into full-screen mode.
static void	unlockScreenOrientation() Unlock the screen orientation.
void	unregisterAllScreenOrientationListeners() Unregister all previously registered 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

Screen

public Screen(com.vaadin.flow.component.HasElement target)

Method Detail

addScreenOrientationListener

public com.vaadin.flow.shared.Registration addScreenOrientationListener(com.vaadin.flow.function.SerializableConsumer<ScreenOrientation> listener)

Register a callback that is triggered everytime the devices screen orientation has changed. This listener can be unregistered via the returned registration.

Parameters:

listener - The listener triggered when the screen orientation is received from the client. It will consume the current screen orientation.

addFullscreenErrorListener

public com.vaadin.flow.shared.Registration addFullscreenErrorListener(com.vaadin.flow.function.SerializableConsumer<FullscreenError> listener)

This listener is triggered when a call to #requestFullscreen(Element, FullscreenOptions) returned an error. The consumer can be removed with the returned Registration.

addFullscreenExitErrorListener

public com.vaadin.flow.shared.Registration addFullscreenExitErrorListener(com.vaadin.flow.function.SerializableConsumer<FullscreenExitError> listener)

This listener is triggered when a call to exitFullscreen() returned an error. The consumer can be removed with the returned Registration.

fullscreenEnabled

public static void fullscreenEnabled(com.vaadin.flow.function.SerializableConsumer<Boolean> callback)

Asks the device if fullscreening is available.

Parameters:

callback - The callback triggered when the result is returned to the server. It consumes the Boolean indicating if the device supports fullscreening or not.

requestFullscreen

public void requestFullscreen(FullscreenOptions options)

Asks the user agent to place the target element (and, by extension, its descendants) into full-screen mode. If an error occurrs the onFullscreenError callbacks registered via the addFullscreenErrorListener(SerializableConsumer) method are triggered. Fullscreen can be exited with the #exitFullscreen(Consumer) method.

Parameters:

options - Currently only contains the option if the navigation ui of the browser should be shown or not.

exitFullscreen

public void exitFullscreen()

This method can be called to exit a previously fullscreened element. If this operation fails the onFullscreenExitError callbacks registered via the addFullscreenExitErrorListener(SerializableConsumer) method are triggered. To fullscreen an element the requestFullscreen(FullscreenOptions) method can be called.

getScreenOrientation

public static void getScreenOrientation(Consumer<ScreenOrientation> callback)

Ask the device in which screen orientation it currently is. When this information is received the onScreenOrientationReceived callback is triggered.

Parameters:

callback - The callback triggered when the screen orientation is received. It will consume the current screen orientation.

unregisterAllScreenOrientationListeners

public void unregisterAllScreenOrientationListeners()

Unregister all previously registered listeners. This will also stop the client from sending more events to the server.

lockScreenOrientation

public static void lockScreenOrientation(Screen.LockOrientation orientation)

Lock the current screen orientation. You can unlock the screen by exiting fullscreen with the exitFullscreen() method or by unlocking the current screen orientation with the unlockScreenOrientation() method
Note: Fullscreen has to be engaged for this method to work. You can fullscreen an element with the #requestFullscreen(Element, FullscreenOptions) method.

Parameters:

orientation - The orientation the screen should be locked in.

unlockScreenOrientation

public static void unlockScreenOrientation()

Unlock the screen orientation. You can lock in a screen orientation with the lockScreenOrientation(LockOrientation) method.