Package com.storedobject.vaadin

Class ApplicationView

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

com.storedobject.vaadin.ApplicationView

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.BeforeEnterHandler, Serializable, org.atmosphere.cpr.ApplicationConfig

Direct Known Subclasses:

ApplicationView

public abstract class ApplicationView
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>
implements com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.HasDynamicTitle, org.atmosphere.cpr.ApplicationConfig

The class that defines the content view of the Application. An implementation of this class with the root Route must be there. It is required for using as part of the Application class.

Author:

Syam

See Also:

• Application
• Serialized Form

Field Summary

Fields inherited from interface org.atmosphere.cpr.ApplicationConfig

ALLOW_CORE_THREAD_TIMEOUT, ALLOW_QUERYSTRING_AS_REQUEST, ALLOW_WEBSOCKET_STATUS_CODE_1005_AS_DISCONNECT, ANALYTICS, ANNOTATION_PACKAGE, ANNOTATION_PROCESSOR, ATMOSPHERE_EXCLUDED_FILE, ATMOSPHERE_HANDLER, ATMOSPHERE_HANDLER_MAPPING, ATMOSPHERE_HANDLER_PATH, ATMOSPHERE_INTERCEPTORS, ATMOSPHERE_RESOURCE, ATMOSPHERERESOURCE_INTERCEPTOR_METHOD, ATMOSPHERERESOURCE_INTERCEPTOR_TIMEOUT, AUTODETECT_BROADCASTER, BACKWARD_COMPATIBLE_WEBSOCKET_BEHAVIOR, BROADCAST_FILTER_CLASSES, BROADCASTER_ASYNC_WRITE_THREADPOOL_MAXSIZE, BROADCASTER_CACHE, BROADCASTER_CACHE_STRATEGY, BROADCASTER_CLASS, BROADCASTER_FACTORY, BROADCASTER_FACTORY_EMPTY_WAIT_TIME_IN_SECONDS, BROADCASTER_FACTORY_POOL_SIZE, BROADCASTER_LIFECYCLE_POLICY, BROADCASTER_LIFECYCLE_POLICY_IDLETIME, BROADCASTER_MESSAGE_PROCESSING_THREADPOOL_MAXSIZE, BROADCASTER_POLICY, BROADCASTER_POLICY_TIMEOUT, BROADCASTER_SHARABLE_THREAD_POOLS, BROADCASTER_SHAREABLE_LISTENERS, BROADCASTER_WAIT_TIME, BUILT_IN_SESSION, BYTECODE_PROCESSOR, CACHE_MESSAGE_ON_IO_FLUSH_EXCEPTION, CLIENT_HEARTBEAT_INTERVAL_IN_SECONDS, CLOSE_STREAM_ON_CANCEL, CLOSED_ATMOSPHERE_THINK_TIME, CONTENT_TYPE_FIRST_RESPONSE, CUSTOM_ANNOTATION_PACKAGE, DEFAULT_CONTENT_TYPE, DEFAULT_NAMED_DISPATCHER, DEFAULT_SERIALIZER, DELAY_PROTOCOL_IN_MILLISECONDS, DISABLE_ATMOSPHERE_INITIALIZER, DISABLE_ATMOSPHEREINTERCEPTOR, DISABLE_ATMOSPHEREINTERCEPTORS, DISABLE_ONSTATE_EVENT, DISALLOW_MODIFY_QUERYSTRING, DROP_ACCESS_CONTROL_ALLOW_ORIGIN_HEADER, ENDPOINT_MAPPER, ENFORCE_ATMOSPHERE_VERSION, EXCLUDED_CONTENT_TYPES, EXECUTORFACTORY_KEEP_ALIVE, FILTER_CLASS, FILTER_NAME, FLUSH_BUFFER_HEARTBEAT, HANDLER_MAPPING_REGEX, HEARTBEAT_INTERVAL_IN_SECONDS, HEARTBEAT_PADDING_CHAR, IN_MEMORY_STREAMING_BUFFER_SIZE, INJECTION_LISTENERS, INJECTION_TRY, INVOKE_ATMOSPHERE_INTERCEPTOR_ON_WEBSOCKET_MESSAGE, JERSEY_CONTAINER_RESPONSE_WRITER_CLASS, JETTY_WEBSOCKET_MIN_VERSION, JSR356_MAPPING_PATH, JSR356_PATH_MAPPING_LENGTH, MAPPING, MAX_INACTIVE, MESSAGE_DELIMITER, META_SERVICE_PATH, NO_CACHE_HEADERS, OBJECT_FACTORY, OUT_OF_ORDER_BROADCAST, POOLEABLE_PROVIDER, PROPERTY_ALLOW_SESSION_TIMEOUT_REMOVAL, PROPERTY_ATMOSPHERE_XML, PROPERTY_BLOCKING_COMETSUPPORT, PROPERTY_COMET_SUPPORT, PROPERTY_NATIVE_COMETSUPPORT, PROPERTY_SERVLET_MAPPING, PROPERTY_SESSION_CREATE, PROPERTY_SESSION_SUPPORT, PROPERTY_THROW_EXCEPTION_ON_CLONED_REQUEST, PROPERTY_USE_STREAM, READ_GET_BODY, RECOVER_DEAD_BROADCASTER, RECYCLE_ATMOSPHERE_REQUEST_RESPONSE, RESPONSE_COMPLETION_AWARE, RESPONSE_COMPLETION_RESET, RESUME_ON_BROADCAST, RESUME_ON_HEARTBEAT, RESUMED_ON_TIMEOUT, REWRITE_WEBSOCKET_REQUESTURI, SCAN_CLASSPATH, SCHEDULER_THREADPOOL_MAXSIZE, SERVLET_CLASS, SERVLET_NAME, SESSION_MAX_INACTIVE_INTERVAL, SHARED, SSE_CONTENT_TYPE, SSE_DEFAULT_CONTENTTYPE, STATE_RECOVERY_TIMEOUT, SUPPORT_LOCATION_HEADER, SUPPORT_TRACKED_BROADCASTER, SUSPENDED_ATMOSPHERE_RESOURCE_UUID, TOMCAT_CLOSE_STREAM, TWO_STEPS_WRITE, UNIQUE_UUID_WEBSOCKET, USE_FORJOINPOOL, USE_SERVLET_CONTEXT_PARAMETERS, UUIDBROADCASTERCACHE_CLIENT_IDLETIME, UUIDBROADCASTERCACHE_IDLE_CACHE_INTERVAL, WEB_SOCKET_BANNED_VERSION, WEBSOCKET_BINARY_WRITE, WEBSOCKET_BUFFER_SIZE, WEBSOCKET_CONTENT_TYPE, WEBSOCKET_IDLETIME, WEBSOCKET_MAXBINARYSIZE, WEBSOCKET_MAXTEXTSIZE, WEBSOCKET_METHOD, WEBSOCKET_PATH_DELIMITER, WEBSOCKET_PROCESSOR, WEBSOCKET_PROTOCOL, WEBSOCKET_PROTOCOL_EXECUTION, WEBSOCKET_REQUIRE_SAME_ORIGIN, WEBSOCKET_SUPPORT, WEBSOCKET_SUPPORT_SERVLET3, WEBSOCKET_SUPPRESS_JSR356, WEBSOCKET_WRITE_TIMEOUT, WRITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
ApplicationView()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	add(com.vaadin.flow.component.Component screen)	Adds a given component to the root container of the application view.
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)
protected Application	createApplication()	Create an instance of the Application class.
protected String	getApplicationClassName()	Get the name of the Application class.
int	getDeviceHeight()	Get the device (browser) height.
int	getDeviceWidth()	Get the device (browser) width.
String	getPageTitle()	Get the page title to be displayed.
String	getURL()	get tje URL of application.
protected final com.vaadin.flow.component.Component	initContent()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
void	setLayoutVisible(boolean visible)	Sets the visibility of the layout's main component.

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

getChildren, getContent, getElement

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

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, 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

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

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

ApplicationView

public ApplicationView()

Default constructor.

Method Details

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

onDetach

protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)

Overrides:

onDetach in class com.vaadin.flow.component.Component

initContent

protected final com.vaadin.flow.component.Component initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

add

public void add(com.vaadin.flow.component.Component screen)

Adds a given component to the root container of the application view.

Parameters:

screen - The component to be added to the root container. If the component is null, no action is performed.

setLayoutVisible

public void setLayoutVisible(boolean visible)

Sets the visibility of the layout's main component.

Parameters:

visible - A boolean indicating whether the layout's main component should be visible (true) or hidden (false).

getDeviceHeight

public int getDeviceHeight()

Get the device (browser) height.

Returns:

Device height.

getDeviceWidth

public int getDeviceWidth()

Get the device (browser) width.

Returns:

Device width.

getURL

public String getURL()

get tje URL of application.

Returns:

URL of the application as a string.

createApplication

protected Application createApplication()

Create an instance of the Application class. This is invoked only once.

Returns:

Newly created Application. (By default it tries to construct an instance for the class name returned by getApplicationClassName()).

getApplicationClassName

protected String getApplicationClassName()

Get the name of the Application class.

Returns:

Fully qualified name of the Application class. (Default value returned is null).

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

getPageTitle

public String getPageTitle()

Get the page title to be displayed. By default, the Application.getCaption() is used as the page title.

Specified by:

getPageTitle in interface com.vaadin.flow.router.HasDynamicTitle

Returns:

Page title.