Main Page | Packages | Class Tree | Index | Help

xp.data

class BoolFormatter

Object
  |
  +--xp.data.BoolFormatter


class BoolFormatter
extends Object

Formats boolean values


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
falseValue: String
The false value

public
trueValue: String
The true value

public
type: String


Constructor

public
BoolFormatter ( trueValue: String, falseValue: String)
Constructor

Method Summary

public
format ( value: Object, data: Object ): Object
Converts from a raw data type to a new object

public
parse ( value: Object, data: Object ): Object
Converts from a string, or other data type, to the raw data type



Field Documentation

falseValue

public var falseValue: String
The false value

trueValue

public var trueValue: String
The true value

type

public var type: String

Constructor Documentation

BoolFormatter

public function BoolFormatter(trueValue: String,
 falseValue: String)
Constructor

Parameters:
trueValue
pattern The number pattern
falseValue

Method Documentation

format

public function format(value: Object,
 data: Object): Object
Converts from a raw data type to a new object

Converts from a raw data type to a new object.

Usage:
This method is called automatically; you don’t invoke it directly.

Parameters:
value
The raw data value to be formatted
data
If being used for DataBinding this will be the row data otherwise it will be null
Returns:
A formatted value

parse

public function parse(value: Object,
 data: Object): Object
Converts from a string, or other data type, to the raw data type

Converts from a string, or other data type, to the raw data type. This transformation should be the exact inverse transformation of IDataFormatter.format().

Usage:
This method is called automatically; you don’t invoke it directly.

Parameters:
value
The formatted value
data
If being used for DataBinding this will be the row data otherwise it will be null
Returns:
An unformatted value


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc