Package org.opencms.ui
Interface I_CmsAppView
-
- All Superinterfaces:
java.io.Serializable
,com.vaadin.navigator.View
- All Known Implementing Classes:
CmsAppView
public interface I_CmsAppView extends com.vaadin.navigator.View
Factory to create components.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
disableGlobalShortcuts()
Disables the global keyboard shortcuts.void
enableGlobalShortcuts()
Enables the global keyboard shortcuts.void
enter(java.lang.String state)
Enters the view.com.vaadin.ui.Component
getComponent()
Returns the app component, initializes it if required.java.lang.String
getName()
Returns the view name.boolean
isCachable()
Returns whether this view should be cached within the user session.com.vaadin.ui.Component
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
setRequiresRestore(boolean restored)
Sets the requires restore from cache flag.
-
-
-
Method Detail
-
disableGlobalShortcuts
void disableGlobalShortcuts()
Disables the global keyboard shortcuts.
-
enableGlobalShortcuts
void enableGlobalShortcuts()
Enables the global keyboard shortcuts.
-
enter
void enter(java.lang.String state)
Enters the view.- Parameters:
state
- the state to set
-
getComponent
com.vaadin.ui.Component getComponent()
Returns the app component, initializes it if required.- Returns:
- the component
-
getName
java.lang.String getName()
Returns the view name.- Returns:
- the view name
-
isCachable
boolean isCachable()
Returns whether this view should be cached within the user session.- Returns:
true
if the view is cachable
-
reinitComponent
com.vaadin.ui.Component reinitComponent()
Creates a new component instance.- Returns:
- the new component
-
requiresRestore
boolean requiresRestore()
Returns whether this view needs to be restored from cache.- Returns:
true
if this view needs to be restored from cache
-
restoreFromCache
void restoreFromCache()
Restores the view from cache.
-
setRequiresRestore
void setRequiresRestore(boolean restored)
Sets the requires restore from cache flag.- Parameters:
restored
- the requires restore from cache flag
-
-