Docs For Class Header

Description

Header components are identical to Block components with the only exception that their type is set to

HEADER

.

Components

are the basic units that can be displayed on the screen. The main method

render()

which renders the component on the screen.

version: $Id: Header.class.php,v 1.1 2005/11/30 19:54:11 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Components/Header.class.php (line 20)

ComponentInterface
   |
   --Component
      |
      --Header

Method Summary

Header Header (string $content, integer $index, optional 2)

Variables

Inherited Variables

Inherited from Component

Component::$_content
Component::$_id
Component::$_index
Component::$_postHTML
Component::$_preHTML
Component::$_styleCollections
Component::$_type

Methods

Constructor Header (line 39)

The constructor.

access: public

Header Header (string $content, integer $index, optional 2)

optional 2
: object StyleCollections styles,... Zero, one, or more StyleCollection objects that will be added to the newly created Component. Warning, this will result in copying the objects instead of referencing them as using
```
addStyle()
```
would do.
string $content
: content This is an arbitrary string that will be printed, whenever the user calls the
```
render()
```
method. The parameter is required.
integer $index
: index The index of this component. The index has no semantic meaning: you can think of the index as 'level' of the component. Alternatively, the index could serve as means of distinguishing between components with the same type. Most often one would use the index in conjunction with the
```
getStylesForComponentType()
```
and
```
addStyleForComponentType()
```
methods.

Inherited Methods

Inherited From Component

Component::Component()
Component::addStyle()
Component::getId()
Component::getIndex()
Component::getPostHTML()
Component::getPreHTML()
Component::getStyle()
Component::getStyles()
Component::getType()
Component::removeStyle()
Component::render()
Component::setId()
Component::setPostHTML()
Component::setPreHTML()

Inherited From ComponentInterface

ComponentInterface::addStyle()
ComponentInterface::getIndex()
ComponentInterface::getPostHTML()
ComponentInterface::getPreHTML()
ComponentInterface::getStyle()
ComponentInterface::getStyles()
ComponentInterface::getType()
ComponentInterface::removeStyle()
ComponentInterface::render()
ComponentInterface::setPostHTML()
ComponentInterface::setPreHTML()