Package org.teamapps.ux.session
Interface SessionContext
-
- All Known Subinterfaces:
LockableSessionContext
- All Known Implementing Classes:
SimpleSessionContext
public interface SessionContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidaddClientToken(java.lang.String token)default voidaddRootComponent(java.lang.String containerElementId, RootPanel rootPanel)default voidclearClientTokens()default voidcloseWindow(java.lang.String windowId, int animationDuration)default voidcloseWindow(Window window, int animationDuration)java.lang.StringcreateFileLink(java.io.File file)default java.lang.StringcreateResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length)default java.lang.StringcreateResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName)default java.lang.StringcreateResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName, java.lang.String uniqueIdentifier)default java.lang.StringcreateResourceLink(Resource resource)java.lang.StringcreateResourceLink(Resource resource, java.lang.String uniqueIdentifier)voiddestroy()default voiddownloadFile(java.lang.String fileUrl, java.lang.String downloadFileName)default voidexitFullScreen()voidflushCommands()ResourcegetBinaryResource(int resourceId)ClientInfogetClientInfo()default ComponentgetComponent(java.lang.String componentId)SessionConfigurationgetConfiguration()org.teamapps.icons.api.IconThemegetIconTheme()default java.util.LocalegetLanguageLocale()longgetLastClientEventTimestamp()java.util.LocalegetLocale()java.lang.StringgetLocalized(java.lang.String key, java.lang.Object... parameters)java.util.ResourceBundlegetMessageBundle()SessionStoregetSessionStore()TemplategetTemplate(java.lang.String id)default java.time.ZoneIdgetTimeZone()java.io.FilegetUploadedFileByUuid(java.lang.String uuid)booleanisOpen()Event<java.lang.Void>onDestroyed()<T> voidqueueCommand(org.teamapps.dto.UiCommand<T> command)<T> voidqueueCommand(org.teamapps.dto.UiCommand<T> command, java.util.function.Consumer<T> resultCallback)default voidregisterBackgroundImage(java.lang.String id, java.lang.String image, java.lang.String blurredImage)default voidregisterComponent(Component component)TemplateReferenceregisterTemplate(java.lang.String id, Template template)voidregisterTemplates(java.util.Map<java.lang.String,Template> templates)default voidremoveClientToken(java.lang.String token)default java.lang.StringresolveIcon(org.teamapps.icons.api.Icon icon)voidrunWithContext(java.lang.Runnable runnable)Runs the specified runnable with this SessionContext set as CurrentSessionContext.default voidsetBackgroundColor(org.teamapps.common.format.Color color, int animationDuration)default voidsetBackgroundImage(java.lang.String id, int animationDuration)voidsetConfiguration(SessionConfiguration config)voidsetIconTheme(org.teamapps.icons.api.IconTheme theme)voidsetLastClientEventTimestamp(long timestamp)default voidshowNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption)default voidshowNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description, boolean dismissable, int displayTimeInMillis, boolean showProgress)default voidshowNotification(Notification notification)default voidshowWindow(Window window, int animationDuration)default voidunregisterComponent(Component component)
-
-
-
Method Detail
-
getClientInfo
ClientInfo getClientInfo()
-
getLastClientEventTimestamp
long getLastClientEventTimestamp()
-
setLastClientEventTimestamp
void setLastClientEventTimestamp(long timestamp)
-
isOpen
boolean isOpen()
-
destroy
void destroy()
-
onDestroyed
Event<java.lang.Void> onDestroyed()
-
queueCommand
<T> void queueCommand(org.teamapps.dto.UiCommand<T> command)
-
queueCommand
<T> void queueCommand(org.teamapps.dto.UiCommand<T> command, java.util.function.Consumer<T> resultCallback)
-
flushCommands
void flushCommands()
-
getIconTheme
org.teamapps.icons.api.IconTheme getIconTheme()
-
setIconTheme
void setIconTheme(org.teamapps.icons.api.IconTheme theme)
-
getLanguageLocale
default java.util.Locale getLanguageLocale()
-
getTimeZone
default java.time.ZoneId getTimeZone()
-
resolveIcon
default java.lang.String resolveIcon(org.teamapps.icons.api.Icon icon)
-
getLocale
java.util.Locale getLocale()
-
getMessageBundle
java.util.ResourceBundle getMessageBundle()
-
getLocalized
java.lang.String getLocalized(java.lang.String key, java.lang.Object... parameters)
-
getSessionStore
SessionStore getSessionStore()
-
registerComponent
default void registerComponent(Component component)
-
unregisterComponent
default void unregisterComponent(Component component)
-
getComponent
default Component getComponent(java.lang.String componentId)
-
createFileLink
java.lang.String createFileLink(java.io.File file)
-
createResourceLink
default java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length)
-
createResourceLink
default java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName)
-
createResourceLink
default java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName, java.lang.String uniqueIdentifier)
-
createResourceLink
default java.lang.String createResourceLink(Resource resource)
-
createResourceLink
java.lang.String createResourceLink(Resource resource, java.lang.String uniqueIdentifier)
-
getBinaryResource
Resource getBinaryResource(int resourceId)
-
getUploadedFileByUuid
java.io.File getUploadedFileByUuid(java.lang.String uuid)
-
registerTemplate
TemplateReference registerTemplate(java.lang.String id, Template template)
-
registerTemplates
void registerTemplates(java.util.Map<java.lang.String,Template> templates)
-
getTemplate
Template getTemplate(java.lang.String id)
-
runWithContext
void runWithContext(java.lang.Runnable runnable)
Runs the specified runnable with this SessionContext set as CurrentSessionContext. Flushes the queued commands after execution.- Parameters:
runnable- the code to be executed.
-
showWindow
default void showWindow(Window window, int animationDuration)
-
closeWindow
default void closeWindow(Window window, int animationDuration)
-
closeWindow
default void closeWindow(java.lang.String windowId, int animationDuration)
-
downloadFile
default void downloadFile(java.lang.String fileUrl, java.lang.String downloadFileName)
-
getConfiguration
SessionConfiguration getConfiguration()
-
setConfiguration
void setConfiguration(SessionConfiguration config)
-
registerBackgroundImage
default void registerBackgroundImage(java.lang.String id, java.lang.String image, java.lang.String blurredImage)
-
setBackgroundImage
default void setBackgroundImage(java.lang.String id, int animationDuration)
-
setBackgroundColor
default void setBackgroundColor(org.teamapps.common.format.Color color, int animationDuration)
-
exitFullScreen
default void exitFullScreen()
-
addRootComponent
default void addRootComponent(java.lang.String containerElementId, RootPanel rootPanel)
-
addClientToken
default void addClientToken(java.lang.String token)
-
removeClientToken
default void removeClientToken(java.lang.String token)
-
clearClientTokens
default void clearClientTokens()
-
showNotification
default void showNotification(Notification notification)
-
showNotification
default void showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption)
-
showNotification
default void showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description, boolean dismissable, int displayTimeInMillis, boolean showProgress)
-
-