Package org.openbravo.client.application.window

Class OBViewGridComponent

java.lang.Object

org.openbravo.client.kernel.BaseComponent

org.openbravo.client.kernel.BaseTemplateComponent

org.openbravo.client.application.window.OBViewGridComponent

All Implemented Interfaces:

Component

public class OBViewGridComponent
extends BaseTemplateComponent

The backing bean for generating the OBViewGrid client-side representation.

Author:

mtaal

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<String,String>	TEMPLATE_MAP

Fields inherited from class org.openbravo.client.kernel.BaseTemplateComponent

BASE_QUALIFIER, DATA_PARAMETER

Fields inherited from class org.openbravo.client.kernel.BaseComponent

adcs

Constructor Summary

Constructors

Constructor	Description
OBViewGridComponent()

Method Summary

Modifier and Type	Method	Description
boolean	getAllowSummaryFunctions()	Returns true if the grid allows adding summary functions.
boolean	getAlwaysFilterFksByIdentifier()
protected Template	getComponentTemplate()
String	getFilterClauseSQL()
String	getFilterName()
boolean	getLazyFiltering()	Returns true if the grid should filter and sort lazily.
String	getOrderByClause()
String	getOrderByClauseSQL()
List<String>	getRequiredGridProperties()	Returns the string representation of an array that contains all the properties that must always be returned from the datasource when the grid asks for data: - id - client and organization - all the properties that compose the identifier of the entity - all button fields with label values - the link to parent properties - all the properties that are part of the display logic of the tab buttons
String	getSortField()
Tab	getTab()
String	getTableAlias()
String	getUiPattern()
OBViewTab	getViewTab()
String	getWhereClauseSQL()
boolean	isApplyTransactionalFilter()
boolean	isHasFilterClause()
void	setApplyTransactionalFilter(boolean applyTransactionalFilter)
void	setTab(Tab tab)
void	setViewTab(OBViewTab viewTab)

Methods inherited from class org.openbravo.client.kernel.BaseTemplateComponent

generate, getData, setComponentTemplate

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, setContextUrl, setDependencies, setId, setParameters, stripHost

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_MAP

protected static final Map<String,String> TEMPLATE_MAP

Constructor Detail

OBViewGridComponent

public OBViewGridComponent()

Method Detail

getComponentTemplate

protected Template getComponentTemplate()

Overrides:

getComponentTemplate in class BaseTemplateComponent

getTab

public Tab getTab()

setTab

public void setTab(Tab tab)

getWhereClauseSQL

public String getWhereClauseSQL()

getOrderByClause

public String getOrderByClause()

getOrderByClauseSQL

public String getOrderByClauseSQL()

getSortField

public String getSortField()

isHasFilterClause

public boolean isHasFilterClause()

getFilterClauseSQL

public String getFilterClauseSQL()

getFilterName

public String getFilterName()

getUiPattern

public String getUiPattern()

isApplyTransactionalFilter

public boolean isApplyTransactionalFilter()

setApplyTransactionalFilter

public void setApplyTransactionalFilter(boolean applyTransactionalFilter)

getViewTab

public OBViewTab getViewTab()

setViewTab

public void setViewTab(OBViewTab viewTab)

getRequiredGridProperties

public List<String> getRequiredGridProperties()

Returns the string representation of an array that contains all the properties that must always be returned from the datasource when the grid asks for data: - id - client and organization - all the properties that compose the identifier of the entity - all button fields with label values - the link to parent properties - all the properties that are part of the display logic of the tab buttons

getLazyFiltering

public boolean getLazyFiltering()

Returns true if the grid should filter and sort lazily. In that case, the changes done by the user to filter editor and to the grid sorting will not by applied until the user clicks on an 'Apply changes' button

getAllowSummaryFunctions

public boolean getAllowSummaryFunctions()

Returns true if the grid allows adding summary functions. If the tab is based on an HQL table or Datasource table, this method is returning false because grid summaries are not allowed for these kind of tables.

getAlwaysFilterFksByIdentifier

public boolean getAlwaysFilterFksByIdentifier()

getTableAlias

public String getTableAlias()