Package org.openbravo.client.kernel

Class BaseComponentProvider

java.lang.Object

org.openbravo.client.kernel.BaseComponentProvider

All Implemented Interfaces:

ComponentProvider

Direct Known Subclasses:

ApplicationComponentProvider, APRMApplicationProvider, DataSourceComponentProvider, HTMLWidgetComponentProvider, KernelComponentProvider, MyOpenbravoComponentProvider, QueryListComponentProvider, SelectorComponentProvider, SmartClientComponentProvider, WidgetsCollectionComponentProvider

public abstract class BaseComponentProvider
extends Object
implements ComponentProvider

Base implementation, can be extended.

Author:

mtaal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseComponentProvider.ComponentResource

Nested classes/interfaces inherited from interface org.openbravo.client.kernel.ComponentProvider

ComponentProvider.Qualifier, ComponentProvider.Selector

Constructor Summary

Constructors

Constructor	Description
BaseComponentProvider()

Method Summary

Modifier and Type	Method	Description
protected BaseComponentProvider.ComponentResource	createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type, String path)
protected BaseComponentProvider.ComponentResource	createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type, String path, String validForApp)
protected BaseComponentProvider.ComponentResource	createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type, String path, List<String> validForAppList)
protected BaseComponentProvider.ComponentResource	createDynamicResource(String path)
protected BaseComponentProvider.ComponentResource	createStaticResource(String path, boolean includeAlsoInClassicMode)
protected BaseComponentProvider.ComponentResource	createStaticResource(String path, boolean includeAlsoInClassicMode, boolean includeInNewUIMode)
protected BaseComponentProvider.ComponentResource	createStyleSheetResource(String path, boolean includeAlsoInClassicMode)
protected BaseComponentProvider.ComponentResource	createStyleSheetResource(String path, boolean includeAlsoInClassicMode, boolean includeInNewUIMode)
protected <U extends Component> U	getComponent(Class<U> clz)	Return a component of the correct implementation using Weld.
List<BaseComponentProvider.ComponentResource>	getGlobalComponentResources()	Implemented here for backward compatibility, calls the getGlobalResources()
List<String>	getGlobalResources()	Deprecated.
Module	getModule()
protected String	getModulePackageName()	Override this method if the component is in a different package than the module.
String	getVersionParameters(String resource)	Computes parameters to add to a link of a resource.
static void	setAppDependencies(String app, List<String> dependencies)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbravo.client.kernel.ComponentProvider

getComponent

Constructor Detail

BaseComponentProvider

public BaseComponentProvider()

Method Detail

getComponent

protected <U extends Component> U getComponent(Class<U> clz)

Return a component of the correct implementation using Weld.

Parameters:

clz - an instance of this class will be returned

Returns:

an instance of clz

getModule

public Module getModule()

Specified by:

getModule in interface ComponentProvider

Returns:

the Module to which this provider belongs

setAppDependencies

public static void setAppDependencies(String app,
                                      List<String> dependencies)

getVersionParameters

public String getVersionParameters(String resource)

Computes parameters to add to a link of a resource. The parameters include the version and language of the user. The version computation logic depends on if the module is in development ( Module.isInDevelopment(). If in developers mode then the System.currentTimeMillis() is used. If not in developers mode then the Module.getVersion() is used. These values are prepended with the language id of the user. This makes it possible to generate language specific components on the server.

Specified by:

getVersionParameters in interface ComponentProvider

Parameters:

resource - , the resource to compute the version string for, is typically a resource provided by the getGlobalResources method

Returns:

the version parameter string, a concatenation of the version and language with parameter names

See Also:

KernelConstants.RESOURCE_VERSION_PARAMETER, KernelConstants.RESOURCE_LANGUAGE_PARAMETER, KernelUtils.getVersionParameters(Module)

getModulePackageName

protected String getModulePackageName()

Override this method if the component is in a different package than the module.

createComponentResource

protected BaseComponentProvider.ComponentResource createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type,
                                                                          String path)

createComponentResource

protected BaseComponentProvider.ComponentResource createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type,
                                                                          String path,
                                                                          String validForApp)

createComponentResource

protected BaseComponentProvider.ComponentResource createComponentResource(BaseComponentProvider.ComponentResource.ComponentResourceType type,
                                                                          String path,
                                                                          List<String> validForAppList)

createStaticResource

protected BaseComponentProvider.ComponentResource createStaticResource(String path,
                                                                       boolean includeAlsoInClassicMode,
                                                                       boolean includeInNewUIMode)

createStaticResource

protected BaseComponentProvider.ComponentResource createStaticResource(String path,
                                                                       boolean includeAlsoInClassicMode)

createStyleSheetResource

protected BaseComponentProvider.ComponentResource createStyleSheetResource(String path,
                                                                           boolean includeAlsoInClassicMode,
                                                                           boolean includeInNewUIMode)

createStyleSheetResource

protected BaseComponentProvider.ComponentResource createStyleSheetResource(String path,
                                                                           boolean includeAlsoInClassicMode)

createDynamicResource

protected BaseComponentProvider.ComponentResource createDynamicResource(String path)

getGlobalComponentResources

public List<BaseComponentProvider.ComponentResource> getGlobalComponentResources()

Implemented here for backward compatibility, calls the getGlobalResources()

Specified by:

getGlobalComponentResources in interface ComponentProvider

Returns:

the global resources which are needed to be present on every page.

getGlobalResources

@Deprecated
public List<String> getGlobalResources()

Deprecated.

Specified by:

getGlobalResources in interface ComponentProvider

Returns:

the global resources which are needed to be present on every page.