CmsAppView (OpenCms Core API, version 11.0.0)

java.lang.Object
- org.opencms.ui.apps.CmsAppView

All Implemented Interfaces:

com.vaadin.event.Action.Handler, com.vaadin.navigator.View, com.vaadin.navigator.ViewChangeListener, com.vaadin.server.Page.BrowserWindowResizeListener, java.io.Serializable, I_CmsWindowCloseListener, I_CmsAppView
```
public class CmsAppView
extends java.lang.Object
implements com.vaadin.navigator.ViewChangeListener, I_CmsWindowCloseListener, I_CmsAppView, com.vaadin.event.Action.Handler, com.vaadin.server.Page.BrowserWindowResizeListener
```
Displays the selected app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CmsAppView.CacheStatus` Enum representing caching status of a view.
`protected class`	`CmsAppView.NotAvailableApp` Used in case the requested app can not be displayed to the current user.

Nested classes/interfaces inherited from interface com.vaadin.navigator.ViewChangeListener
com.vaadin.navigator.ViewChangeListener.ViewChangeEvent

Constructor Summary

Constructors
Constructor and Description

CmsAppView(I_CmsWorkplaceAppConfiguration appConfig)
Constructor.

Constructors
Constructor and Description
`CmsAppView(I_CmsWorkplaceAppConfiguration appConfig)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)`
`boolean`	`beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)`
`void`	`browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent event)`
`void`	`disableGlobalShortcuts()` Disables the global keyboard shortcuts.
`void`	`enableGlobalShortcuts()` Enables the global keyboard shortcuts.
`void`	`enter(java.lang.String newState)` Enters the view.
`void`	`enter(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)`
`com.vaadin.event.Action[]`	`getActions(java.lang.Object target, java.lang.Object sender)`
`CmsAppView.CacheStatus`	`getCacheStatus()` Gets the cache status of the view.
`CmsAppViewLayout`	`getComponent()` Returns the app component, initializes it if required.
`java.lang.String`	`getName()` Returns the view name.
`void`	`handleAction(com.vaadin.event.Action action, java.lang.Object sender, java.lang.Object target)`
`boolean`	`isCachable()` Returns whether this view should be cached within the user session.
`void`	`onWindowClose()` Executed on window close.
`CmsAppViewLayout`	`reinitComponent()` Creates a new component instance.
`boolean`	`requiresRestore()` Returns whether this view needs to be restored from cache.
`void`	`restoreFromCache()` Restores the view from cache.
`void`	`setCacheStatus(CmsAppView.CacheStatus status)` Sets the cache status.
`void`	`setRequiresRestore(boolean restored)` Sets the requires restore from cache flag.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.navigator.View
beforeLeave, getViewComponent

- Constructor Detail
  - CmsAppView
```
public CmsAppView(I_CmsWorkplaceAppConfiguration appConfig)
```
    Constructor.
    
    Parameters:
    
    appConfig - the app configuration
- Method Detail
  - afterViewChange
```
public void afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
```
    Specified by:
    
    afterViewChange in interface com.vaadin.navigator.ViewChangeListener
    
    See Also:
    
    ViewChangeListener.afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
  - beforeViewChange
```
public boolean beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
```
    Specified by:
    
    beforeViewChange in interface com.vaadin.navigator.ViewChangeListener
    
    See Also:
    
    ViewChangeListener.beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
  - browserWindowResized
```
public void browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent event)
```
    Specified by:
    
    browserWindowResized in interface com.vaadin.server.Page.BrowserWindowResizeListener
    
    See Also:
    
    Page.BrowserWindowResizeListener.browserWindowResized(com.vaadin.server.Page.BrowserWindowResizeEvent)
  - disableGlobalShortcuts
```
public void disableGlobalShortcuts()
```
    Description copied from interface: I_CmsAppView
    
    Disables the global keyboard shortcuts.
    
    Specified by:
    
    disableGlobalShortcuts in interface I_CmsAppView
    
    See Also:
    
    I_CmsAppView.disableGlobalShortcuts()
  - enableGlobalShortcuts
```
public void enableGlobalShortcuts()
```
    Description copied from interface: I_CmsAppView
    
    Enables the global keyboard shortcuts.
    
    Specified by:
    
    enableGlobalShortcuts in interface I_CmsAppView
    
    See Also:
    
    I_CmsAppView.enableGlobalShortcuts()
  - enter
```
public void enter(java.lang.String newState)
```
    Description copied from interface: I_CmsAppView
    
    Enters the view.
    
    Specified by:
    
    enter in interface I_CmsAppView
    
    Parameters:
    
    newState - the state to set
    
    See Also:
    
    I_CmsAppView.enter(java.lang.String)
  - enter
```
public void enter(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
```
    Specified by:
    
    enter in interface com.vaadin.navigator.View
    
    See Also:
    
    View.enter(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
  - getActions
```
public com.vaadin.event.Action[] getActions(java.lang.Object target,
                                            java.lang.Object sender)
```
    Specified by:
    
    getActions in interface com.vaadin.event.Action.Handler
    
    See Also:
    
    Action.Handler.getActions(java.lang.Object, java.lang.Object)
  - getCacheStatus
```
public CmsAppView.CacheStatus getCacheStatus()
```
    Gets the cache status of the view.
    
    Returns:
    
    the cache status of the view
  - getComponent
```
public CmsAppViewLayout getComponent()
```
    Description copied from interface: I_CmsAppView
    
    Returns the app component, initializes it if required.
    
    Specified by:
    
    getComponent in interface I_CmsAppView
    
    Returns:
    
    the component
    
    See Also:
    
    I_CmsAppView.getComponent()
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: I_CmsAppView
    
    Returns the view name.
    
    Specified by:
    
    getName in interface I_CmsAppView
    
    Returns:
    
    the view name
    
    See Also:
    
    I_CmsAppView.getName()
  - handleAction
```
public void handleAction(com.vaadin.event.Action action,
                         java.lang.Object sender,
                         java.lang.Object target)
```
    Specified by:
    
    handleAction in interface com.vaadin.event.Action.Handler
    
    See Also:
    
    Action.Handler.handleAction(com.vaadin.event.Action, java.lang.Object, java.lang.Object)
  - isCachable
```
public boolean isCachable()
```
    Description copied from interface: I_CmsAppView
    
    Returns whether this view should be cached within the user session.
    
    Specified by:
    
    isCachable in interface I_CmsAppView
    
    Returns:
    
    true if the view is cachable
    
    See Also:
    
    I_CmsAppView.isCachable()
  - onWindowClose
```
public void onWindowClose()
```
    Description copied from interface: I_CmsWindowCloseListener
    
    Executed on window close.
    
    Specified by:
    
    onWindowClose in interface I_CmsWindowCloseListener
    
    See Also:
    
    I_CmsWindowCloseListener.onWindowClose()
  - reinitComponent
```
public CmsAppViewLayout reinitComponent()
```
    Description copied from interface: I_CmsAppView
    
    Creates a new component instance.
    
    Specified by:
    
    reinitComponent in interface I_CmsAppView
    
    Returns:
    
    the new component
    
    See Also:
    
    I_CmsAppView.reinitComponent()
  - requiresRestore
```
public boolean requiresRestore()
```
    Description copied from interface: I_CmsAppView
    
    Returns whether this view needs to be restored from cache.
    
    Specified by:
    
    requiresRestore in interface I_CmsAppView
    
    Returns:
    
    true if this view needs to be restored from cache
    
    See Also:
    
    I_CmsAppView.requiresRestore()
  - restoreFromCache
```
public void restoreFromCache()
```
    Restores the view from cache.
    
    Specified by:
    
    restoreFromCache in interface I_CmsAppView
  - setCacheStatus
```
public void setCacheStatus(CmsAppView.CacheStatus status)
```
    Sets the cache status.
    
    Parameters:
    
    status - the new cache status
  - setRequiresRestore
```
public void setRequiresRestore(boolean restored)
```
    Description copied from interface: I_CmsAppView
    
    Sets the requires restore from cache flag.
    
    Specified by:
    
    setRequiresRestore in interface I_CmsAppView
    
    Parameters:
    
    restored - the requires restore from cache flag
    
    See Also:
    
    I_CmsAppView.setRequiresRestore(boolean)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class CmsAppView

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.navigator.ViewChangeListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.navigator.View

Constructor Detail

CmsAppView

Method Detail

afterViewChange

beforeViewChange

browserWindowResized

disableGlobalShortcuts

enableGlobalShortcuts

enter

enter

getActions

getCacheStatus

getComponent

getName

handleAction

isCachable

onWindowClose

reinitComponent

requiresRestore

restoreFromCache

setCacheStatus

setRequiresRestore

toString