Class ListColumn

(line 72)

Description

Object
   |
   --Persistent
      |
      --ListColumn

Located in File: /comctrls.inc.php

ListColumn represents a column of a ListView.

Note: Currently qooxdoo (ListView uses a qooxdoo widget) does not allow "not sortable" columns, meaning all column are sortable on the client side.



Properties

Summary:
Caption Caption of the column. It defines the text that appears on to of the column.
CellRenderType The CellRenderType defines how the cells for a specific column are rendered.
Editable Defines if the cell in the column are editable.
Visible Determines if the Column is visible.
Width Width of the column.

Defined in class Persistent

NamePath Used to serialize/unserialize. It returns the full path to identify this component.
Owner Owner of the component.

property Caption (line 87)

string Caption

Caption of the column. It defines the text that appears on to of the column.

Use Caption to label the type of item that appears in the column.


property CellRenderType (line 108)

enum CellRenderType

The CellRenderType defines how the cells for a specific column are rendered.

Current possible values are creEdit and creBoolean where creEdit is default. If the column has a cell render type of creEdit the property Editable has to be true in order to be able to edit the selected cell. Note that the edited values are not transfered to the VCL for PHP framework. They are available on client side only. If creBoolean is set the cell value needs to be set to true or false. The renderer then paints a checkbox. Note that it is read-only mode only. If Editable is set to true the user may enter text rather than changed the checkbox state.


property Editable (line 122)

bool Editable

Defines if the cell in the column are editable.

Note: If CellRenderType is set to creBoolean Editable should be set to false. For the reason read the comment for CellRenderType.

Info


property Visible (line 147)

bool Visible

Determines if the Column is visible.

property Width (line 138)

mixed Width

Width of the column.

The width is not fixed and therefor can be changed be the user on the client side. The width may be specified as integer number of pixels (e.g. 100), a string representing percentage of the inner width of the Table (e.g. "25%"), or a string representing a flex width (e.g. "1*").

Info


property NamePath

Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePath

property Owner

Owner of the component.
This property is implemented in Persistent::Owner

Methods

Summary:

Defined in class Persistent

serialize Stores this object into the session.
unserialize This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Defined in class Object

__construct Constructs an object and initializes its data before the object is first used.
className Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
classParent Returns the type of the immediate ancestor of a class.

Events

Summary:

[none]

Javascript Events

Summary:

[none]

Documentation generated on Fri, 26 Dec 2008 11:44:05 +0100 by phpDocumentor 1.4.0a2