Package org.nuxeo.ecm.web.resources.api

Interface Resource

All Superinterfaces:

Descriptor

All Known Implementing Classes:

ResourceDescriptor

public interface Resource
extends Descriptor

Typed Web resource (js, css, bundle).

Since:

7.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Marker for Nuxeo web resources, used by URI locators.

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Method Summary

Modifier and Type	Method	Description
List<String>	getDependencies()	Names of the resource dependencies.
default String	getId()	The descriptor id, descriptors with same id are merged.
String	getName()
String	getPath()
List<String>	getProcessors()	Names of the resource processors, hooking features like flavor replacement on the resource.
String	getTarget()	Returns an optional target to push resources to in the page.
String	getType()
String	getURI()
boolean	isShrinkable()	Returns true if resource can be minimized.

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove, merge

Field Details

PREFIX

static final String PREFIX

Marker for Nuxeo web resources, used by URI locators.

See Also:

• Constant Field Values

Method Details

getId

default String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getName

String getName()

getType

String getType()

getPath

String getPath()

getURI

String getURI()

getTarget

String getTarget()

Returns an optional target to push resources to in the page.

Currently only useful to JSF resources.

Since:

7.10

getDependencies

List<String> getDependencies()

Names of the resource dependencies.

getProcessors

List<String> getProcessors()

Names of the resource processors, hooking features like flavor replacement on the resource.

isShrinkable

boolean isShrinkable()

Returns true if resource can be minimized.

Returns true by default if not specified.