jsx3.gui

class Matrix.ColumnFormat

->jsx3.lang.Object

->jsx3.gui.Matrix.ColumnFormat

class Matrix.ColumnFormat
extends jsx3.lang.Object

A class that defines the methods required for an object to be used by Matrix.Column instances to format cells of data.

Since:

3.2

Method Summary
abstract void	format(objDiv : HTMLElement, strCDFKey : String, objMatrix : jsx3.gui.Matrix, objMatrixColumn : jsx3.gui.Matrix.Column, intRowNumber : int, objServer : jsx3.app.Server) Formats the Matrix cell, a native DIV element.
static jsx3.gui.Matrix.ColumnFormat	getInstance(strKey : String, objColumn : jsx3.gui.Matrix.Column) Returns a column formatter for a string key.
boolean	validate() Classes that implement this interface must provide this method to allow for browser-specific or similar type 'switch'.

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Method Detail

format

abstract void format(objDiv : HTMLElement, strCDFKey : String, objMatrix : jsx3.gui.Matrix, objMatrixColumn : jsx3.gui.Matrix.Column, intRowNumber : int, objServer : jsx3.app.Server)

Formats the Matrix cell, a native DIV element.

Parameters:

objDiv – on-screen DIV element to be formatted. Note that this DIV is contained within a TD

strCDFKey – CDF record id for the record in the data model bound to the affected on-screen row

objMatrix – matrix instance

objMatrixColumn – matrix column instance

intRowNumber – row number for row containing this cell (1-based)

objServer – server instance. Useful for querying locale (for localized output)

getInstance

static jsx3.gui.Matrix.ColumnFormat getInstance(strKey : String, objColumn : jsx3.gui.Matrix.Column)

Returns a column formatter for a string key. The key may be one of the following:

@unescape –
@unescape_all –
@lookup –
@datetime[,(short|medium|long|full,format)] –
@date[,(short|medium|long|full,format)] –
@time[,(short|medium|long|full,format)] –
@number[,(integer|percent|currency,format)] –
@message,format –

Parameters:

strKey –

objColumn –

Returns:

validate

boolean validate()

Classes that implement this interface must provide this method to allow for browser-specific or similar type 'switch'. If false is returned, the formatter will not even attempt to iterate

Returns:

true if the formatter should be called to iterate and format