BaseTemplateComponent (Openbravo ERP 3.0PR24Q3)

java.lang.Object
- org.openbravo.client.kernel.BaseComponent
- - org.openbravo.client.kernel.BaseTemplateComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

ApplicationComponent, AttachmentWindowComponent, DataSourceComponent, MainLayoutComponent, OAuth2LoginButtonGenerator, OBTreeGridComponent, OBTreeReferenceComponent, OBViewFormComponent, OBViewGridComponent, OBViewTab, ParameterWindowComponent, PortalEmailBody, SelectorComponent, SessionDynamicTemplateComponent, StandardWindowComponent, TypesComponent, UIDefinitionController
```
public class BaseTemplateComponent
extends BaseComponent
```
This component implementation uses a template to generate its client representation (java-script). The template is provided by the abstract method getComponentTemplate().

Author:

mtaal

See Also:

Template, TemplateProcessor, TemplateProcessor.Registry

Field Summary

Fields
Modifier and Type Field Description

static String BASE_QUALIFIER

static String DATA_PARAMETER
- Fields inherited from class org.openbravo.client.kernel.BaseComponent
  adcs

Constructor Summary

Constructors
Constructor Description

BaseTemplateComponent()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`generate()`	Generates the content of the component which is sent to the client for execution/rendering.
`protected Template`	`getComponentTemplate()`
`Object`	`getData()`
`void`	`setComponentTemplate(Template componentTemplate)`

Methods inherited from class org.openbravo.client.kernel.BaseComponent
bypassAuthentication, createComponent, getADCS, getApplicationName, getContentType, getContextUrl, getDependencies, getETag, getId, getLastModified, getModule, getModulePackageName, getParameter, getParameterNames, getParameters, getSafeValue, hasParameter, isClassicMode, isInDevelopment, isInDevelopment, isJavaScriptComponent, nullifyModuleCache, setDependencies, setId, setParameters, stripHost

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BASE_QUALIFIER
```
public static final String BASE_QUALIFIER
```
    See Also:
    
    Constant Field Values
  - DATA_PARAMETER
```
public static final String DATA_PARAMETER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseTemplateComponent
```
public BaseTemplateComponent()
```
- Method Detail
  - generate
```
public String generate()
```
    Description copied from interface: Component
    
    Generates the content of the component which is sent to the client for execution/rendering.
    
    Specified by:
    
    generate in interface Component
    
    Specified by:
    
    generate in class BaseComponent
    
    Returns:
    
    the generated javascript which is send back to the client
  - getComponentTemplate
```
protected Template getComponentTemplate()
```
  - setComponentTemplate
```
public void setComponentTemplate(Template componentTemplate)
```
  - getData
```
public Object getData()
```
    Specified by:
    
    getData in class BaseComponent
    
    Returns:
    
    returns this instance
    
    See Also:
    
    BaseComponent.getData()