Main Page | Packages | Class Tree | Index | Help

xp.system

class Column

Object
  |
  +--xp.system.Column


class Column
extends Object

A DataGrid column object


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
cellWidth: Number
The "real" effective pixel width of a cell

public
columnIndex: Number
The index of the column in the columns collection

public
editBindings: Object
The edit row bindings array

public
editClass: Object
The class of control used to edit the cell content

public
editFormatFunction: Function
The data binding edit format function

public
editFormatter: Object
The data binding edit formatter

public
editFormatterOptions: String
The data binding edit formatter

public
editParseFunction: Function
The data binding edit parse function

public
editPath: String
The data binding path for edit

public
editStyle: Object
The style or init props to be applied to the cell editor(can inc binding info)

public
formatFunction: Function
The data binding format function

public
formatter: Object
The data binding formatter

public
formatterOptions: String
The data binding formatter

public
groupIndex: Number
The group index of the column

public
headerBindings: Object
The header row bindings array

public
headerClass: Object
The class of control used to display the header cell content

public
headerStyle: Object
The style or init props to be applied to the column header cell(can inc binding info)

public
headerTextWrap: Boolean
textWrap text in header cell

public
icon: String
The icon to be displayed in the header cell

public
iconIndex: String
The index of the image in the icon collection to be displayed

public
isEditable: Boolean
is column editable

public
isFixed: Boolean
is the column position fixed or scrolls

public
isSizable: Boolean
is the column width resizable

public
isSortable: Boolean
is the column sortable

public
itemBindings: Object
The item row bindings array

public
itemClass: Object
The class of control used to render the cell content

public
itemStyle: Object
The style or init props to be applied to the cell(can inc binding info)

public
minWidth: Number
The minimum pixel width of a cell

public
parent: Object
The grid that is host this column

public
parseFunction: Function
The data binding parse function

public
path: String
The data binding path

public
pct: Number
the pct width value fo the column *

public
px: Number
the pixel width value of the column *

public
sortOption: Number
The default sorting options

public
summaryType: String
The type of summary to be displayed

public
textWrap: Boolean
textWrap text in cell

public
title: String
use in the header

public
usedSharedFormatter: Boolean
Controls whether the item and the edit controls share the same formatter

public
validator: Object
The data binding edit validator

Property Summary

public
headerTextAlign: String (read, write)


public
textAlign: String (read, write)


public
width: String (read, write)
The preferred width of the cell (100%,100,*) i.e. relative,absolute,fill

Constructor

public
Column ( path: String, title: String, width)
Create a new instance of a column object

Method Summary

public
getColumnStyle ( type: String ): Object
return the style object for the specifed column type*

public
init ( ): Void
intialize the Column object, called when bound to a grid *

public
setCellWidth ( factor: Number, force: Boolean ): Number


public
toString ( ): String
the text value of the object *



Field Documentation

cellWidth

public var cellWidth: Number
The "real" effective pixel width of a cell

columnIndex

public var columnIndex: Number
The index of the column in the columns collection

editBindings

public var editBindings: Object
The edit row bindings array

editClass

public var editClass: Object
The class of control used to edit the cell content

editFormatFunction

public var editFormatFunction: Function
The data binding edit format function

editFormatter

public var editFormatter: Object
The data binding edit formatter

editFormatterOptions

public var editFormatterOptions: String
The data binding edit formatter

editParseFunction

public var editParseFunction: Function
The data binding edit parse function

editPath

public var editPath: String
The data binding path for edit

editStyle

public var editStyle: Object
The style or init props to be applied to the cell editor(can inc binding info)

formatFunction

public var formatFunction: Function
The data binding format function

formatter

public var formatter: Object
The data binding formatter

formatterOptions

public var formatterOptions: String
The data binding formatter

groupIndex

public var groupIndex: Number
The group index of the column

headerBindings

public var headerBindings: Object
The header row bindings array

headerClass

public var headerClass: Object
The class of control used to display the header cell content

headerStyle

public var headerStyle: Object
The style or init props to be applied to the column header cell(can inc binding info)

headerTextWrap

public var headerTextWrap: Boolean
textWrap text in header cell

icon

public var icon: String
The icon to be displayed in the header cell

iconIndex

public var iconIndex: String
The index of the image in the icon collection to be displayed

isEditable

public var isEditable: Boolean
is column editable

isFixed

public var isFixed: Boolean
is the column position fixed or scrolls

isSizable

public var isSizable: Boolean
is the column width resizable

isSortable

public var isSortable: Boolean
is the column sortable

itemBindings

public var itemBindings: Object
The item row bindings array

itemClass

public var itemClass: Object
The class of control used to render the cell content

itemStyle

public var itemStyle: Object
The style or init props to be applied to the cell(can inc binding info)

minWidth

public var minWidth: Number
The minimum pixel width of a cell

parent

public var parent: Object
The grid that is host this column

parseFunction

public var parseFunction: Function
The data binding parse function

path

public var path: String
The data binding path

pct

public var pct: Number
the pct width value fo the column *

px

public var px: Number
the pixel width value of the column *

sortOption

public var sortOption: Number
The default sorting options

summaryType

public var summaryType: String
The type of summary to be displayed

textWrap

public var textWrap: Boolean
textWrap text in cell

title

public var title: String
use in the header

usedSharedFormatter

public var usedSharedFormatter: Boolean
Controls whether the item and the edit controls share the same formatter

validator

public var validator: Object
The data binding edit validator


Property Documentation

headerTextAlign

public headerTextAlign: String (read, write)

textAlign

public textAlign: String (read, write)

width

public width: String (read, write)
The preferred width of the cell (100%,100,*) i.e. relative,absolute,fill


Constructor Documentation

Column

public function Column(path: String,
 title: String,
 width)
Create a new instance of a column object

Parameters:
path
The path or name of a field in the datasource to bind to
title
The column title
width
The column width (100%,100,*) i.e. relative,absolute,fill

Method Documentation

getColumnStyle

public function getColumnStyle(type: String): Object
return the style object for the specifed column type*

init

public function init(): Void
intialize the Column object, called when bound to a grid *

setCellWidth

public function setCellWidth(factor: Number,
 force: Boolean): Number

toString

public function toString(): String
the text value of the object *


The documentation was generated from the following file:


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