Package org.openbravo.client.kernel.reference

Class FKComboUIDefinition

java.lang.Object

org.openbravo.client.kernel.reference.UIDefinition

org.openbravo.client.kernel.reference.ForeignKeyUIDefinition

org.openbravo.client.kernel.reference.FKComboUIDefinition

public class FKComboUIDefinition
extends ForeignKeyUIDefinition

Implementation of the foreign key ui definition which uses a combo box for its input/filter types.

Author:

mtaal

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
FKComboUIDefinition()

Method Summary

Modifier and Type	Method	Description
String	getFieldProperties(Field field, boolean getValueFromSession)	Computes properties to initialize and set the field in a Smartclient form.
String	getFieldPropertiesFirstRecord(Field field, boolean getValueFromSession)
String	getFieldPropertiesWithoutCombo(Field field, boolean getValueFromSession)	It returns the same as getFieldProperties except in the case of combo UIDefinitions.
String	getFormEditorType()
String	getGridEditorFieldProperties(Field field)	Computes properties to initialize and set the field in a Smartclient grid cell when it is being edited.
String	getGridFieldProperties(Field field)	Computes properties to initialize and set the field in a Smartclient grid cell.

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

getDisplayFieldName, getFilterEditorPropertiesProperty, getFilterEditorType, getParentType, getSuperGridFieldName, getSuperGridFieldProperties, getTypeProperties

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

convertToClassicString, createFromClassicString, createJsonValueFromClassicValueString, establishGridConfigurationSettings, formatValueFromSQL, formatValueToSQL, getCellAlign, getDataSourceParameters, getDefaultValue, getDefaultValueFromSQLExpression, getDomainType, getFieldProperties, getFilterEditorProperties, 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

FKComboUIDefinition

public FKComboUIDefinition()

Method Detail

getFormEditorType

public String getFormEditorType()

Overrides:

getFormEditorType in class ForeignKeyUIDefinition

Returns:

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

getGridEditorFieldProperties

public String getGridEditorFieldProperties(Field field)

Description copied from class: UIDefinition

Computes properties to initialize and set the field in a Smartclient grid cell when it is being edited. 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:

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

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 ForeignKeyUIDefinition

Parameters:

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

Returns:

a JSONObject string which is used to initialize the formitem.

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.

getFieldPropertiesFirstRecord

public String getFieldPropertiesFirstRecord(Field field,
                                            boolean getValueFromSession)

Overrides:

getFieldPropertiesFirstRecord in class UIDefinition

getFieldPropertiesWithoutCombo

public String getFieldPropertiesWithoutCombo(Field field,
                                             boolean getValueFromSession)

Description copied from class: UIDefinition

It returns the same as getFieldProperties except in the case of combo UIDefinitions. In combo UI definitions, a call to the super will be done, but the combo computation itself will not be done (so only the default value, or the current request value, will be considered).

Overrides:

getFieldPropertiesWithoutCombo in class UIDefinition