Package io.guise.framework.platform

Interface DepictContext

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.net.URI getDepictionURI()  
      java.net.URI getDepictionURI​(com.globalmentor.net.URIPath navigationPath, java.lang.String... suffixes)
      Determines the URI to use for depiction based upon a navigation path.
      java.net.URI getDepictionURI​(java.net.URI navigationURI, java.lang.String... suffixes)
      Determines the URI to use for depiction based upon a navigation URI.
      Destination getDestination()  
      Platform getPlatform()  
      GuiseSession getSession()  
      java.lang.Iterable<java.net.URI> getStyles()
      Retrieves styles for this context.

      • Methods inherited from interface com.globalmentor.beans.PropertyBindable

        addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

    • Method Detail

      • getSession

        GuiseSession getSession()
        Returns:
        The Guise user session of which this context is a part.

      • getPlatform

        Platform getPlatform()
        Returns:
        The platform on which Guise objects are depicted.

      • getDestination

        Destination getDestination()
        Returns:
        The destination with which this context is associated.

      • getDepictionURI

        java.net.URI getDepictionURI()
        Returns:
        The current full absolute URI for this depiction, including any query.

      • getDepictionURI

        java.net.URI getDepictionURI​(com.globalmentor.net.URIPath navigationPath,
                             java.lang.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. The resulting URI may not be absolute, but can be made absolute by resolving it against the depiction root URI. This method is equivalent to calling GuiseSession.getDepictionURI(URIPath, String...).
        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.
        See Also:
        GuiseSession.getDepictionURI(URIPath, String...)

      • getDepictionURI

        java.net.URI getDepictionURI​(java.net.URI navigationURI,
                             java.lang.String... suffixes)
        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. The resulting URI may not be absolute, but can be made absolute by resolving it against the depiction root URI. This method is equivalent to calling GuiseSession.getDepictionURI(URI, String...).
        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, deferenced and resolved to the application.
        See Also:
        GuiseSession.getDepictionURI(URI, String...)

      • getStyles

        java.lang.Iterable<java.net.URI> getStyles()
        Retrieves styles for this context. Styles appear in the following order:
        1. theme styles (from most distant parent to current theme)
        2. application style
        3. destination style
        Returns:
        The URIs of the styles for this context, in order.