Package org.openbravo.client.kernel.reference

Class StringUIDefinition

java.lang.Object

org.openbravo.client.kernel.reference.UIDefinition

org.openbravo.client.kernel.reference.StringUIDefinition

Direct Known Subclasses:

MaskedStringUIDefinition, PasswordUIDefinition, TextUIDefinition

public class StringUIDefinition
extends UIDefinition

Implementation of the String ui definition.

Author:

mtaal

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
StringUIDefinition()

Method Summary

Modifier and Type	Method	Description
String	getFieldProperties(Field field)	Computes properties to initialize and set the field in a Smartclient form.
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()

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

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

StringUIDefinition

public StringUIDefinition()

Method Detail

getParentType

public String getParentType()

Overrides:

getParentType in class UIDefinition

Returns:

the Smartclient type from which this type inherits.

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

getFormEditorType

public String getFormEditorType()

Overrides:

getFormEditorType in class UIDefinition

Returns:

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

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.

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.