Docs For Class ContainerInterface

Class ContainerInterface

Description

The

Container

interface is an extension of the

Component

interface;

Containers

are capable of storing multiple sub-

Components

and when rendering Containers, all sub-

Components

will be rendered as well.

version: $Id: Container.interface.php,v 1.7 2007/09/04 20:25:21 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Container.interface.php (line 52)

ComponentInterface
   |
   --ContainerInterface

Direct descendents

Class Description

Class	Description
MenuInterface	A `Menu` is a `Container` that stores a number of MenuItem objects. The familiar add/get/remove `Container` methods can be used to manage the `MenuItems` .

MenuInterface

Menu

is a

Container

that stores a number of MenuItem objects. The familiar add/get/remove

Container

methods can be used to manage the

MenuItems

Method Summary

ref add (ref $component, string $width, string $height, integer $alignmentX, integer $alignmentY)

ref getComponent (integer $id)

integer getComponentAlignmentX (integer $id)

integer getComponentAlignmentY (integer $id)

string getComponentHeight (integer $id)

ref getComponents ()

integer getComponentsCount ()

string getComponentWidth (integer $id)

ref getLayout ()

ref remove (integer $id)

void removeAll ()

void setLayout (ref $layout)

Methods

add (line 68)

Adds the given component to this container.

return: object The component that was just added.
access: public

ref add (ref $component, string $width, string $height, integer $alignmentX, integer $alignmentY)

ref $component: object component The component to add.
string $width: width The available width for the added component. If null, will be ignored.
string $height: height The available height for the added component. If null, will be ignored.
integer $alignmentX
: alignmentX The horizontal alignment for the added component. Allowed values are
```
LEFT
```
,
```
CENTER
```
, and
```
RIGHT
```
. If null, will be ignored.
integer $alignmentY
: alignmentY The vertical alignment for the added component. Allowed values are
```
TOP
```
,
```
CENTER
```
, and
```
BOTTOM
```
. If null, will be ignored.

getComponent (line 80)

Returns the component of this container with the specified id. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: object The component.
access: public

ref getComponent (integer $id)

integer $id: id The id of the component which should be returned.

getComponentAlignmentX (line 134)

Returns the horizontal alignment for the component of this container with the specified id. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: The horizontal alignment.
access: public

integer getComponentAlignmentX (integer $id)

integer $id: id The id of the component which should be returned.

getComponentAlignmentY (line 146)

Returns the vertical alignment for the component of this container with the specified id. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: The vertical alignment.
access: public

integer getComponentAlignmentY (integer $id)

integer $id: id The id of the component which should be returned.

getComponentHeight (line 122)

Returns the height for the component of this container with the specified id. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: The height.
access: public

string getComponentHeight (integer $id)

integer $id: id The id of the component which should be returned.

getComponents (line 98)

Returns all components in this

Container

return: array An array of the components in this
```
Container
```
.
access: public

ref getComponents ()

getComponentsCount (line 89)

Returns the number of components in this container.

return: The number of components in this container.
access: public

integer getComponentsCount ()

getComponentWidth (line 110)

Returns the width for the component of this container with the specified id. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: The width.
access: public

string getComponentWidth (integer $id)

integer $id: id The id of the component which should be returned.

getLayout (line 176)

Returns the

Layout

of this container.

return: object The
```
Layout
```
of this container.
access: public

ref getLayout ()

remove (line 159)

Removes the component with the specified id from this container. Ids reflect the order in which components are added. That is, the very first component has an id of 1, the second component has an id of 2, and so forth.

return: object The component that was just removed.
access: public

ref remove (integer $id)

integer $id: id The id of the component which should be removed from this container..

removeAll (line 167)

Removes all components from this

Container

access: public

void removeAll ()

setLayout (line 185)

Sets the

Layout

of this container

access: public

void setLayout (ref $layout)

ref $layout: object layout The Layout to assign to this container.

Inherited Methods

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()

Documentation generated on Wed, 19 Sep 2007 10:22:11 -0400 by phpDocumentor 1.3.0RC3