org.cesiumjs.cs.core

Class Fullscreen

java.lang.Object

org.cesiumjs.cs.core.Fullscreen

@JsType(isNative=true,
        namespace="Cesium",
        name="Fullscreen")
public class Fullscreen
extends Object

Browser-independent functions for working with the standard fullscreen API. See: W3C Fullscreen Living Specification

Author:

Serge Silaev aka iSergio

Method Summary

Modifier and Type	Method and Description
static String	changeEventName() The name of the event on the document that is fired when fullscreen is entered or exited.
static Object	element() The element that is currently fullscreen, if any.
static boolean	enabled() Determine whether the browser will allow an element to be made fullscreen, or not.
static String	errorEventName() The name of the event that is fired when a fullscreen error occurs.
static void	exitFullscreen() Asynchronously exits fullscreen mode.
static boolean	fullscreen() Determines if the browser is currently in fullscreen mode.
static void	requestFullscreen(Object element) Asynchronously requests the browser to enter fullscreen mode on the given element.
static void	requestFullscreen(Object element, HMDVRDevice vrDevice) Asynchronously requests the browser to enter fullscreen mode on the given element.
static boolean	supportsFullscreen() Detects whether the browser supports the standard fullscreen API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

changeEventName

@JsProperty(name="changeEventName")
public static String changeEventName()

The name of the event on the document that is fired when fullscreen is entered or exited. This event name is intended for use with addEventListener. In your event handler, to determine if the browser is in fullscreen mode or not, use Fullscreen#fullscreen.

element

@JsProperty(name="element")
public static Object element()

The element that is currently fullscreen, if any. To simply check if the browser is in fullscreen mode or not, use Fullscreen#fullscreen.

enabled

@JsProperty(name="enabled")
public static boolean enabled()

Determine whether the browser will allow an element to be made fullscreen, or not. For example, by default, iframes cannot go fullscreen unless the containing page adds an "allowfullscreen" attribute (or prefixed equivalent).

errorEventName

@JsProperty(name="errorEventName")
public static String errorEventName()

The name of the event that is fired when a fullscreen error occurs. This event name is intended for use with addEventListener.

fullscreen

@JsProperty(name="fullscreen")
public static boolean fullscreen()

Determines if the browser is currently in fullscreen mode.

exitFullscreen

@JsMethod
public static void exitFullscreen()

Asynchronously exits fullscreen mode. If the browser is not currently in fullscreen, or if fullscreen mode is not supported by the browser, does nothing.

requestFullscreen

@JsMethod
public static void requestFullscreen(Object element)

Asynchronously requests the browser to enter fullscreen mode on the given element. If fullscreen mode is not supported by the browser, does nothing.

Parameters:

element - The HTML element which will be placed into fullscreen mode.

requestFullscreen

@JsMethod
public static void requestFullscreen(Object element,
                                               HMDVRDevice vrDevice)

Asynchronously requests the browser to enter fullscreen mode on the given element. If fullscreen mode is not supported by the browser, does nothing.

Parameters:

element - The HTML element which will be placed into fullscreen mode.

vrDevice - The VR device.

supportsFullscreen

@JsMethod
public static boolean supportsFullscreen()

Detects whether the browser supports the standard fullscreen API.

Returns:

true if the browser supports the standard fullscreen API, false otherwise.