Package org.openbravo.client.kernel.reference

Class FKTreeUIDefinition

java.lang.Object

org.openbravo.client.kernel.reference.UIDefinition

org.openbravo.client.kernel.reference.ForeignKeyUIDefinition

org.openbravo.client.kernel.reference.FKTreeUIDefinition

public class FKTreeUIDefinition
extends ForeignKeyUIDefinition

Implementation of the foreign key tree ui definition. It uses a tree grid for its input and filter types

Field Summary

Fields inherited from class org.openbravo.client.kernel.reference.UIDefinition

log

Constructor Summary

Constructors

Constructor	Description
FKTreeUIDefinition()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getDataSourceParameters()	Parameters passed in to the datasource, for example the JsonConstants.ADDITIONAL_PROPERTIES_PARAMETER can be passed in like this.
protected String	getDisplayFieldName(Field field, Property prop)	Note: can return null, in that case the default display field name is used
String	getFieldProperties(Field field)	Computes properties to initialize and set the field in a Smartclient form.
String	getFieldProperties(Field field, boolean getValueFromSession)	Computes properties to initialize and set the field in a Smartclient form.
String	getFilterEditorType()
String	getFormEditorType()
String	getParameterProperties(Parameter parameter)
static ReferencedTree	getReferencedTreeFromReference(Reference reference)

Methods inherited from class org.openbravo.client.kernel.reference.ForeignKeyUIDefinition

getFilterEditorPropertiesProperty, getGridFieldProperties, getParentType, getSuperGridFieldName, getSuperGridFieldProperties, getTypeProperties

Methods inherited from class org.openbravo.client.kernel.reference.UIDefinition

convertToClassicString, createFromClassicString, createJsonValueFromClassicValueString, establishGridConfigurationSettings, formatValueFromSQL, formatValueToSQL, getCellAlign, getDefaultValue, getDefaultValueFromSQLExpression, getDomainType, getFieldPropertiesFirstRecord, getFieldPropertiesWithoutCombo, getFilterEditorProperties, getGridEditorFieldProperties, getGridEditorType, getGridFieldName, getName, getParameterWidth, getReadOnlyEditorType, getReference, getSafeBoolean, getShowHoverGridFieldSettings, getValueFromSQLDefault, getValueInComboReference, getValueInComboReference, parseSQL, readGridConfigurationSetting, removeAttributeFromString, setReference, showHover

Methods inherited from class java.lang.Object

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

Constructor Detail

FKTreeUIDefinition

public FKTreeUIDefinition()

Method Detail

getFormEditorType

public String getFormEditorType()

Overrides:

getFormEditorType in class ForeignKeyUIDefinition

Returns:

the form item type used for editing this reference in a form.

getFilterEditorType

public String getFilterEditorType()

Overrides:

getFilterEditorType in class ForeignKeyUIDefinition

Returns:

the form item type used for filtering in grids. As a default will return UIDefinition.getFormEditorType()

getFieldProperties

public String getFieldProperties(Field field,
                                 boolean getValueFromSession)

Description copied from class: UIDefinition

Computes properties to initialize and set the field in a Smartclient form. This can be the default value or the sets of values in the valuemap.

Overrides:

getFieldProperties in class UIDefinition

Parameters:

field - the field for which the information should be computed.

Returns:

a JSONObject string which is used to initialize the formitem.

getDataSourceParameters

public Map<String,Object> getDataSourceParameters()

Description copied from class: UIDefinition

Parameters passed in to the datasource, for example the JsonConstants.ADDITIONAL_PROPERTIES_PARAMETER can be passed in like this.

Overrides:

getDataSourceParameters in class UIDefinition

Returns:

a list of parameters used to drive the datasource generation incorporating this UIDefinition.

getDisplayFieldName

protected String getDisplayFieldName(Field field,
                                     Property prop)

Description copied from class: ForeignKeyUIDefinition

Note: can return null, in that case the default display field name is used

Overrides:

getDisplayFieldName in class ForeignKeyUIDefinition

getFieldProperties

public String getFieldProperties(Field field)

Description copied from class: UIDefinition

Computes properties to initialize and set the field in a Smartclient form. This can be the default value or the sets of values in the valuemap. NOTE: the field parameter may be null, implementors of subclasses should take this into account.

Overrides:

getFieldProperties in class UIDefinition

Parameters:

field - the field for which the information should be computed. NOTE: the caller is allowed to pass null for cases where the field properties are needed for a FormItem which is not backed by an Openbravo field.

Returns:

a JSONObject string which is used to initialize the formitem.

getParameterProperties

public String getParameterProperties(Parameter parameter)

Overrides:

getParameterProperties in class UIDefinition

getReferencedTreeFromReference

public static ReferencedTree getReferencedTreeFromReference(Reference reference)