Docs For Class UnstyledBlock

Description

This is a simple implementation of a Block component. Block components are very simple, and in reality do not differ much from the generic component.

Blocks are capable of storing an arbitrary content (string) and naturally have their type set to

BLOCK

. Unlike the generic component, the content of Blocks is required.

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: UnstyledBlock.class.php,v 1.1 2005/11/30 21:32:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Components/UnstyledBlock.class.php (line 23)

ComponentInterface
   |
   --Component
      |
      --UnstyledBlock

Method Summary

UnstyledBlock UnstyledBlock (string $content, [integer $index = 1], optional 2)

Variables

Inherited Variables

Inherited from Component

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

Methods

Constructor UnstyledBlock (line 42)

The constructor.

access: public

UnstyledBlock UnstyledBlock (string $content, [integer $index = 1], 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()