System-Web-UI-WebControls
[ class tree: System-Web-UI-WebControls ] [ index: System-Web-UI-WebControls ] [ all elements ]

Class: LBrick

Source Location: /packages/LContainer/LBrick.php

Class Overview

TTemplateControl
   |
   --LBrick

Brick Base Class


Methods


Child classes:

LNoteBrick
Displays a brick with a little note containing a headline and a text
LDummyBrick
A fallback
LContentBrick
Displays a brick with one item from LContent
LMediaBrick
Displays a media file

Class Details

[line 25]
Brick Base Class

A brick provides functionality for displaying data of a package. Bricks have also an admin panel for setting parameters (i.e. different layouts).




[ Top ]


Class Methods


constructor __construct [line 39]

LBrick __construct( )

sets the master class for consistent layout appearance



Tags:

access:  public


Overridden in child classes as:

LNoteBrick::__construct()
adds admin snippets
LContentBrick::__construct()
Prepares core, adds admin snippets
LMediaBrick::__construct()
Adds admin snippets

[ Top ]

method addAdminSnippet [line 349]

void addAdminSnippet( $admin)

prepares a string for the admin panel



Tags:

access:  public


Parameters:

   $admin  

[ Top ]

method applyClicked [line 437]

void applyClicked( )

is invoked, when changes are applied



Tags:

access:  public


[ Top ]

method autocollectAdmin [line 312]

void autocollectAdmin( )

is opposite of autoselectAdmin



Tags:

access:  protected


[ Top ]

method autoselectAdmin [line 252]

void autoselectAdmin( )

selects admin form fields, depending on parameter name and contol id



Tags:

access:  protected


[ Top ]

method brickControl [line 385]

void brickControl( $sender, $param)

manages the commands of LBrickAdminButtons.php



Tags:

access:  public


Parameters:

   $sender  
   $param  

[ Top ]

method cancelClicked [line 463]

void cancelClicked( )

is invoked, when the admin task is cancelled



Tags:

access:  public


[ Top ]

method configureParameter [line 377]

void configureParameter( $name, $setter)

prepares parameters when for applyClicked()



Tags:

access:  public


Parameters:

   $name  
   $setter  

[ Top ]

method getAdminControls [line 59]

void getAdminControls( )



Tags:

access:  public


[ Top ]

method getAdministrationPage [line 185]

string getAdministrationPage( )



Tags:

return:  main admin page
access:  public


Overridden in child classes as:

LMediaBrick::getAdministrationPage()

[ Top ]

method getAdminTemplate [line 362]

void getAdminTemplate( )

returns all admin snippets



Tags:

access:  public


[ Top ]

method getBrickObject [line 74]

object: getBrickObject( )



Tags:

return:  brick propel data
access:  public


[ Top ]

method getCell [line 153]

LCell getCell( )



Tags:

access:  public


[ Top ]

method getDescriptiveName [line 193]

string getDescriptiveName( )



Tags:

return:  the class name
access:  public


Overridden in child classes as:

LNoteBrick::getDescriptiveName()
LDummyBrick::getDescriptiveName()
LMediaBrick::getDescriptiveName()

[ Top ]

method getHasAdministrationPage [line 177]

boolean getHasAdministrationPage( )



Tags:

return:  wheter the brick has an administration page, usually in 'packages'
access:  public


[ Top ]

method getIsVisible [line 169]

boolean getIsVisible( )



Tags:

return:  wheter the brick is visible
access:  public


[ Top ]

method getPanel [line 90]

active getPanel( )



Tags:

return:  panel
access:  public


[ Top ]

method getParameters [line 112]

TMap: getParameters( )



Tags:

return:  parameters for brick
access:  public


[ Top ]

method getShowAdminPanel [line 98]

boolean: getShowAdminPanel( )



Tags:

return:  wheter to show the admin panel or not
access:  public


[ Top ]

method getUniqueValidationGroup [line 145]

string getUniqueValidationGroup( )



Tags:

access:  public


[ Top ]

method onInit [line 201]

void onInit( $param)

Prepares controls, sets slave



Tags:

access:  public


Parameters:

   $param  

[ Top ]

method onPreRender [line 223]

void onPreRender( $param)

Prepares layout panel



Tags:

access:  public


Overridden in child classes as:

LContentBrick::onPreRender()
LMediaBrick::onPreRender()

Parameters:

   $param  

[ Top ]

method setAdminControls [line 67]

void setAdminControls( $obj)



Tags:

access:  public


Parameters:

   $obj  

[ Top ]

method setBrickObject [line 52]

void setBrickObject( object: $obj)



Tags:

access:  public


Parameters:

object:   $obj   brick propel data

[ Top ]

method setCell [line 161]

void setCell( string $value)



Tags:

access:  public


Parameters:

string   $value  

[ Top ]

method setPanel [line 82]

void setPanel( string $mode)



Tags:

access:  public


Parameters:

string   $mode   Admin|Normal which panel to show

[ Top ]

method setParameters [line 127]

void setParameters( array: $arr)



Tags:

access:  public


Parameters:

array:   $arr   sets the parameters

[ Top ]

method setUniqueValidationGroup [line 136]

void setUniqueValidationGroup( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]


Documentation generated on Sun, 25 Feb 2007 16:09:48 +0100 by phpDocumentor 1.3.1