Skip navigation links
A C F G I J M N O P R S T U W 

A

addedJSBundle(JSBundle, Bundle, NPMRegistry) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleTracker
Deprecated.
 
addJSBundleTracker(JSBundleTracker) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
Deprecated.
As of Mueller (7.2.x), with no direct replacement
addJSModule(JSModule) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.ModifiableJSPackage
 
appendPortletScript(HttpServletRequest, String, Collection<JSModuleDependency>, String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleLauncher
 
appendScript(HttpServletRequest, Collection<JSModuleDependency>, String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleLauncher
 

C

com.liferay.frontend.js.loader.modules.extender.npm - package com.liferay.frontend.js.loader.modules.extender.npm
Defines the interfaces and utilities for the NPM registry facility.
com.liferay.frontend.js.module.launcher - package com.liferay.frontend.js.module.launcher
 
com.liferay.frontend.js.top.head.extender - package com.liferay.frontend.js.top.head.extender
 

F

finish() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistryUpdate
Call this method when all modules have been updated so that the NPMRegistry can refresh its caches.

G

get(HttpServletRequest) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolvedPackageNameUtil
Get the NPM resolved package name associated to the current portlet.
get(ServletContext) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolvedPackageNameUtil
Get the NPM resolved package name associated to the bundle containing the given servlet context.
getAlias() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSModuleAlias
 
getAuthenticatedJsResourcePaths() - Method in interface com.liferay.frontend.js.top.head.extender.TopHeadResources
 
getDependencies() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSModule
Returns the module dependencies declared by the NPM module.
getDependencyJSPackage(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMResolver
 
getDependencyJSPackage(Bundle, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement
getDependencyJSPackage(Class<?>, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement
getDependencyPackageNames() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSModule
Returns the packages that contain all the NPM module's dependencies.
getDependencyPath(String, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Resolve dependency path based on current module's path.
getFlagsJSONObject() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSModule
Get the metadata that describe the module.
getGlobalAliases() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getId() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleObject
Returns the model object's unique ID.
getInputStream() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleAsset
Returns the asset's contents.
getJSBundle() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the NPM package's bundle.
getJSModule(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
 
getJSModule(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getJSModuleAliases() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
 
getJSModules() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the NPM modules contained inside the NPM package.
getJSPackage() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSModule
Returns the module's NPM package.
getJsPackage() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSModuleAlias
 
getJSPackage() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSPackageDependency
Returns the NPM package declaring the dependency.
getJSPackage(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getJSPackage() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMResolver
 
getJSPackage(Bundle) - Method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement
getJSPackage(Class<?>) - Method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement
getJSPackageDependencies() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the dependencies (i.e., other NPM packages) declared by the NPM package.
getJSPackageDependency(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the NPM package's dependency (i.e., another NPM package) with the package name.
getJSPackages() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundle
Returns the NPM packages provided by the OSGi bundle.
getJSPackages() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getJsResourcePaths() - Method in interface com.liferay.frontend.js.top.head.extender.TopHeadResources
 
getMainModuleName() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the default module's name declared by the NPM package.
getModuleId(JSPackage, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the module ID with the NPM package and module name.
getModuleName() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSModuleAlias
 
getModuleName() - Method in class com.liferay.frontend.js.module.launcher.JSModuleDependency
 
getModuleResolvedId(JSPackage, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the module resolved ID with the NPM package and module name.
getName() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleObject
Returns the model object's name.
getNPMResolver(Bundle) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
 
getNPMResolver(Class<?>) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
 
getPackageName() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSPackageDependency
Returns the dependency's package name.
getPackageName(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the package name portion of a full module name.
getPackagePath(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the path portion of a full module name.
getResolvedId() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
 
getResolvedId() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSResolvableBundleAsset
Returns the asset's resolved ID; this differs from the canonical ID defined in the JSBundleAsset.
getResolvedJSModule(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getResolvedJSModules() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getResolvedJSPackage(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getResolvedJSPackages() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
getResolvedURL() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSResolvableBundleAsset
Returns the asset's resolved URL; this differs from the canonical URL defined in the JSBundleAsset.
getResourceURL(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundle
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
getResourceURL(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
getServletContextPath() - Method in interface com.liferay.frontend.js.top.head.extender.TopHeadResources
 
getSourceMapInputStream() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSModule
Returns the module's source map.
getURL() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleAsset
Returns the asset's public URL.
getVariableName() - Method in class com.liferay.frontend.js.module.launcher.JSModuleDependency
 
getVersion() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundle
Returns the bundle's OSGi version.
getVersion() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSPackage
Returns the package's NPM version.
getVersionConstraints() - Method in class com.liferay.frontend.js.loader.modules.extender.npm.JSPackageDependency
Returns the NPM semantic version expression defining the suitable versions for the dependency.

I

isLocalModuleName(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
 
isReservedModuleName(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
 
isValidModule(String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleLauncher
Check if a JavaScript module identified by name must be loaded using JSModuleLauncher (instead of AMD Loader, for example).

J

JavaScriptAwarePortalWebResources - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Should be implemented by every PortalWebResources that is based on Javascript content and needs to be notified every time a JSBundle gets started in order, for example, to refresh its cached content.
JSBundle - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Represents an OSGi bundle containing NPM packages and modules.
JSBundleAsset - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Provides contents of a JSBundleObject.
JSBundleObject - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Provides an object related to the NPM description model that can be directly referenced by its unique ID.
JSBundleProcessor - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Processes an OSGi bundle to find NPM packages and modules inside it and make them available for the NPMRegistry to track them.
JSBundleTracker - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Deprecated.
As of Mueller (7.2.x), with no direct replacement
JSModule - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Represents an NPM module inside a JSBundle.
JSModuleAlias - Class in com.liferay.frontend.js.loader.modules.extender.npm
 
JSModuleAlias(JSPackage, String, String) - Constructor for class com.liferay.frontend.js.loader.modules.extender.npm.JSModuleAlias
 
JSModuleDependency - Class in com.liferay.frontend.js.module.launcher
 
JSModuleDependency(String, String) - Constructor for class com.liferay.frontend.js.module.launcher.JSModuleDependency
 
JSModuleLauncher - Interface in com.liferay.frontend.js.module.launcher
 
JSModuleResolver - Interface in com.liferay.frontend.js.module.launcher
 
JSPackage - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Represents an NPM package inside a JSBundle.
JSPackageDependency - Class in com.liferay.frontend.js.loader.modules.extender.npm
Represents an NPM package dependency (i.e., another NPM package).
JSPackageDependency(JSPackage, String, String) - Constructor for class com.liferay.frontend.js.loader.modules.extender.npm.JSPackageDependency
Constructs a JSPackageDependency with the JS package, package name, and version constraints.
JSResolvableBundleAsset - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Represents a JSBundleAsset that is selected/resolved from a pool of equivalent objects of the same type.

M

mapModuleName(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
ModifiableJSPackage - Interface in com.liferay.frontend.js.loader.modules.extender.npm
A JSPackage that allows addition of new JSModules.
ModuleNameUtil - Class in com.liferay.frontend.js.loader.modules.extender.npm
Provides utility methods to manipulate module names.
ModuleNameUtil() - Constructor for class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
 

N

NPMRegistry - Interface in com.liferay.frontend.js.loader.modules.extender.npm
 
NPMRegistryUpdate - Interface in com.liferay.frontend.js.loader.modules.extender.npm
An object to update the NPMRegistry modules in an efficient way.
NPMRegistryUpdatesListener - Interface in com.liferay.frontend.js.loader.modules.extender.npm
Can be implemented by any service needing to be notified when the NPMRegistry is updated.
NPMResolvedPackageNameUtil - Class in com.liferay.frontend.js.loader.modules.extender.npm
 
NPMResolvedPackageNameUtil() - Constructor for class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolvedPackageNameUtil
 
NPMResolver - Interface in com.liferay.frontend.js.loader.modules.extender.npm
 
NPMResolverUtil - Class in com.liferay.frontend.js.loader.modules.extender.npm
This class provides the same functionality as NPMResolver but without the need to reference any OSGi service or component.
NPMResolverUtil() - Constructor for class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
 

O

onAfterUpdate() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistryUpdatesListener
 

P

process(Bundle) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleProcessor
Returns a JS Bundle filled with the description of the NPM packages or modules found in the given bundle.

R

registerJSModule(JSPackage, String, Collection<String>, String, String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistryUpdate
 
removedJSBundle(JSBundle, Bundle, NPMRegistry) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleTracker
Deprecated.
 
removeJSBundleTracker(JSBundleTracker) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
Deprecated.
As of Mueller (7.2.x), with no direct replacement
removeJSModule(JSModule) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.ModifiableJSPackage
 
replaceJSModule(JSModule) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.ModifiableJSPackage
 
resolveJSPackageDependency(JSPackageDependency) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
resolveModule(Bundle, String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleResolver
 
resolveModule(ServletContext, String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleResolver
 
resolveModuleName(String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMResolver
 
resolveModuleName(Bundle, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement
resolveModuleName(Class<?>, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement

S

set(ServletContext, String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolvedPackageNameUtil
 
set(Bundle, NPMResolver) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.NPMResolverUtil
Deprecated.
As of Mueller (7.2.x), with no direct replacement

T

toFileName(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the file name implementing the module.
toModuleName(String) - Static method in class com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil
Returns the module's name given the file name implementing it.
TopHeadResources - Interface in com.liferay.frontend.js.top.head.extender
 

U

unregisterJSModule(JSModule) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistryUpdate
 
update() - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistry
 
updateJSModule(JSModule, Collection<String>, String, String) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.NPMRegistryUpdate
 
updateLastModifed(long) - Method in interface com.liferay.frontend.js.loader.modules.extender.npm.JavaScriptAwarePortalWebResources
 

W

writeModuleInvocation(Writer, String, String...) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleLauncher
 
writeScript(Writer, Collection<JSModuleDependency>, String) - Method in interface com.liferay.frontend.js.module.launcher.JSModuleLauncher
 
A C F G I J M N O P R S T U W 
Skip navigation links