com.day.cq.widget
Interface HtmlLibraryManager

public interface HtmlLibraryManager

HtmlLibraryManager provides access to repository defined html libraries.

Field Summary

static String	PARAM_DEBUG_CLIENT_LIBS request parameter name for turning on HtmlLibraryServlet debugging
static String	PARAM_DEBUG_CONSOLE request parameter name for enabling debug console (firebug + cq logging)
static String	PARAM_FORCE_THEME request parameter name for testing a theme

Method Summary

Map<String,ClientLibrary>	getLibraries() Returns all client libraries
Collection<ClientLibrary>	getLibraries(String[] categories, LibraryType type, boolean ignoreThemed, boolean transitive) Returns all client libraries that match the specified filters.
HtmlLibrary	getLibrary(LibraryType type, String path) Returns the html library that is configured at the given path.
HtmlLibrary	getLibrary(SlingHttpServletRequest request) Returns the html library that is address by the given request. if no such library exists, null is returned.
Collection<ClientLibrary>	getThemeLibraries(String[] categories, LibraryType type, String themeName, boolean transitive) Returns all themed client libraries that match the type.
boolean	isDebugEnabled() Checks if debug support is enabled.
boolean	isGzipEnabled() Checks if gzip compression is enabled.
boolean	isMinifyEnabled() Checks if library minification is enabled.
void	writeCssInclude(SlingHttpServletRequest request, Writer out, boolean themed, String... categories) Writes the CSS include snippets to the given writer.
void	writeCssInclude(SlingHttpServletRequest request, Writer out, String... categories) Writes the CSS include snippets to the given writer.
void	writeIncludes(SlingHttpServletRequest request, Writer out, String... categories) Writes the include snippets to the given writer.
void	writeJsInclude(SlingHttpServletRequest request, Writer out, boolean themed, String... categories) Writes the JS include snippets to the given writer.
void	writeJsInclude(SlingHttpServletRequest request, Writer out, String... categories) Writes the JS include snippets to the given writer.
void	writeThemeInclude(SlingHttpServletRequest request, Writer out, String... categories) Writes all CSS and only themed JS include snippets to the given writer.

Field Detail

PARAM_DEBUG_CONSOLE

static final String PARAM_DEBUG_CONSOLE

request parameter name for enabling debug console (firebug + cq logging)

See Also:

Constant Field Values

PARAM_DEBUG_CLIENT_LIBS

static final String PARAM_DEBUG_CLIENT_LIBS

request parameter name for turning on HtmlLibraryServlet debugging

See Also:

Constant Field Values

PARAM_FORCE_THEME

static final String PARAM_FORCE_THEME

request parameter name for testing a theme

See Also:

Constant Field Values

Method Detail

writeJsInclude

void writeJsInclude(SlingHttpServletRequest request,
                    Writer out,
                    String... categories)
                    throws IOException

Writes the JS include snippets to the given writer. The paths to the JS libraries are included that match the given categories. Note that themed and non-themed libraries are included. If the request contains a "forceTheme" parameter, the themed libraries are overlaid with their respective counterparts with that given theme.

Parameters:

request - request

out - writer

categories - categories

Throws:

IOException - if an I/O error occurs

writeJsInclude

void writeJsInclude(SlingHttpServletRequest request,
                    Writer out,
                    boolean themed,
                    String... categories)
                    throws IOException

Writes the JS include snippets to the given writer. The paths to the JS libraries are included that match the given categories. If themed is false, only non-themed libraries are included. If themed is true only themed libraries are included and if the request contains a "forceTheme" parameter, the themed libraries are overlaid with their respective counterparts with that given theme.

Parameters:

request - request

out - writer

themed - controls if themed or non themed libraries should be included

categories - categories

Throws:

IOException - if an I/O error occurs

Since:

5.4

writeCssInclude

void writeCssInclude(SlingHttpServletRequest request,
                     Writer out,
                     String... categories)
                     throws IOException

Writes the CSS include snippets to the given writer. The paths to the CSS libraries are included that match the given categories. Note that themed and non-themed libraries are included. If the request contains a "forceTheme" parameter, the themed libraries are overlaid with their respective counterparts with that given theme.

Parameters:

request - request

out - writer

categories - categories

Throws:

IOException - if an I/O error occurs

writeCssInclude

void writeCssInclude(SlingHttpServletRequest request,
                     Writer out,
                     boolean themed,
                     String... categories)
                     throws IOException

Writes the CSS include snippets to the given writer. The paths to the CSS libraries are included that match the given categories. If themed is false, only non-themed libraries are included. If themed is true only themed libraries are included and if the request contains a "forceTheme" parameter, the themed libraries are overlaid with their respective counterparts with that given theme.

Parameters:

request - request

out - writer

themed - controls if themed or non themed libraries should be included

categories - categories

Throws:

IOException - if an I/O error occurs

Since:

5.4

writeThemeInclude

void writeThemeInclude(SlingHttpServletRequest request,
                       Writer out,
                       String... categories)
                       throws IOException

Writes all CSS and only themed JS include snippets to the given writer. The paths to the libraries are included that match the given categories. If the request contains a "forceTheme" parameter, the themed libraries are overlaid with their respective counterparts with that given theme. Please note, that the theme include should happen after the js includes since the theme js might reference themes.

Parameters:

request - request

out - writer

categories - categories

Throws:

IOException - if an I/O error occurs

writeIncludes

void writeIncludes(SlingHttpServletRequest request,
                   Writer out,
                   String... categories)
                   throws IOException

Writes the include snippets to the given writer. The paths to the libraries are included that match the given categories and the theme name that is extracted from the request.
Same as:
writeCssInclude(...); writeJsInclude(...); writeThemeInclude(...); If one of the libraries to be included has assigned channels, then the inclusion is delegated to the client side library manager.

Parameters:

request - request

out - writer

categories - categories

Throws:

IOException - if an I/O error occurs

getLibrary

HtmlLibrary getLibrary(LibraryType type,
                       String path)

Returns the html library that is configured at the given path. If no such library exists, null is returned.

Parameters:

type - the library type

path - the path

Returns:

the library or null

getLibrary

HtmlLibrary getLibrary(SlingHttpServletRequest request)

Returns the html library that is address by the given request. if no such library exists, null is returned.

Parameters:

request - the request

Returns:

the library or null

isMinifyEnabled

boolean isMinifyEnabled()

Checks if library minification is enabled.

Returns:

true if minification is enabled.

isDebugEnabled

boolean isDebugEnabled()

Checks if debug support is enabled.

Returns:

true if debug is enabled.

isGzipEnabled

boolean isGzipEnabled()

Checks if gzip compression is enabled.

Returns:

true if gzip is enabled.

getLibraries

Map<String,ClientLibrary> getLibraries()

Returns all client libraries

Returns:

all client libraries

Since:

5.4

getLibraries

Collection<ClientLibrary> getLibraries(String[] categories,
                                       LibraryType type,
                                       boolean ignoreThemed,
                                       boolean transitive)

Returns all client libraries that match the specified filters. If a theme name is specified, only themed libraries are returned, otherwise only non-theme libraries are returned. If theme name is an empty string, the configured default theme is used.

Parameters:

categories - the categories

type - type or null to match all types

ignoreThemed - true to filter out themed libraries

transitive - true to resolve recursively

Returns:

matching client libraries

Since:

5.4

getThemeLibraries

Collection<ClientLibrary> getThemeLibraries(String[] categories,
                                            LibraryType type,
                                            String themeName,
                                            boolean transitive)

Returns all themed client libraries that match the type. If type is null all libraries are returned. If theme name is an empty string, the configured default theme is used. If theme name is null all themed libraries are returned.

Parameters:

categories - the categories

type - type or null to match all types

themeName - theme name or null

transitive - true to resolve recursively

Returns:

matching client libraries

Since:

5.4