Package org.openbravo.client.kernel.reference

Class ForeignKeyUIDefinition

java.lang.Object

org.openbravo.client.kernel.reference.UIDefinition

org.openbravo.client.kernel.reference.ForeignKeyUIDefinition

Direct Known Subclasses:

FKColorUIDefinition, FKComboUIDefinition, FKSearchUIDefinition, FKSelectorUIDefinition, FKTreeUIDefinition, IDUIDefinition

public class ForeignKeyUIDefinition
extends UIDefinition

Base class of all foreign key/reference ui definitions.

Author:

mtaal

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ForeignKeyUIDefinition()

Method Summary

Modifier and Type	Method	Description
protected String	getDisplayFieldName(Field field, Property prop)	Note: can return null, in that case the default display field name is used
String	getFilterEditorPropertiesProperty(Field field)	Returns the filterEditorProperties property set on the gridfield.
String	getFilterEditorType()
String	getFormEditorType()
String	getGridFieldProperties(Field field)	Computes properties to initialize and set the field in a Smartclient grid cell.
String	getParentType()
protected String	getSuperGridFieldName(Field field)
protected String	getSuperGridFieldProperties(Field field)
String	getTypeProperties()	Computes the properties used to define the type, this includes all the Smartclient SimpleType properties.

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

convertToClassicString, createFromClassicString, createJsonValueFromClassicValueString, establishGridConfigurationSettings, formatValueFromSQL, formatValueToSQL, getCellAlign, getDataSourceParameters, getDefaultValue, getDefaultValueFromSQLExpression, getDomainType, getFieldProperties, getFieldProperties, getFieldPropertiesFirstRecord, getFieldPropertiesWithoutCombo, getFilterEditorProperties, getGridEditorFieldProperties, getGridEditorType, getGridFieldName, getName, getParameterProperties, 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

ForeignKeyUIDefinition

public ForeignKeyUIDefinition()

Method Detail

getParentType

public String getParentType()

Overrides:

getParentType in class UIDefinition

Returns:

the Smartclient type from which this type inherits.

getFormEditorType

public String getFormEditorType()

Overrides:

getFormEditorType in class UIDefinition

Returns:

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

getFilterEditorType

public String getFilterEditorType()

Overrides:

getFilterEditorType in class UIDefinition

Returns:

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

getFilterEditorPropertiesProperty

public String getFilterEditorPropertiesProperty(Field field)

Description copied from class: UIDefinition

Returns the filterEditorProperties property set on the gridfield. Note for implementations in the subclass: field maybe null.

Overrides:

getFilterEditorPropertiesProperty in class UIDefinition

Parameters:

field - the field to generate the filter editor properties for, note it is allowed to pass null, implementors should gracefully handle this.

getGridFieldProperties

public String getGridFieldProperties(Field field)

Description copied from class: UIDefinition

Computes properties to initialize and set the field in a Smartclient grid cell. This can be the default value or the sets of values in the valuemap. Note: the result should be either empty, if not empty then it start with a comma and end without a comma, this to generate correct javascript.

Overrides:

getGridFieldProperties 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.

getDisplayFieldName

protected String getDisplayFieldName(Field field,
                                     Property prop)

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

getSuperGridFieldProperties

protected String getSuperGridFieldProperties(Field field)

getSuperGridFieldName

protected String getSuperGridFieldName(Field field)

getTypeProperties

public String getTypeProperties()

Description copied from class: UIDefinition

Computes the properties used to define the type, this includes all the Smartclient SimpleType properties.

Overrides:

getTypeProperties in class UIDefinition

Returns:

a javascript string which can be included in the javascript defining the SimpleType. The default implementation returns an empty string.