Package org.apache.juneau.console.freemarker

Class ToolkitPack

java.lang.Object

org.apache.juneau.console.freemarker.ToolkitPack

public final class ToolkitPack
extends Object

One named toolkit pack: ordered CSS and JS asset paths, the packs it depends on, its ToolkitPack.Kind, and the resolver that turns each path into a URL.

Register one through ConsoleFreemarkerMixin.Builder.registerToolkitPack(ToolkitPack). A pack registered under an existing name replaces that pack completely, including its dependsOn.

Example:

ToolkitPack.create("datatables-export") .js(jszip, pdfmake, vfsFonts) .dependsOn("datatables-buttons") .kind(ToolkitPack.Kind.VENDOR) .resolver(myResolver) .build();

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ToolkitPack.Builder	Builder for ToolkitPack.
static enum	ToolkitPack.Kind	Where a pack's assets are emitted on the page.

Method Summary

Modifier and Type	Method	Description
static ToolkitPack.Builder	create(String name)	Starts a pack.
List<String>	cssPaths()	Returns the ordered CSS asset paths.
List<String>	dependsOn()	Returns the names of the packs this one loads after, in order.
List<String>	jsPaths()	Returns the ordered JS asset paths.
ToolkitPack.Kind	kind()	Returns the pack kind.
String	name()	Returns the pack name.
ToolkitPackRegistry.AssetUrlResolver	resolver()	Returns the asset-URL resolver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static ToolkitPack.Builder create(String name)

Starts a pack.

Parameters:

name - The pack name. Must not be blank.

Returns:

A new builder.

name

public String name()

Returns the pack name.

Returns:

The pack name.

cssPaths

public List<String> cssPaths()

Returns the ordered CSS asset paths.

Returns:

The ordered CSS asset paths.

jsPaths

public List<String> jsPaths()

Returns the ordered JS asset paths.

Returns:

The ordered JS asset paths.

dependsOn

public List<String> dependsOn()

Returns the names of the packs this one loads after, in order.

Returns:

The names of the packs this one loads after, in order.

kind

public ToolkitPack.Kind kind()

Returns the pack kind.

Returns:

The pack kind.

resolver

public ToolkitPackRegistry.AssetUrlResolver resolver()

Returns the asset-URL resolver.

Returns:

The asset-URL resolver.