XPComponents: class xp.data.FieldCompositionFormatter

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

xp.data

class FieldCompositionFormatter

Object
  |
  +--xp.data.FieldCompositionFormatter

class FieldCompositionFormatter
extends Object

FieldCompositionFormatter
Formats data for display in data binding Format data for display by replacing elements in a format string with data from the current data item or row

Author:: ProWin Computers Ltd. - Rob Edgar

Version:: 3.0.0.000

See also:: support@epresenterplus.com

Field Summary
public	type: String


Constructor
public	FieldCompositionFormatter ( formatString: String, maxlen: Number)
	Constructor

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

public	parse ( value: Object, property: String ): Object
	This is a read only formatter at present...

Field Documentation

type

public var type: String

Constructor Documentation

FieldCompositionFormatter

public function FieldCompositionFormatter

(formatString: String,
maxlen: Number)

Constructor

Parameters:

formatString		A format string which contains replaceable elements or #REPLACEME#.
maxlen		The maximum visble length of the string required

Method Documentation

format

public function format

(value: Object,
property: String): 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
property		The name of the data field

Returns:: A formatted value

parse

public function parse