Class LayoutInterface

Description
Description | Descendents | Methods (details)

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

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

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

Located in /harmoni/core/GUIManager/Layout.interface.php (line 14) 


	
			




	
	

		
Direct descendents

		

			Description |
			Descendents
			|															Methods (details)
							
								

		

			

				

					Class
					Description
				

								

					FlowLayout
					
											
  1. FlowLayout
    2. 

 is the most simple 
  1. Layout
    2. 

; it renders a  container by simply rendering all of the container's components. The width, height,  and alignment options of the container and its components are ignored. No special  arranging is done, and it is up to the browser or user to display the components properly.
												
				

								

					TableLayout
					
											The 
  1. TableLayout
    2. 

 renders components sequentially in rows that contain  the specifed number of columns. They are a replacement for HTML tables in that  they allow the same effect while rendering their component elements.
												
				

								

					XLayout
					
											
  1. XLayout
    2. 

 renders components sequentially and horizontally.
												
				

								

					YLayout
					
											
  1. YLayout
    2. 

 renders components sequentially and vertically.
												
				

							

		

	




	
	

		
Method Summary

		

			Description |
							Descendents |
												Methods (details)
		

		
			
			

								
				

											string
										getCSS
											([string $tabs = ""])
									

								
				

											void
										render
											(ref $container, ref $theme, [string $tabs = ""])
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
							Descendents |
																Methods (details)
						
		

		

			



	
	

		getCSS (line 42)
	
 
	
	

Returns any CSS code that might be needed in order for this 
  1. Layout
    2. 

  to render properly.

	
    
				
  • return: The CSS code that might be needed in order for this 
    1. Layout
      2. 

      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.			
    • 
				

		
		
			

		
Redefined in descendants as:

		
    
					
  • 
				FlowLayout::getCSS()
								: Returns any CSS code that might be needed in order for this 
    1. Layout
      2. 

      to render properly.
							
    • 
					
  • 
				TableLayout::getCSS()
								: Returns any CSS code that might be needed in order for this 
    1. Layout
      2. 

      to render properly.
							
    • 
					
  • 
				XLayout::getCSS()
								: Returns any CSS code that might be needed in order for this 
    1. Layout
      2. 

      to render properly.
							
    • 
					
  • 
				YLayout::getCSS()
								: Returns any CSS code that might be needed in order for this 
    1. Layout
      2. 

      to render properly.
							
    • 
				

	




	
	

		render (line 28)
	
 
	
	

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

 in a well-defined manner  and then call the 
  1. render()
    2. 

 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.			
    • 
				

		
		
			

		
Redefined in descendants as:

		
    
					
  • 
				FlowLayout::render()
								: Lays out and renders the given container and its components. The Layout  object should arrange the 
    1. Components
      2. 

     in a well-defined manner  and then call the 
    1. render()
      2. 

     methods of each individual component.
							
    • 
					
  • 
				TableLayout::render()
								: Lays out and renders the given container and its components. The Layout  object should arrange the 
    1. Components
      2. 

     in a well-defined manner  and then call the 
    1. render()
      2. 

     methods of each individual component.
							
    • 
					
  • 
				XLayout::render()
								: Lays out and renders the given container and its components. The Layout  object should arrange the 
    1. Components
      2. 

     in a well-defined manner  and then call the 
    1. render()
      2. 

     methods of each individual component.
							
    • 
					
  • 
				YLayout::render()
								: Lays out and renders the given container and its components. The Layout  object should arrange the 
    1. Components
      2. 

     in a well-defined manner  and then call the 
    1. render()
      2. 

     methods of each individual component.
							
    • 
				

	

						
		

	



	

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