Docs For Class Channel

Channel __construct(
Application
$oApp)

Constructs a new component

Tags:

access:

public

Overridden in child classes as:

ChannelAddComponents::__construct(): Constructs new channel

ChannelMessages::__construct(): Constructs new channel

ChannelTreeView::__construct(): Constructs new channel

ChannelWizards::__construct(): Constructs new channel

Parameters:

Application

$oApp

Reference to the application

[ Top ]

void draw(
)

Displays the channel

Tags:

access:

public

[ Top ]

void expandOrCollapse(
)

Expand or Collaps the channel, toggles the current state

Tags:

access:

public

[ Top ]

Application getApp(
)

Returns the Application that this channel is associated with

Tags:

return:	A reference to the application
access:	public

[ Top ]

Channel getChannelByType(
Application
$oApp, string
$sType)

Factory method that creates a particular channel

Tags:

return:	Object
static:
access:	public

Parameters:

Application	$oApp	A reference to the application object
string	$sType	Channel type, e.g. "ChannelAddComponents"

[ Top ]

void isExpanded(
)

Returns TRUE if the channel is currently expanded (contents fully visible)

Tags:

access:

protected

[ Top ]

void printContent(
)

Prints HTML that represents the channel's contents.

This function must be overwritten by channel classes derived from this one.

Tags:

access:

public

Overridden in child classes as:

ChannelAddComponents::printContent(): Display the channel contents, a listing of all available components

ChannelMessages::printContent(): Display the channel contents, showing all available context-sensitive messages

ChannelTreeView::printContent(): Display the channel contents, a tree view of all pages and components comprising the application

ChannelWizards::printContent(): Display the channel contents, a listing all wizards

[ Top ]

void printContentBegin(
)

print HTML to prepare the output of channel contents

Tags:

access:

public

[ Top ]

void printContentEnd(
)

print HTML to finish up the output of channel contents

Tags:

access:

public

[ Top ]

void printHeader(
)

print HTML to display the Channel header

Tags:

access:

public

[ Top ]

void setCollapsed(
)

Collapse the channel, making the contents invisible, just showing the header

Tags:

access:

public

[ Top ]

void setExpanded(
)

Expand the channel, making the contents fully visible

Tags:

access:

public

[ Top ]

Class: Channel

Class Overview

Variables

Methods

Child classes:

Class Details

Class Variables

$bIsExpandedByDefault = TRUE

Tags:

$sBgColor = '#ffffff'

Tags:

$sIcon = 'nuvola/16x16/apps/kwikdisk.png'

Tags:

$sIsCollapsible = TRUE

Tags:

$sTitle = 'Channel title'

Tags:

Class Methods

constructor __construct [line 21]

Tags:

Parameters:

method draw [line 119]

Tags:

method expandOrCollapse [line 166]

Tags:

method getApp [line 30]

Tags:

method getChannelByType [line 41]

Tags:

Parameters:

method isExpanded [line 138]

Tags:

method printContent [line 133]

Tags:

method printContentBegin [line 100]

Tags:

method printContentEnd [line 110]

Tags:

method printHeader [line 60]

Tags:

method setCollapsed [line 159]

Tags:

method setExpanded [line 152]

Tags: