Package io.guise.framework

Class AbstractGuiseSession

java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.AbstractGuiseSession
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, com.globalmentor.text.CollatorFactory, io.clogr.Clogged, io.csar.Concerned, GuiseSession
Direct Known Subclasses:
DefaultGuiseSession
public abstract class AbstractGuiseSession extends com.globalmentor.beans.BoundPropertyObject implements GuiseSession, io.clogr.Clogged
An abstract implementation that keeps track of the components of a user session.
Author:
Garret Wilson

  • Constructor Details

    • AbstractGuiseSession

      public AbstractGuiseSession(GuiseApplication application, Platform platform)
      Application and platform constructor. The session local will initially be set to the locale of the associated Guise application. No operation must be performed inside the constructor that would require the presence of the Guise session within this thread group.
      Parameters:
      application - The Guise application to which this session belongs.
      platform - The platform on which this session's objects are depicted.
      Throws:
      NullPointerException - if the given application and/or platform is null.

  • Method Details

    • setConfigurations

      protected void setConfigurations(io.csar.Concern... configurations)
      Sets the given configurations, associating them with their respective classes.
      Parameters:
      configurations - The configurations to set.

    • setConfiguration

      protected <C extends io.csar.Concern> Optional<C> setConfiguration(C configuration)
      Sets the given configuration, associating it with its class.
      Type Parameters:
      C - The type of configuration being set.
      Parameters:
      configuration - The configuration to set.
      Returns:
      The configuration previously associated with the same class, if any.
      Throws:
      NullPointerException - if the given configuration is null.

    • setConfiguration

      protected <C extends io.csar.Concern> Optional<C> setConfiguration(Class<C> configurationClass, C configuration)
      Sets the given configuration.
      Type Parameters:
      C - The type of configuration being set.
      Parameters:
      configurationClass - The class with which to associate the configuration.
      configuration - The configuration to set.
      Returns:
      The configuration previously associated with the given class, if any.

    • findConcern

      public <C extends io.csar.Concern> Optional<C> findConcern(Class<C> configurationClass)
      Specified by:
      findConcern in interface io.csar.Concerned

    • removeConfiguration

      protected <C extends io.csar.Concern> Optional<C> removeConfiguration(Class<C> configurationClass)
      Removes a configuration of the given type. If no configuration is associated with the specified type, no action occurs.
      Type Parameters:
      C - The type of configuration being removed.
      Parameters:
      configurationClass - The class with which the configuration is associated.
      Returns:
      The configuration previously associated with the given class, if any.

    • getUUID

      public UUID getUUID()
      Specified by:
      getUUID in interface GuiseSession
      Returns:
      The unique identifier of this session.

    • getApplication

      public GuiseApplication getApplication()
      Specified by:
      getApplication in interface GuiseSession
      Returns:
      The Guise application to which this session belongs.

    • getLogWriter

      public Writer getLogWriter()
      Specified by:
      getLogWriter in interface GuiseSession
      Returns:
      The writer for writing to the log file, which may not be thread-safe.

    • setLogWriter

      public void setLogWriter(Writer logWriter)
      Description copied from interface: GuiseSession
      Sets the log writer.
      Specified by:
      setLogWriter in interface GuiseSession
      Parameters:
      logWriter - The writer for writing to the log file, which may not be thread-safe.

    • getDepictionRootURI

      public URI getDepictionRootURI()
      Description copied from interface: GuiseSession
      Reports the current depiction root URI of the session. The depiction root URI is an absolute plain root URI. The session depiction root URI may be different for different sessions, and may not be equal to the application navigation base path resolved to the container's base URI.
      Specified by:
      getDepictionRootURI in interface GuiseSession
      Returns:
      The depiction root URI currently representing the Guise session.

    • setDepictionRootURI

      public void setDepictionRootURI(URI depictionBaseURI)
      Description copied from interface: GuiseSession
      Sets the depiction root URI of the session. The depiction root URI is an absolute plain root URI.
      Specified by:
      setDepictionRootURI in interface GuiseSession
      Parameters:
      depictionBaseURI - The new depiction root URI of the session.

    • getDepictionURI

      public final URI getDepictionURI(com.globalmentor.net.URIPath navigationPath, String... suffixes)
      Determines the URI to use for depiction based upon a navigation path. The path will first be dereferenced for the current session and then resolved to the application base path. The resulting URI may not be absolute, but can be made absolute by resolving it against the depiction root URI.

      This implementation delegates to getDepictionURI(URI, String...).

      Specified by:
      getDepictionURI in interface GuiseSession
      Parameters:
      navigationPath - The navigation path, which may be absolute or relative to the application.
      suffixes - The suffixes, if any, to append to a resource key in a URI reference.
      Returns:
      A URI suitable for depiction, deferenced and resolved to the application base path.
      See Also:

    • getDepictionURI

      public URI getDepictionURI(URI navigationURI, String... suffixes)
      Description copied from interface: GuiseSession
      Determines the URI to use for depiction based upon a navigation URI. The URI will first be dereferenced for the current session and then resolved to the application base path. The resulting URI may not be absolute, but can be made absolute by resolving it against the depiction root URI.
      Specified by:
      getDepictionURI in interface GuiseSession
      Parameters:
      navigationURI - The navigation URI, which may be absolute or have an absolute path or a path relative to the application.
      suffixes - The suffixes, if any, to append to a resource key in a URI reference.
      Returns:
      A URI suitable for depiction, dereferenced and resolved to the application base path.
      See Also:

    • getApplicationFrame

      public ApplicationFrame getApplicationFrame()
      Specified by:
      getApplicationFrame in interface GuiseSession
      Returns:
      The application frame.

    • getPlatform

      public Platform getPlatform()
      Specified by:
      getPlatform in interface GuiseSession
      Returns:
      The platform on which Guise objects are depicted.

    • getInputStrategy

      public InputStrategy getInputStrategy()
      Specified by:
      getInputStrategy in interface GuiseSession
      Returns:
      The strategy for processing input.

    • setInputStrategy

      public void setInputStrategy(InputStrategy newInputStrategy)
      Description copied from interface: GuiseSession
      Sets the strategy for processing input. A default input strategy is installed that, if replaced, should be set as the parent of the new input strategy. To handle new types of input, a new input strategy should create the appropriate InputEvent and dispatch it via the application frame; if the event is not consumed, it should be passed to the parent input strategy. This is a bound property.
      Specified by:
      setInputStrategy in interface GuiseSession
      Parameters:
      newInputStrategy - The new strategy for processing input.
      See Also:

    • getTimeZone

      public TimeZone getTimeZone()
      Specified by:
      getTimeZone in interface GuiseSession
      Returns:
      The current session time zone.

    • setTimeZone

      public void setTimeZone(TimeZone newTimeZone)
      Description copied from interface: GuiseSession
      Sets the current session time zone. This is a bound property.
      Specified by:
      setTimeZone in interface GuiseSession
      Parameters:
      newTimeZone - The new session time zone.
      See Also:

    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface GuiseSession
      Returns:
      The current session locale.

    • setLocale

      public void setLocale(Locale newLocale)
      Description copied from interface: GuiseSession
      Sets the current session locale. The default orientation will be updated if needed to reflect the new locale. This is a bound property.
      Specified by:
      setLocale in interface GuiseSession
      Parameters:
      newLocale - The new session locale.
      See Also:

    • requestLocale

      public Locale requestLocale(List<Locale> requestedLocales)
      Description copied from interface: GuiseSession
      Requests that the locale be changed to one of the given locales. Each of the locales in the list are examined in order, and the first one supported by the application is used. A requested locale is accepted if a more general locale is supported. (i.e. en-US is accepted if en is supported.)
      Specified by:
      requestLocale in interface GuiseSession
      Parameters:
      requestedLocales - The locales requested, in order of preference.
      Returns:
      The accepted locale (which may be a variation of this locale), or null if none of the given locales are supported by the application.
      See Also:

    • getOrientation

      public Orientation getOrientation()
      Specified by:
      getOrientation in interface GuiseSession
      Returns:
      The default internationalization orientation of components for this session.

    • setOrientation

      public void setOrientation(Orientation newOrientation)
      Description copied from interface: GuiseSession
      Sets the default orientation. This is a bound property
      Specified by:
      setOrientation in interface GuiseSession
      Parameters:
      newOrientation - The new default internationalization orientation of components for this session.
      See Also:

    • getResourceBundle

      public ResourceBundle getResourceBundle() throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a resource bundle to be used by this session. One of the getXXXResource() should be used in preference to using this method directly. If this session does not yet have a resource bundle, one will be created based upon the current theme and locale. The returned resource bundle should only be used temporarily and should not be saved, as the resource bundle may change if the session locale or the application resource bundle base name changes. The resource bundle retrieved will allow hierarchical resolution in the following priority:
      1. Any resource defined by the application.
      2. Any resource defined by the theme.
      3. Any resource defined by default by Guise.
      Specified by:
      getResourceBundle in interface GuiseSession
      Returns:
      The resource bundle containing the resources for this session, based upon the locale.
      Throws:
      MissingResourceException - if no resource bundle for the application's specified base name can be found or there was an error loading a resource bundle.
      See Also:

    • releaseResourceBundle

      protected void releaseResourceBundle()
      Unloads the current resource bundle so that the next call to getResourceBundle() will load the resource bundle anew. This method also releases the current collator.

    • getResource

      public <T> T getResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves an object resource from the resource bundle. Every resource access method should eventually call this method. This is a preferred convenience method for accessing the resources in the session's resource bundle. This method involves an implicit cast that will throw a class cast exception after the method ends if the resource is not of the expected type.
      Specified by:
      getResource in interface GuiseSession
      Type Parameters:
      T - The type of the resource.
      Parameters:
      resourceKey - The key of the resource to retrieve.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getResource

      public <T> T getResource(String resourceKey, T defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves an object resource from the resource bundle, using a specified default if no such resource is available. This is a preferred convenience method for accessing the resources in the session's resource bundle. This method involves an implicit cast that will throw a class cast exception after the method ends if the resource is not of the expected type.
      Specified by:
      getResource in interface GuiseSession
      Type Parameters:
      T - The type of the resource.
      Parameters:
      resourceKey - The key of the resource to retrieve.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getStringResource

      public String getStringResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a string resource from the resource bundle. If the resource cannot be found in the resource bundle, it will be loaded from the application's resources, if possible, treating the resource key as a locale-sensitive resource path in the application resource area. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getStringResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve, or a relative path to the resource in the application's resource area.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getStringResource

      public String getStringResource(String resourceKey, String defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a string resource from the resource bundle, using a specified default if no such resource is available. If the resource cannot be found in the resource bundle, it will be loaded from the application's resources, if possible, treating the resource key as a locale-sensitive resource path in the application resource area. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getStringResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve, or a relative path to the resource in the application's resource area.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getBooleanResource

      public Boolean getBooleanResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a Boolean resource from the resource bundle. If the given resource is a string, it will be interpreted according to the Boolean.valueOf(java.lang.String) rules. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getBooleanResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getBooleanResource

      public Boolean getBooleanResource(String resourceKey, Boolean defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a Boolean resource from the resource bundle, using a specified default if no such resource is available. If the given resource is a string, it will be interpreted according to the Boolean.valueOf(java.lang.String) rules. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getBooleanResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getColorResource

      public Color getColorResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a Color resource from the resource bundle. If the given resource is a string, it will be resolved and converted to a color using AbstractModeledColor.valueOf(CharSequence). This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getColorResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getColorResource

      public Color getColorResource(String resourceKey, Color defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a Color resource from the resource bundle, using a specified default if no such resource is available. If the given resource is a string, it will be resolved and converted to a color using AbstractModeledColor.valueOf(CharSequence). This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getColorResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getIntegerResource

      public Integer getIntegerResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves an Integer resource from the resource bundle. If the given resource is a string, it will be interpreted according to the Integer.valueOf(java.lang.String) rules. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getIntegerResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getIntegerResource

      public Integer getIntegerResource(String resourceKey, Integer defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves an Integer resource from the resource bundle, using a specified default if no such resource is available. If the given resource is a string, it will be interpreted according to the Integer.valueOf(java.lang.String) rules. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getIntegerResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getURIResource

      public URI getURIResource(String resourceKey) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a URI resource from the resource bundle. If the given resource is a string, it will be converted to a URI. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getURIResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      Returns:
      The resource associated with the specified resource key.
      Throws:
      MissingResourceException - if no resource could be found associated with the given key.
      See Also:

    • getURIResource

      public URI getURIResource(String resourceKey, URI defaultValue) throws MissingResourceException
      Description copied from interface: GuiseSession
      Retrieves a URI resource from the resource bundle, using a specified default if no such resource is available. If the given resource is a string, it will be converted to a URI. This is a preferred convenience method for accessing the resources in the session's resource bundle.
      Specified by:
      getURIResource in interface GuiseSession
      Parameters:
      resourceKey - The key of the resource to retrieve.
      defaultValue - The default value to use if there is no resource associated with the given key.
      Returns:
      The resource associated with the specified resource key or the default if none is available.
      Throws:
      MissingResourceException
      See Also:

    • getCollatorInstance

      public Collator getCollatorInstance()
      Specified by:
      getCollatorInstance in interface com.globalmentor.text.CollatorFactory
      Specified by:
      getCollatorInstance in interface GuiseSession

    • getPrincipal

      public Principal getPrincipal()
      Specified by:
      getPrincipal in interface GuiseSession
      Returns:
      The current principal (e.g. logged-in user), or null if there is no principal authenticated for this session.

    • setPrincipal

      public void setPrincipal(Principal newPrincipal)
      Description copied from interface: GuiseSession
      Sets the current principal (e.g. logged-in user). This is a bound property.
      Specified by:
      setPrincipal in interface GuiseSession
      Parameters:
      newPrincipal - The new principal, or null if there should be no associated principal (e.g. the user should be logged off).
      See Also:

    • getTheme

      public Theme getTheme() throws IOException
      Description copied from interface: GuiseSession
      Returns the current session theme. If this session's theme has not yet been loaded, this method loads the theme.
      Specified by:
      getTheme in interface GuiseSession
      Returns:
      The current session theme.
      Throws:
      IOException - if there is an error loading the theme.
      See Also:

    • getThemeURI

      public URI getThemeURI()
      Specified by:
      getThemeURI in interface GuiseSession
      Returns:
      The URI of the session theme, to be resolved against the application base path.

    • setThemeURI

      public void setThemeURI(URI newThemeURI)
      Description copied from interface: GuiseSession
      Sets the URI of the session theme. The current theme, if any, will be released and loaded the next time GuiseSession.getTheme() is called. This is a bound property.
      Specified by:
      setThemeURI in interface GuiseSession
      Parameters:
      newThemeURI - The URI of the new session theme.
      See Also:

    • getAboutApplicationActionPrototype

      public ActionPrototype getAboutApplicationActionPrototype()
      Specified by:
      getAboutApplicationActionPrototype in interface GuiseSession
      Returns:
      The action prototype for presenting application information.

    • getDestinationComponent

      public Component getDestinationComponent(ComponentDestination destination)
      Description copied from interface: GuiseSession
      Retrieves the component bound to the given destination. If a component has already been created and cached, it will be be returned; otherwise, one will be created and cached.
      Specified by:
      getDestinationComponent in interface GuiseSession
      Parameters:
      destination - The destination for which a component should be returned.
      Returns:
      The component bound to the given destination.

    • releaseDestinationComponent

      public Component releaseDestinationComponent(ComponentDestination destination)
      Description copied from interface: GuiseSession
      Releases the component bound to the given destination.
      Specified by:
      releaseDestinationComponent in interface GuiseSession
      Parameters:
      destination - The destination for which any bound component should be released.
      Returns:
      The component previously bound to the given destination, or null if no component was bound to the given destination.

    • getNavigationComponent

      public Component getNavigationComponent(com.globalmentor.net.URIPath path)
      Description copied from interface: GuiseSession
      Retrieves the component bound to the given application context-relative path. This is a convenience method that retrieves the component associated with the component destination for the given navigation path. This method calls GuiseApplication.getDestination(URIPath). This method calls GuiseSession.getDestinationComponent(ComponentDestination).
      Specified by:
      getNavigationComponent in interface GuiseSession
      Parameters:
      path - The application context-relative path within the Guise container context.
      Returns:
      The component bound to the given path.
      See Also:

    • getNavigationDescription

      public Optional<io.urf.model.UrfResourceDescription> getNavigationDescription(com.globalmentor.net.URIPath navigationPath, Bookmark bookmark) throws IOException
      Description copied from interface: GuiseSession
      Returns a description of the resource for the given navigation path and bookmark. This is a convenience method that delegates to the appropriate destination.
      Specified by:
      getNavigationDescription in interface GuiseSession
      Parameters:
      navigationPath - The navigation path relative to the application context path.
      bookmark - The bookmark for which navigation should occur at this navigation path, or null if there is no bookmark involved in navigation.
      Returns:
      A description of the indicated navigation path, which will not be present if nothing exists at the given navigation path.
      Throws:
      IOException - if there is an error accessing the navigation path.
      See Also:

    • getNavigationDescription

      public Optional<io.urf.model.UrfResourceDescription> getNavigationDescription() throws IOException
      Description copied from interface: GuiseSession
      Returns a description of the resource for the current navigation path and bookmark. This is a convenience method that delegates to the appropriate destination for the current navigation path.
      Specified by:
      getNavigationDescription in interface GuiseSession
      Returns:
      A description of the current navigation path, which will not be present if nothing exists at the current navigation path.
      Throws:
      IOException - if there is an error accessing the navigation path.
      See Also:

    • createComponent

      protected Component createComponent(Class<? extends Component> componentClass)
      Creates the component for the given class.
      Parameters:
      componentClass - The class representing the component to create.
      Returns:
      The created component.
      Throws:
      IllegalStateException - if the component class does not provide a default constructor, is an interface, is abstract, or throws an exception during instantiation.

    • initializeComponent

      public void initializeComponent(Component component)
      Description copied from interface: GuiseSession
      Initializes a component, optionally with a description in a TURF resource file. This method first tries to load a PLOOP URF description of the component in a TURF file with the same name as the class file in the same directory, with an .turf extension. That is, for the class MyComponent.class this method first tries to load MyComponent.turf from the same directory. If this is successful, the component is initialized from this URF description. This implementation calls GuiseSession.initializeComponent(Component, InputStream). The component's Component.initialize() is called whether there is an URF description.
      Specified by:
      initializeComponent in interface GuiseSession
      Parameters:
      component - The component to initialize.
      See Also:

    • initializeComponentFromResource

      public void initializeComponentFromResource(Component component, String resourceKey) throws com.globalmentor.util.DataException, InvocationTargetException
      Initializes a component with a description in a TURF resource file. This method calls Component.initialize() after initializing the component from the description. This implementation calls GuiseSession.initializeComponent(Component, InputStream).

      This implementation calls initializeComponent(Component, InputStream).

      Specified by:
      initializeComponentFromResource in interface GuiseSession
      Parameters:
      component - The component to initialize.
      resourceKey - The key to a TURF description resource file.
      Throws:
      com.globalmentor.util.DataException - if the data was incorrect for component initialization.
      InvocationTargetException - if a given resource indicates a Java class the constructor of which throws an exception.
      See Also:

    • initializeComponent

      public void initializeComponent(Component component, InputStream descriptionInputStream) throws IOException, com.globalmentor.util.DataException, InvocationTargetException
      Description copied from interface: GuiseSession
      Initializes a component from the contents of an URF description input stream. This method calls Component.initialize() after initializing the component from the description.
      Specified by:
      initializeComponent in interface GuiseSession
      Parameters:
      component - The component to initialize.
      descriptionInputStream - The input stream containing an URF description.
      Throws:
      IOException - if there is an error reading from the input stream.
      com.globalmentor.util.DataException - if the data was incorrect for component initialization.
      InvocationTargetException - if a given resource indicates a Java class the constructor of which throws an exception.
      See Also:

    • pushModalNavigation

      protected void pushModalNavigation(ModalNavigation modalNavigation)
      Pushes the given model navigation onto the top of the stack.
      Parameters:
      modalNavigation - The modal navigation to add.
      Throws:
      NullPointerException - if the given modal navigation is null.

    • peekModalNavigation

      protected ModalNavigation peekModalNavigation()
      Returns:
      The modal navigation on the top of the stack, or null if there are no modal navigations.

    • pollModalNavigation

      protected ModalNavigation pollModalNavigation()
      Returns:
      The modal navigation from the top of the stack, or null if there are no modal navigations on the stack.

    • popModalNavigation

      protected ModalNavigation popModalNavigation()
      Returns:
      The modal navigation from the top of the stack.
      Throws:
      NoSuchElementException - if there are no modal navigations on the stack.

    • isModalNavigation

      public boolean isModalNavigation()
      Specified by:
      isModalNavigation in interface GuiseSession
      Returns:
      Whether the session is in a modal navigation state.

    • getModalNavigation

      public ModalNavigation getModalNavigation()
      Specified by:
      getModalNavigation in interface GuiseSession
      Returns:
      The current modal navigation state, or null if there are no modal navigations.

    • beginModalNavigation

      public void beginModalNavigation(ModalNavigationPanel<?> modalNavigationPanel, ModalNavigation modalNavigation)
      Description copied from interface: GuiseSession
      Begins modal interaction for a particular modal panel. The modal navigation is pushed onto the stack, and an event is fired to the modal listener of the modal navigation.
      Specified by:
      beginModalNavigation in interface GuiseSession
      Parameters:
      modalNavigationPanel - The panel for which modal navigation state should begin.
      modalNavigation - The state of modal navigation.

    • endModalNavigation

      public boolean endModalNavigation(ModalNavigationPanel<?> modalNavigationPanel)
      Description copied from interface: GuiseSession
      Ends modal interaction for a particular modal panel. The panel is released from the cache so that new navigation will create a new modal panel. This method is called by modal panels and should seldom if ever be called directly. If the current modal state corresponds to the current navigation state, the current modal state is removed, the modal state's event is fired, and modal state is handed to the previous modal state, if any. Otherwise, navigation is transferred to the modal panel's referring URI, if any. If the given modal panel is not the panel at the current navigation path, the modal state is not changed, although navigation and release will still occur.
      Specified by:
      endModalNavigation in interface GuiseSession
      Parameters:
      modalNavigationPanel - The panel for which modal navigation state should be ended.
      Returns:
      true if modality actually ended for the given panel.
      See Also:

    • getNavigationPath

      public com.globalmentor.net.URIPath getNavigationPath()
      Description copied from interface: GuiseSession
      Reports the navigation path relative to the application context path.
      Specified by:
      getNavigationPath in interface GuiseSession
      Returns:
      The path representing the current navigation location of the Guise application.

    • setNavigationPath

      public void setNavigationPath(com.globalmentor.net.URIPath navigationPath)
      Description copied from interface: GuiseSession
      Changes the navigation path of the session. This method does not actually cause navigation to occur. If the given navigation path is the same as the current navigation path, no action occurs.
      Specified by:
      setNavigationPath in interface GuiseSession
      Parameters:
      navigationPath - The navigation path relative to the application context path.
      See Also:

    • getBookmark

      public Bookmark getBookmark()
      Description copied from interface: GuiseSession
      Reports the current bookmark relative to the current navigation path.
      Specified by:
      getBookmark in interface GuiseSession
      Returns:
      The bookmark relative to the current navigation path, or null if there is no bookmark specified.

    • setBookmark

      public void setBookmark(Bookmark bookmark)
      Description copied from interface: GuiseSession
      Changes the bookmark of the current navigation path. This method does not necessarily cause navigation to occur, but instead "publishes" the bookmark to indicate that it is representative of the current state of the current navigation.
      Specified by:
      setBookmark in interface GuiseSession
      Parameters:
      bookmark - The bookmark relative to the current navigation path, or null if there should be no bookmark.

    • setNavigation

      public void setNavigation(com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI)
      Sets the new navigation path and bookmark, firing a navigation event if appropriate. If the navigation path and/or bookmark has changed, this method fires an event to all NavigationListeners in the component hierarchy, with the session as the source of the NavigationEvent. This method calls GuiseSession.setNavigationPath(URIPath) and GuiseSession.setBookmark(Bookmark).

      This implementation logs the navigation change.

      Specified by:
      setNavigation in interface GuiseSession
      Parameters:
      navigationPath - The navigation path relative to the application context path.
      bookmark - The bookmark for which navigation should occur at this navigation path, or null if there is no bookmark involved in navigation.
      referrerURI - The URI of the referring navigation panel or other entity with no query or fragment, or null if no referring URI is known.
      See Also:

    • fireNavigated

      public void fireNavigated(URI referrerURI)
      Description copied from interface: GuiseSession
      Fires a NavigationEvent to all NavigationListeners in the session application frame hierarchy.
      Specified by:
      fireNavigated in interface GuiseSession
      Parameters:
      referrerURI - The URI of the referring navigation panel or other entity with no query or fragment, or null if no referring URI is known.
      See Also:

    • fireNavigated

      protected void fireNavigated(Component component, NavigationEvent navigationEvent)
      Fires a NavigationEvent to all NavigationListeners in the given component hierarchy.
      Parameters:
      component - The component to which the navigation event should be fired, along with all children, if the component or any children implement NavigationListener.
      navigationEvent - The navigation event to fire.
      See Also:

    • getRequestedNavigation

      public Navigation getRequestedNavigation()
      Specified by:
      getRequestedNavigation in interface GuiseSession
      Returns:
      The requested navigation, or null if no navigation has been requested.

    • clearRequestedNavigation

      public void clearRequestedNavigation()
      Description copied from interface: GuiseSession
      Removes any requests for navigation.
      Specified by:
      clearRequestedNavigation in interface GuiseSession

    • getSiteName

      public String getSiteName()
      Determines the name of the site at the current navigation path.

      This version returns null.

      Specified by:
      getSiteName in interface GuiseSession
      Returns:
      The name of the site, or null if the site has no name.

    • getBreadcrumb

      public Breadcrumb getBreadcrumb(com.globalmentor.net.URIPath navigationPath)
      Retrieves a breadcrumb for a particular navigation path.

      This implementation uses the name of the resulting depiction URI for the breadcrumb label.

      This implementation returns a default breadcrumb; subclasses may override this method and provide customized breadcrumb information.

      Specified by:
      getBreadcrumb in interface GuiseSession
      Parameters:
      navigationPath - The navigation path which a breadcrumb should be returned.
      Returns:
      A breadcrumb for the given navigation URI.
      See Also:

    • getBreadcrumbs

      public List<Breadcrumb> getBreadcrumbs(com.globalmentor.net.URIPath navigationPath)
      Retrieves breadcrumbs for all the segments of a particular navigation path. This method delegates to GuiseSession.getBreadcrumb(URIPath) to create each segment breadcrumb.

      This method delegates to getBreadcrumb(URIPath) to create each segment breadcrumb.

      Specified by:
      getBreadcrumbs in interface GuiseSession
      Parameters:
      navigationPath - The navigation path which breadcrumbs should be returned.
      Returns:
      A list of breadcrumbs for the given navigation URI.

    • initialize

      public void initialize()
      Description copied from interface: GuiseSession
      Called when the session is initialized.
      Specified by:
      initialize in interface GuiseSession
      See Also:

    • destroy

      public void destroy()
      Description copied from interface: GuiseSession
      Called when the session is destroyed.
      Specified by:
      destroy in interface GuiseSession
      See Also:

    • createTempPublicResource

      public com.globalmentor.net.URIPath createTempPublicResource(String baseName, String extension) throws IOException
      Description copied from interface: GuiseSession
      Creates a temporary resource available at a public application navigation path but with access restricted to this session. The file will be created in the application's temporary file directory. If the resource is restricted to the current Guise session, the resource will be deleted when the current Guise session ends. This is a convenience method that delegates to GuiseApplication.createTempAsset(String, String, GuiseSession).
      Specified by:
      createTempPublicResource in interface GuiseSession
      Parameters:
      baseName - The base filename to be used in generating the filename.
      extension - The extension to use for the temporary file.
      Returns:
      A public application navigation path that can be used to access the resource only from this session.
      Throws:
      IOException - if there is a problem creating the public resource.
      See Also:

    • createBusyComponent

      public Component createBusyComponent()
      Description copied from interface: GuiseSession
      Creates a component to indicate Guise busy status.
      Specified by:
      createBusyComponent in interface GuiseSession
      Returns:
      A component to indicate Guise busy status.
      See Also:

    • input

      public boolean input(Input input)
      Description copied from interface: GuiseSession
      Processes input such as a keystroke, a mouse click, or a command. A new InputEvent will be created and dispatched via the application frame. If an input event is still not consumed after dispatching, its input is processed by the installed input strategy, if any.
      Specified by:
      input in interface GuiseSession
      Parameters:
      input - The input to process.
      Returns:
      true if the input was consumed and should not be processed further.
      See Also:

    • createInputEvent

      protected InputEvent createInputEvent(Input input)
      Creates an input event for the given input.
      Parameters:
      input - The input to process.
      Returns:
      An event to represent the given input.
      Throws:
      NullPointerException - if the given input is null.
      IllegalArgumentException - if an unknown input type was given.
      See Also:

    • log

      public void log(String subject, String predicate, String object, Map<?,?> parameters, CharSequence comment)
      Description copied from interface: GuiseSession
      Logs the given session-related information with a default log level of InformationLevel.LOG. This is a convenience method that delegates to GuiseSession.log(InformationLevel, String, String, String, Map, CharSequence).
      Specified by:
      log in interface GuiseSession
      Parameters:
      subject - The log subject identification, or null if there is no related subject.
      predicate - The log predicate identification, or null if there is no related predicate.
      object - The log object identification, or null if there is no related object.
      parameters - The map of log parameters, or null if there are no parameters.
      comment - The log comment, or null if there is no log comment.

    • log

      public void log(InformationLevel level, String subject, String predicate, String object, Map<?,?> parameters, CharSequence comment)
      Description copied from interface: GuiseSession
      Logs the given session-related information.
      Specified by:
      log in interface GuiseSession
      Parameters:
      level - The log information level.
      subject - The log subject identification, or null if there is no related subject.
      predicate - The log predicate identification, or null if there is no related predicate.
      object - The log object identification, or null if there is no related object.
      parameters - The map of log parameters, or null if there are no parameters.
      comment - The log comment, or null if there is no log comment.

    • notify

      public void notify(Notification... notifications)
      Description copied from interface: GuiseSession
      Notifies the user of one or more notifications to be presented in sequence. The notification's label and/or icon, if specified, will be used as the dialog title and icon, respectively; if either is not specified, a label and/or icon based upon the notification's severity will be used. If the selected option to any notification is fatal, the remaining notifications will not be performed. The absence of an option selection is considered fatal only if a fatal option was presented for a given notification. This is a convenience method that delegates to GuiseSession.notify(Runnable, Notification...).
      Specified by:
      notify in interface GuiseSession
      Parameters:
      notifications - One or more notification informations to relay.

    • notify

      public void notify(Runnable afterNotify, Notification... notifications)
      Notifies the user of one or more notifications to be presented in sequence, with optional logic to be executed after all notifications have taken place. The notification's label and/or icon, if specified, will be used as the dialog title and icon, respectively; if either is not specified, a label and/or icon based upon the notification's severity will be used. If the selected option to any notification is fatal, the remaining notifications and the specified logic, if any, will not be performed. The absence of an option selection is considered fatal only if a fatal option was presented for a given notification.

      This implementation delegates to notify(Notification, Runnable).

      Specified by:
      notify in interface GuiseSession
      Parameters:
      afterNotify - The code that executes after notification has taken place, or null if no action should be taken after notification.
      notifications - One or more notification informations to relay.

    • notify

      protected void notify(Notification notification, Runnable afterNotify)
      Notifies the user of the given notification information, with optional logic to be executed after notification takes place. The notification's label and/or icon, if specified, will be used as the dialog title and icon, respectively; if either is not specified, a label and/or icon based upon the notification's severity will be used. If the selected option to any notification is fatal, the remaining notifications and the specified logic, if any, will not be performed. The absence of an option selection is considered fatal only if a fatal option was presented for a given notification.
      Parameters:
      notification - The notification information to relay.
      afterNotify - The code that executes after notification has taken place, or null if no action should be taken after notification.

    • notify

      public void notify(Throwable... errors)
      Description copied from interface: GuiseSession
      Notifies the user of the given errors in sequence. If the selected option to any notification is fatal, the remaining notifications will not be performed. The absence of an option selection is considered fatal only if a fatal option was presented for a given notification. This is a convenience method that delegates to GuiseSession.notify(Runnable, Throwable...).
      Specified by:
      notify in interface GuiseSession
      Parameters:
      errors - The errors with which to notify the user.

    • notify

      public void notify(Runnable afterNotify, Throwable... errors)
      Description copied from interface: GuiseSession
      Notifies the user of the given error in sequence, with optional logic to be executed after notification takes place. If the selected option to any notification is fatal, the remaining notifications and the specified logic, if any, will not be performed. The absence of an option selection is considered fatal only if a fatal option was presented for a given notification. This is a convenience method that delegates to GuiseSession.notify(Runnable, Notification...).
      Specified by:
      notify in interface GuiseSession
      Parameters:
      afterNotify - The code that executes after notification has taken place, or null if no action should be taken after notification.
      errors - The errors with which to notify the user.

    • dereferenceString

      public String dereferenceString(String string) throws MissingResourceException
      Description copied from interface: GuiseSession
      Dereferences a string by replacing any string references with a string from the resources. A string reference begins with the Start of String ( SOS) control character (U+0098) and ends with a String Terminator (ST) control character (U+009C). The string between these delimiters will be used to look up a string resource using GuiseSession.getStringResource(String). Strings retrieved from resources will be recursively dereferenced.

      String references appearing between an SOS/ST pair that that begin with the character '=' will be considered string values and, after they are recursively dereferenced, will be applied as formatting arguments to the remaining dereferenced text using MessageFormat.format(String, Object...).

      Specified by:
      dereferenceString in interface GuiseSession
      Parameters:
      string - The string to be dereferenced.
      Returns:
      The dereferenced string with any string references replaced with the appropriate string from the resources.
      Throws:
      MissingResourceException - if no resource could be found associated with a string reference.
      See Also:

    • dereferenceURI

      public URI dereferenceURI(URI uri, String... suffixes) throws MissingResourceException
      Description copied from interface: GuiseSession
      Dereferences a URI by looking up any references from the resources if necessary. If the URI has the "resource" scheme, its scheme-specific part will be used to look up the actual URI using GuiseSession.getURIResource(String). If suffixes are given, they will be appended to the resource key in order, separated by '.'. If no resource is associated with that resource key, a resource will be retrieved using the unadorned resource key. URIs retrieved from resources will be recursively dereferenced without suffixes.
      Specified by:
      dereferenceURI in interface GuiseSession
      Parameters:
      uri - The URI to be dereferenced.
      suffixes - The suffixes, if any, to append to a resource key in a URI reference.
      Returns:
      The URI dereferenced from the resources.
      Throws:
      MissingResourceException - if no resource could be found associated with a string reference.
      See Also:

    • resolveURI

      public URI resolveURI(URI uri, String... suffixes) throws MissingResourceException
      Description copied from interface: GuiseSession
      Resolves a URI against the application base path, looking up the URI from the resources if necessary. The URI will be dereferenced before it is resolved. Relative paths will be resolved relative to the application base path. Absolute paths will be considered already resolved, as will absolute URIs. For an application base path "/path/to/application/", resolving "relative/path" will yield "/path/to/application/relative/path", while resolving "/absolute/path" will yield "/absolute/path". Resolving "http://example.com/path" will yield "http://example.com/path".
      Specified by:
      resolveURI in interface GuiseSession
      Parameters:
      uri - The URI to be resolved.
      suffixes - The suffixes, if any, to append to a resource key in a URI reference.
      Returns:
      The uri resolved against resources the application base path.
      Throws:
      MissingResourceException - if no resource could be found associated with a string reference.
      See Also: