Class YLayout

Description

  1. YLayout
renders components sequentially and vertically.



Layouts are assigned to Containers and they specify how (in terms of location, not appearance) the sub-

  1. Components
are going to be rendered on the screen.

  • version: $Id: YLayout.class.php,v 1.12 2007/09/04 20:25:22 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Layouts/YLayout.class.php (line 22)

LayoutInterface
   |
   --YLayout
Method Summary
YLayout YLayout ()
string getCSS ([string $tabs = ""])
void render (ref $container, ref $theme, [string $tabs = ""])
void setRenderDirection (string $direction)
Methods
Constructor YLayout (line 28)

The constructor.

  • access: public
YLayout YLayout ()
getCSS (line 132)

Returns any CSS code that might be needed in order for this

  1. Layout
to render properly.

  • return: The CSS code that might be needed in order for this
    1. Layout
    to render properly.
  • access: public
string getCSS ([string $tabs = ""])
  • string $tabs: tabs This is a string (normally a bunch of tabs) that will be prepended to each text line. This argument is optional but its usage is highly recommended in order to produce a nicely formatted HTML output.

Redefinition of:
LayoutInterface::getCSS()
Returns any CSS code that might be needed in order for this
  1. Layout
to render properly.
render (line 76)

Lays out and renders the given container and its components. The Layout object should arrange the

  1. Components
in a well-defined manner and then call the
  1. render()
methods of each individual component.

  • access: public
void render (ref $container, ref $theme, [string $tabs = ""])
  • ref $container: object The container to render.
  • ref $theme: object theme The Theme object to use in producing the result of this method.
  • string $tabs: tabs This is a string (normally a bunch of tabs) that will be prepended to each text line. This argument is optional but its usage is highly recommended in order to produce a nicely formatted HTML output.

Redefinition of:
LayoutInterface::render()
Lays out and renders the given container and its components. The Layout object should arrange the
  1. Components
in a well-defined manner and then call the
  1. render()
methods of each individual component.
setRenderDirection (line 49)

Set the direction of component rendering from the default of Left-Right/Top-Bottom.

Allowed values: Left-Right/Top-Bottom Top-Bottom/Left-Right Right-Left/Top-Bottom Top-Bottom/Right-Left Left-Right/Bottom-Top Bottom-Top/Left-Right Right-Left/Bottom-Top Bottom-Top/Right-Left

  • since: 8/18/06
  • access: public
void setRenderDirection (string $direction)
  • string $direction

Inherited Methods

Inherited From LayoutInterface

LayoutInterface::getCSS()
LayoutInterface::render()

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