TKList Class Reference
[Containers]

Represents an HTML list. More...

Inheritance diagram for TKList:

[legend]

List of all members.

Public Member Functions
	__construct ($listType=self::LIST_DEFAULT)
	Creates a new list.
Static Public Member Functions
static	createFromXML ($attrs, $contents, $node)
	INSERT BRIEF DESCRIPTION HERE.
Protected Member Functions
	renderContainer ($class, $style, $events, $id)
	INSERT BRIEF DESCRIPTION HERE.
	renderListItem ($item, $class, $style, $params)
	INSERT BRIEF DESCRIPTION HERE.
	renderListOuter ($collect, $class, $style, $events, $id)
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

Represents an HTML list.

This corresponds to an HTML list more or less directly. Each component added to this container is a list item and gets its own <li>. When creating from XML, each component directly inside the TKList tag is added to the list in order as a list item. Nothing else (except for standard events and attributes) is used in the list.

Properties:

• item_class array: CSS class for list items
• item_style array: CSS style for each list item
• list_type numeric: type of list (TKList::LIST_DEFAULT or TKList::LIST_NUMBERED)

Definition at line 18 of file TKList.php5.

---

Constructor & Destructor Documentation

TKList::__construct

(

$

listType = self::LIST_DEFAULT

)

Creates a new list.

Parameters:

$listType

[numeric]: type of list, either TKList::LIST_DEFAULT or TKList::LIST_NUMBERED

Definition at line 29 of file TKList.php5.

References TKComponent::addProperty().

---

Member Function Documentation

static TKList::createFromXML	(	$	attrs,
		$	contents,
		$	node
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$attrs	[TYPE]: DESCRIPTION
	$contents	[TYPE]: DESCRIPTION
	$node	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from TKComponent.

Definition at line 123 of file TKList.php5.

References TKContainer::$children.

TKList::renderContainer	(	$	class,
		$	style,
		$	events,
		$	id
	)			[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

	$class	[TYPE]: DESCRIPTION
	$style	[TYPE]: DESCRIPTION
	$events	[TYPE]: DESCRIPTION
	$id	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from TKContainer.

Definition at line 50 of file TKList.php5.

References TKComponent::$id, TKContainer::getChildParams(), TKContainer::getChildrenBySlot(), renderListItem(), and renderListOuter().

TKList::renderListItem	(	$	item,
		$	class,
		$	style,
		$	params
	)			[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

	$item	[TYPE]: DESCRIPTION
	$class	[TYPE]: DESCRIPTION
	$style	[TYPE]: DESCRIPTION
	$params	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 98 of file TKList.php5.

References TKComponent::$html, TKComponent::$id, TKComponent::translateClass(), and TKComponent::translateStyle().

Referenced by renderContainer().

TKList::renderListOuter	(	$	collect,
		$	class,
		$	style,
		$	events,
		$	id
	)			[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

	$collect	[TYPE]: DESCRIPTION
	$class	[TYPE]: DESCRIPTION
	$style	[TYPE]: DESCRIPTION
	$events	[TYPE]: DESCRIPTION
	$id	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 73 of file TKList.php5.

Referenced by renderContainer().

---

The documentation for this class was generated from the following file:

• tk2/containers/TKList.php5