Child pages
  • Providing Converters and Validators from Plugins

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In order to build a column converter, the plugin class implementing the IClientPlugin interface (see Implement the Plugin Interface) also needs to implement the interface IColumnConverterProvider to produce ITypedColumnConverter instances in the getColumnConverters() method. See API docs.

Note

Note that IColumnConverter is considered to be deprecated, therefore in getColumnConverters() method do return an ITypedColumnConverter array.

...

  • convertFromObject()
    Converts from dataprovider value to db value

  • convertToObject()
    Converts from db value to dataprovider value

  • getToObjectType(one of TEXT, INTEGER, NUMBER, DATETIME or MEDIA)
    The dataprovider data type (so the resulting type of the convertToObject()).
    This type can be provided by using the IColumnTypes constants.

For an example of a column converter, see the NrToJodaConverter class in the example given on Providing UI Converters from Plugins page.

The All the implemented custom column converters must be returned by the getColumnConverters() method of the plugin class implementing the IColumnConverterProvider interface, will be checked by the plugin manager which will add them to the list of Servoy column convertersso that they become available within Servoy Developer.

Column Validators

In order to build a column validator, the plugin class implementing the IClientPlugin interface (see Implement the Plugin Interface) also needs to implement the interface IColumnValidatorProvider to produce IColumnValidator instances in the getColumnValidators() method. See API docs.

The validation rule of an IColumnValidator is defined in the validate() method.

An IColumnValidator can also define properties whose values will be set by the developer in UI, in the Validation tab.

The All the implemented custom column validators must be returned by the getColumnValidators() method of the plugin class implementing the IColumnValidatorProvider interface, will be checked by the plugin manager which will add them to the list of Servoy column validatorsso that they become available within Servoy Developer.

Example

This is an example of validating the size of a column of type TEXT or MEDIA. The validation rule is that the size must be lower or equal to the value given by the developer by setting the length property in the Validation tab.

...