Package org.teamapps.ux.session

Class SessionContext

java.lang.Object

org.teamapps.ux.session.SessionContext

public class SessionContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SessionContext(QualifiedUiSessionId sessionId, ClientInfo clientInfo, CommandDispatcher commandDispatcher, UxServerContext serverContext, org.teamapps.icons.api.IconTheme iconTheme, com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Summary

Modifier and Type	Method	Description
void	addClientToken(java.lang.String token)
void	addRootComponent(java.lang.String containerElementId, RootPanel rootPanel)
void	clearClientTokens()
void	closeWindow(java.lang.String windowId, int animationDuration)
void	closeWindow(Window window, int animationDuration)
java.lang.String	createFileLink(java.io.File file)
java.lang.String	createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length)
java.lang.String	createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName)
java.lang.String	createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName, java.lang.String uniqueIdentifier)
java.lang.String	createResourceLink(Resource resource)
java.lang.String	createResourceLink(Resource resource, java.lang.String uniqueIdentifier)
static SessionContext	current()
static SessionContext	currentOrNull()
void	destroy()
void	downloadFile(java.lang.String fileUrl, java.lang.String downloadFileName)
void	exitFullScreen()
void	flushCommands()
Resource	getBinaryResource(int resourceId)
ClientInfo	getClientInfo()
Component	getComponent(java.lang.String componentId)
SessionConfiguration	getConfiguration()
org.teamapps.icons.api.IconTheme	getIconTheme()
java.util.Locale	getLanguageLocale()
long	getLastClientEventTimestamp()
java.util.Locale	getLocale()
java.lang.String	getLocalized(java.lang.String key, java.lang.Object... parameters)
java.util.ResourceBundle	getMessageBundle()
Template	getTemplate(java.lang.String id)
java.time.ZoneId	getTimeZone()
java.io.File	getUploadedFileByUuid(java.lang.String uuid)
boolean	isOpen()
Event<java.lang.Void>	onDestroyed()
<RESULT> void	queueCommand(org.teamapps.dto.UiCommand<RESULT> command)
<RESULT> void	queueCommand(org.teamapps.dto.UiCommand<RESULT> command, java.util.function.Consumer<RESULT> resultCallback)
void	registerBackgroundImage(java.lang.String id, java.lang.String image, java.lang.String blurredImage)
void	registerComponent(Component component)
TemplateReference	registerTemplate(java.lang.String id, Template template)
void	registerTemplates(java.util.Map<java.lang.String,Template> templates)
void	removeClientToken(java.lang.String token)
java.lang.String	resolveIcon(org.teamapps.icons.api.Icon icon)
void	runWithContext(java.lang.Runnable runnable)	Does the following: Releases the current SessionContext (A) lock (if present) Acquires the lock for this SessionContext (B) Sets this SessionContext (B) as the current context (CurrentSessionContext). Executes the specified Runnable. Sets back the last SessionContext (A) as current context. Releases the lock for this SessionContext (B) Reacquires the lock for the last (A)
void	setBackgroundColor(org.teamapps.common.format.Color color, int animationDuration)
void	setBackgroundImage(java.lang.String id, int animationDuration)
void	setConfiguration(SessionConfiguration config)
void	setCustomMessageBundleProvider(java.util.function.Function<java.util.Locale,java.util.ResourceBundle> provider)
void	setIconTheme(org.teamapps.icons.api.IconTheme theme)
void	setLastClientEventTimestamp(long timestamp)
void	showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption)
void	showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description, boolean dismissable, int displayTimeInMillis, boolean showProgress)
void	showNotification(Notification notification, NotificationPosition position)
void	showNotification(Notification notification, NotificationPosition position, EntranceAnimation entranceAnimation, ExitAnimation exitAnimation)
void	showPopup(Popup popup)
void	showPopupAtCurrentMousePosition(Popup popup)
void	showWindow(Window window, int animationDuration)
void	unregisterComponent(Component component)

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionContext

public SessionContext(QualifiedUiSessionId sessionId,
                      ClientInfo clientInfo,
                      CommandDispatcher commandDispatcher,
                      UxServerContext serverContext,
                      org.teamapps.icons.api.IconTheme iconTheme,
                      com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Detail

current

public static SessionContext current()

currentOrNull

public static SessionContext currentOrNull()

setCustomMessageBundleProvider

public void setCustomMessageBundleProvider(java.util.function.Function<java.util.Locale,java.util.ResourceBundle> provider)

getLocale

public java.util.Locale getLocale()

getMessageBundle

public java.util.ResourceBundle getMessageBundle()

getLocalized

public java.lang.String getLocalized(java.lang.String key,
                                     java.lang.Object... parameters)

getLastClientEventTimestamp

public long getLastClientEventTimestamp()

setLastClientEventTimestamp

public void setLastClientEventTimestamp(long timestamp)

isOpen

public boolean isOpen()

destroy

public void destroy()

onDestroyed

public Event<java.lang.Void> onDestroyed()

queueCommand

public <RESULT> void queueCommand(org.teamapps.dto.UiCommand<RESULT> command,
                                  java.util.function.Consumer<RESULT> resultCallback)

queueCommand

public <RESULT> void queueCommand(org.teamapps.dto.UiCommand<RESULT> command)

getClientInfo

public ClientInfo getClientInfo()

flushCommands

public void flushCommands()

getIconTheme

public org.teamapps.icons.api.IconTheme getIconTheme()

setIconTheme

public void setIconTheme(org.teamapps.icons.api.IconTheme theme)

createFileLink

public java.lang.String createFileLink(java.io.File file)

createResourceLink

public java.lang.String createResourceLink(Resource resource,
                                           java.lang.String uniqueIdentifier)

getBinaryResource

public Resource getBinaryResource(int resourceId)

getUploadedFileByUuid

public java.io.File getUploadedFileByUuid(java.lang.String uuid)

registerTemplate

public TemplateReference registerTemplate(java.lang.String id,
                                          Template template)

registerTemplates

public void registerTemplates(java.util.Map<java.lang.String,Template> templates)

getTemplate

public Template getTemplate(java.lang.String id)

runWithContext

public void runWithContext(java.lang.Runnable runnable)

Does the following:

1. Releases the current SessionContext (A) lock (if present)
2. Acquires the lock for this SessionContext (B)
3. Sets this SessionContext (B) as the current context (CurrentSessionContext).
4. Executes the specified Runnable.
5. Sets back the last SessionContext (A) as current context.
6. Releases the lock for this SessionContext (B)
7. Reacquires the lock for the last (A)

Parameters:

runnable - the code to be executed.

getConfiguration

public SessionConfiguration getConfiguration()

setConfiguration

public void setConfiguration(SessionConfiguration config)

showPopupAtCurrentMousePosition

public void showPopupAtCurrentMousePosition(Popup popup)

showPopup

public void showPopup(Popup popup)

getLanguageLocale

public java.util.Locale getLanguageLocale()

getTimeZone

public java.time.ZoneId getTimeZone()

resolveIcon

public java.lang.String resolveIcon(org.teamapps.icons.api.Icon icon)

registerComponent

public void registerComponent(Component component)

unregisterComponent

public void unregisterComponent(Component component)

getComponent

public Component getComponent(java.lang.String componentId)

createResourceLink

public java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                                           long length)

createResourceLink

public java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                                           long length,
                                           java.lang.String resourceName)

createResourceLink

public java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                                           long length,
                                           java.lang.String resourceName,
                                           java.lang.String uniqueIdentifier)

createResourceLink

public java.lang.String createResourceLink(Resource resource)

showWindow

public void showWindow(Window window,
                       int animationDuration)

closeWindow

public void closeWindow(Window window,
                        int animationDuration)

closeWindow

public void closeWindow(java.lang.String windowId,
                        int animationDuration)

downloadFile

public void downloadFile(java.lang.String fileUrl,
                         java.lang.String downloadFileName)

registerBackgroundImage

public void registerBackgroundImage(java.lang.String id,
                                    java.lang.String image,
                                    java.lang.String blurredImage)

setBackgroundImage

public void setBackgroundImage(java.lang.String id,
                               int animationDuration)

setBackgroundColor

public void setBackgroundColor(org.teamapps.common.format.Color color,
                               int animationDuration)

exitFullScreen

public void exitFullScreen()

addRootComponent

public void addRootComponent(java.lang.String containerElementId,
                             RootPanel rootPanel)

addClientToken

public void addClientToken(java.lang.String token)

removeClientToken

public void removeClientToken(java.lang.String token)

clearClientTokens

public void clearClientTokens()

showNotification

public void showNotification(Notification notification,
                             NotificationPosition position,
                             EntranceAnimation entranceAnimation,
                             ExitAnimation exitAnimation)

showNotification

public void showNotification(Notification notification,
                             NotificationPosition position)

showNotification

public void showNotification(org.teamapps.icons.api.Icon icon,
                             java.lang.String caption)

showNotification

public void showNotification(org.teamapps.icons.api.Icon icon,
                             java.lang.String caption,
                             java.lang.String description,
                             boolean dismissable,
                             int displayTimeInMillis,
                             boolean showProgress)