| dinamica.IFormatPlugin
All known Subclasses: dinamica.formatters.AltCellColor,
| IFormatPlugin | | public interface IFormatPlugin (Code) | | Interface that MUST be implemented
by custom formatters. These plugins
provide extended functionality for format masks
that start with "class:". Example:
${fld:MyColumn@class:com.formatters.MyFormatter}
The framework will load this class and then
invoke the only method defined by this Interface.
The marker can also include "parameters" passed to the
formatter class:
${fld:myColName@class:com.Myformatter(AnyParameter1,AnyParameter2)}
Creation date: 23/05/2005
(c) 2005 Martin Cordova
This code is released under the LGPL license
Dinamica Framework - http://www.martincordova.com
author:
Martin Cordova (dinamica@martincordova.com) |
| Method Summary | |
| public String | format(String colName, Recordset rs, Locale locale, String args)
Format value according to custom-made rules
Parameters:
colName - Column name of the recordset that contains the value to be formatted
Parameters:
rs - Recordset that contains the record with the valueto be formatted; current position is the record in question
Parameters:
locale - Current locale if defined in the user session - may be null
Parameters:
args - String that contains the list of "parameters", meaningwhatever text that was included after the classname surrounded by (...).Example: ${fld:myColName@class:com.Myformatter(AnyParameter1,AnyParameter2)}
It's the responsibility of the programmer to interpret this String andconvert it to an array of Strings if necessary. |
| format | | public String format(String colName, Recordset rs, Locale locale, String args) throws Throwable(Code) | | Format value according to custom-made rules
Parameters:
colName - Column name of the recordset that contains the value to be formatted
Parameters:
rs - Recordset that contains the record with the valueto be formatted; current position is the record in question
Parameters:
locale - Current locale if defined in the user session - may be null
Parameters:
args - String that contains the list of "parameters", meaningwhatever text that was included after the classname surrounded by (...).Example: ${fld:myColName@class:com.Myformatter(AnyParameter1,AnyParameter2)}
It's the responsibility of the programmer to interpret this String andconvert it to an array of Strings if necessary. String representation of the formatted value
throws:
Throwable - |
|
|