Package org.openbravo.userinterface.selector

Class SelectorComponent

java.lang.Object

org.openbravo.client.kernel.BaseComponent

org.openbravo.client.kernel.BaseTemplateComponent

org.openbravo.userinterface.selector.SelectorComponent

All Implemented Interfaces:

Component

public class SelectorComponent
extends BaseTemplateComponent

Generates the javascript for a selector using parameters passed in as part of the request. This class has convenience methods to facilitate the template.

Author:

mtaal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SelectorComponent.LocalSelectorField
static class	SelectorComponent.OutSelectorField

Field Summary

Fields

Modifier and Type	Field	Description
static String	SELECTOR_ITEM_PARAMETER

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
SelectorComponent()

Method Summary

Modifier and Type	Method	Description
static String	getAdditionalProperties(Selector selector, boolean onlyDisplayField)
String	getCallOut()
String	getColumnName()
String	getComboReload()
protected Template	getComponentTemplate()
String	getDataSourceJavascript()
String	getDefaultPopupFilterField()	Computes the field in the popup which can receive the value entered by the user in the suggestion box, to set the first default filter.
String	getDisabled()
String	getDisplayField()
String	getExtraSearchFields()
Map<String,String>	getHiddenInputs()
Module	getModule()
String	getNumCols()
List<SelectorComponent.OutSelectorField>	getOutFields()
String	getOutHiddenInputPrefix()
List<SelectorComponent.LocalSelectorField>	getPickListFields()
String	getProcessDefinition()
String	getRequired()
Selector	getSelector()
List<SelectorComponent.LocalSelectorField>	getSelectorGridFields()
String	getShowSelectorGrid()
String	getSortByField()	Determines the field that will be used by the data sources to sort the fetched records.
String	getTargetPropertyName()
String	getTitle()
String	getValueField()
boolean	isSelectorItem()

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, 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

SELECTOR_ITEM_PARAMETER

public static final String SELECTOR_ITEM_PARAMETER

See Also:

Constant Field Values

Constructor Detail

SelectorComponent

public SelectorComponent()

Method Detail

getAdditionalProperties

public static String getAdditionalProperties(Selector selector,
                                             boolean onlyDisplayField)

getComponentTemplate

protected Template getComponentTemplate()

Overrides:

getComponentTemplate in class BaseTemplateComponent

isSelectorItem

public boolean isSelectorItem()

getModule

public Module getModule()

Specified by:

getModule in interface Component

Overrides:

getModule in class BaseComponent

Returns:

the module providing this component

getDefaultPopupFilterField

public String getDefaultPopupFilterField()

Computes the field in the popup which can receive the value entered by the user in the suggestion box, to set the first default filter.

Returns:

the field in the popup to set.

getSelector

public Selector getSelector()

getColumnName

public String getColumnName()

getComboReload

public String getComboReload()

getDisabled

public String getDisabled()

getTargetPropertyName

public String getTargetPropertyName()

getValueField

public String getValueField()

getDisplayField

public String getDisplayField()

getSortByField

public String getSortByField()

Determines the field that will be used by the data sources to sort the fetched records. If there is no sort field defined for the selector, then the record are sorted by the values of the display field by default.

Returns:

the name of the field used to sort the selector records

getProcessDefinition

public String getProcessDefinition()

getRequired

public String getRequired()

getCallOut

public String getCallOut()

getShowSelectorGrid

public String getShowSelectorGrid()

Returns:

true if there is at least one active field shown in grid

getTitle

public String getTitle()

getDataSourceJavascript

public String getDataSourceJavascript()

getNumCols

public String getNumCols()

getExtraSearchFields

public String getExtraSearchFields()

getOutFields

public List<SelectorComponent.OutSelectorField> getOutFields()

getOutHiddenInputPrefix

public String getOutHiddenInputPrefix()

getHiddenInputs

public Map<String,String> getHiddenInputs()

getPickListFields

public List<SelectorComponent.LocalSelectorField> getPickListFields()

getSelectorGridFields

public List<SelectorComponent.LocalSelectorField> getSelectorGridFields()