Package org.teamapps.ux.session

Class SessionContext

java.lang.Object
org.teamapps.ux.session.SessionContext
public class SessionContext
extends java.lang.Object

  • Field Details

    • onActivityStateChanged

      public final Event<UiSessionActivityState> onActivityStateChanged

    • onDestroyed

      public final Event<java.lang.Void> onDestroyed

    • executionDecorators

      public final ExecutionDecoratorStack executionDecorators
      Decorators around all executions inside this SessionContext. These will be invoked when the Thread is already bound to the SessionContext, so SessionContext.current() will return this instance.

  • Constructor Details

  • Method Details

    • current

      public static SessionContext current()

    • currentOrNull

      public static SessionContext currentOrNull()

    • addTranslationProvider

      public void addTranslationProvider​(TranslationProvider translationProvider)

    • addIconBundle

      public void addIconBundle​(IconBundle iconBundle)

    • getIcon

      public org.teamapps.icons.Icon<?,​?> getIcon​(java.lang.String key)

    • getULocale

      public com.ibm.icu.util.ULocale getULocale()

    • getLocale

      public java.util.Locale getLocale()

    • setLocale

      public void setLocale​(java.util.Locale locale)

    • setULocale

      public void setULocale​(com.ibm.icu.util.ULocale locale)

    • getLocalized

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

    • isActive

      public boolean isActive()

    • handleActivityStateChangedInternal

      public void handleActivityStateChangedInternal​(boolean active)

    • isDestroyed

      public boolean isDestroyed()

    • destroy

      public void destroy()

    • handleSessionDestroyedInternal

      public void handleSessionDestroyedInternal()

    • 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()

    • getHttpSession

      public javax.servlet.http.HttpSession getHttpSession()

    • flushCommands

      @Deprecated public void flushCommands()
      Deprecated.
      no more needed. commands are sent as early as the client can handle them.

    • getClientBackPressureInfo

      public ClientBackPressureInfo getClientBackPressureInfo()

    • 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 java.util.concurrent.CompletableFuture<java.lang.Void> runWithContext​(java.lang.Runnable runnable)

    • runWithContext

      public java.util.concurrent.CompletableFuture<java.lang.Void> runWithContext​(java.lang.Runnable runnable, boolean forceEnqueue)
      Parameters:
      runnable -
      forceEnqueue - No synchronous execution! Enqueue this at the end of this SessionContext's work queue.
      Returns:

    • addExecutionDecorator

      public void addExecutionDecorator​(ExecutionDecorator decorator, boolean outer)
      Adds a decorator that gets invoked whenever a Thread is bound to this SessionContext. The decorator will be called right after the Thread is bound to this SessionContext, so SessionContext.current() will return this instance.
      Parameters:
      decorator -
      outer - Whether to add this decorator as outermost or innermost execution wrapper.

    • getConfiguration

      public SessionConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration​(SessionConfiguration config)

    • showPopupAtCurrentMousePosition

      public void showPopupAtCurrentMousePosition​(Popup popup)

    • showPopup

      public void showPopup​(Popup popup)

    • getTimeZone

      public java.time.ZoneId getTimeZone()

    • getIconProvider

      public org.teamapps.icons.SessionIconProvider getIconProvider()

    • setDefaultStyleForIconClass

      public <I extends org.teamapps.icons.Icon<I,​ S>,​ S> void setDefaultStyleForIconClass​(java.lang.Class<I> iconClass, S defaultStyle)

    • resolveIcon

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

    • registerClientObject

      public void registerClientObject​(ClientObject clientObject)

    • unregisterClientObject

      public void unregisterClientObject​(ClientObject clientObject)

    • getClientObject

      public ClientObject getClientObject​(java.lang.String clientObjectId)

    • createResourceLink

      public java.lang.String createResourceLink​(Resource resource)

    • showWindow

      public void showWindow​(Window window, int animationDuration)

    • downloadFile

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

    • downloadFile

      public void downloadFile​(java.io.File file, 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)

    • showDefaultBackground

      public void showDefaultBackground​(int animationDuration)

    • setBackgroundColor

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

    • exitFullScreen

      public void exitFullScreen()

    • addRootComponent

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

    • addRootPanel

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

    • addRootPanel

      public RootPanel addRootPanel​(java.lang.String containerElementId)

    • addRootPanel

      public RootPanel addRootPanel()

    • 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.Icon icon, java.lang.String caption)

    • showNotification

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

    • showNotification

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

    • setSessionExpiredWindow

      public void setSessionExpiredWindow​(Window sessionExpiredWindow)

    • setSessionErrorWindow

      public void setSessionErrorWindow​(Window sessionErrorWindow)

    • setSessionTerminatedWindow

      public void setSessionTerminatedWindow​(Window sessionTerminatedWindow)

    • createDefaultSessionMessageWindow

      public static Window createDefaultSessionMessageWindow​(java.lang.String title, java.lang.String message, java.lang.String refreshButtonCaption, java.lang.String cancelButtonCaption)

    • requestWakeLock

      public java.util.concurrent.CompletableFuture<WakeLock> requestWakeLock()

    • goToUrl

      public void goToUrl​(java.lang.String url, boolean blankPage)