Package org.jgrapes.webconsole.base

Interface RenderSupport

public interface RenderSupport

Provides support for creating URIs in the web console scope that are forwarded to components listening on the web console channel.

Method Summary

Modifier and Type	Method	Description
default URI	conletResource(String conletType, String path)	Convenience method that converts the path to an URI before calling conletResource(String, URI).
URI	conletResource(String conletType, URI uri)	Create a reference to a resource provided by a web console component of the given type.
default URI	consoleBaseResource(String path)	Convenience method that converts the path to an URI before calling consoleBaseResource(URI).
URI	consoleBaseResource(URI uri)	Returns the web console library URI.
default URI	consoleResource(String path)	Convenience method that converts the path to an URI before calling consoleResource(URI).
URI	consoleResource(URI uri)	Create a reference to a resource provided by the web console.
default URI	pageResource(String path)	Convenience method that converts the path to an URI before calling pageResource(URI).
URI	pageResource(URI uri)	Create a reference to a resource provided by a page resource provider.
boolean	useMinifiedResources()	Indicates if minified resources should be used.

Method Details

consoleBaseResource

URI consoleBaseResource(URI uri)

Returns the web console library URI.

Parameters:

uri - the uri

Returns:

the uri

consoleBaseResource

default URI consoleBaseResource(String path)

Convenience method that converts the path to an URI before calling consoleBaseResource(URI).

Parameters:

path - the path

Returns:

the resulting URI

consoleResource

URI consoleResource(URI uri)

Create a reference to a resource provided by the web console.

Parameters:

uri - the URI

Returns:

the resulting URI

consoleResource

default URI consoleResource(String path)

Convenience method that converts the path to an URI before calling consoleResource(URI).

Parameters:

path - the path

Returns:

the resulting URI

pageResource

URI pageResource(URI uri)

Create a reference to a resource provided by a page resource provider.

Requesting the resulting URI results in a PageResourceRequest.

Parameters:

uri - the URI made available as ResourceRequest.resourceUri()

Returns:

the resulting URI

pageResource

default URI pageResource(String path)

Convenience method that converts the path to an URI before calling pageResource(URI).

Parameters:

path - the path

Returns:

the resulting URI

conletResource

URI conletResource(String conletType,
 URI uri)

Create a reference to a resource provided by a web console component of the given type.

Requesting the resulting URI results in a ConletResourceRequest.

Parameters:

conletType - the web console component type

uri - the URI made available as ResourceRequest.resourceUri()

Returns:

the resulting URI

conletResource

default URI conletResource(String conletType,
 String path)

Convenience method that converts the path to an URI before calling conletResource(String, URI).

Parameters:

conletType - the web console component type

path - the path

Returns:

the resulting URI

useMinifiedResources

boolean useMinifiedResources()

Indicates if minified resources should be used.

Returns:

the setting