Class: ListColumn

Source Location: /comctrls.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --ListColumn

ListColumn represents a column of a ListView.

Author(s):

Inherited Variables

Class: Object

Object::$input

Inherited Methods

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::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.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 72]
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.

Tags:

see:

ListView, ListItem

[ Top ]

Class Variables

$_caption = ""

[line 74]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_cellrendertype = creEdit

[line 75]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_editable = 0

[line 76]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_visible = 1

[line 78]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_width = -1

[line 77]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method defaultCaption [line 89]

void defaultCaption(
)

[ Top ]

method defaultCellRenderType [line 110]

void defaultCellRenderType(
)

[ Top ]

method defaultEditable [line 124]

void defaultEditable(
)

[ Top ]

method defaultVisible [line 149]

void defaultVisible(
)

[ Top ]

method defaultWidth [line 140]

void defaultWidth(
)

[ Top ]

method getCaption [line 87]

string getCaption(
)

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.

[ Top ]

method getCellRenderType [line 108]

enum getCellRenderType(
)

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.

[ Top ]

method getEditable [line 122]

bool getEditable(
)

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.

Tags:

see:

ListColumn::getCellRenderType()

[ Top ]

method getVisible [line 147]

bool getVisible(
)

Determines if the Column is visible.

[ Top ]

method getWidth [line 138]

mixed getWidth(
)

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*").

Tags:

see:

ListColumn::getCellRenderType()

[ Top ]

method setCaption [line 88]

void setCaption(

$value)

Parameters:

$value

[ Top ]

method setCellRenderType [line 109]

void setCellRenderType(

$value)

Parameters:

$value

[ Top ]

method setEditable [line 123]

void setEditable(

$value)

Parameters:

$value

[ Top ]

method setVisible [line 148]

void setVisible(

$value)

Parameters:

$value

[ Top ]

method setWidth [line 139]

void setWidth(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:09 -0700 by phpDocumentor 1.4.1