Packages:
System
System.Collections
System.Data
System.I18N
System.Util
System.Web.Services
System.Web.UI.ActiveControls
System.Web.UI.WebControls


Classes:
Common
   LAnchorForm
   LPoweredBy
CMS.Support
   LBaseBrick
   LBrick
   LCell
CMS
   LContentBrick
   LMediaBrick
   LNoteBrick
Configuration
   LCultureChooser
   LStyleSheetThemeChooser
Debug
   LDummyBrick
Graphics
   LFontgen
   LImage
   LThickboxImage
   LThickboxLink
Links
   LPopupLink
   LServiceHyperLink

Class LBrick

TTemplateControl
   |
   --LBrick

Direct Known Sub-classes:

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


Constructor Summary
public
sets the master class for consistent layout appearance

Method Summary
void
addAdminSnippet ( string $admin)
void
Invoked, when changes are applied
protected  void
Automatically collects parameter values in admin form fields.
protected  void
Automatically sets parameter values in admin form fields.
void
brickControl ( TWebControl $sender, TEventParameter $param)
Manages the commands invoked by admin buttons.
void
Invoked, when the admin task is cancelled
void
configureParameter ( string $name, string $setter)
Prepares parameters for automatic parameter handling
void
string
string
BaseObject
LCell
getCell ()
string
boolean
boolean
string
TMap
boolean
string
void
onInit ( mixed $param)
- sets slave
void
onPreRender ( mixed $param)
prepares display or admin panel
void
setAdminControls ( mixed $obj)
void
setBrickObject ( BaseObject $obj)
void
setCell ( LCell $value)
void
setPanel ( string $mode)
void
setParameters ( TMap $arr)
sets and saved brick parameters
void
setUniqueValidationGroup ( string $value)

Constructor Details

__construct

public __construct

sets the master class for consistent layout appearance


Method Details

addAdminSnippet

public void addAdminSnippet (string $admin )

Input
string$adminadmin snippet
Output
Exception

applyClicked

public void applyClicked ()

Invoked, when changes are applied

Output
Exception

autocollectAdmin

protected void autocollectAdmin ()

Automatically collects parameter values in admin form fields.

see autoselectAdmin

Output
Exception

autoselectAdmin

protected void autoselectAdmin ()

Automatically sets parameter values in admin form fields.

Depending on parameter name and control id. Currently supported control types: TTextBox, TListControl, TRepeater (with Checker)

Output
Exception

brickControl

public void brickControl (TWebControl $sender , TEventParameter $param )

Manages the commands invoked by admin buttons.

Input
TWebControl$senderevent-sending control
TEventParameter$paramcontrol parameters
Output
Exception

cancelClicked

public void cancelClicked ()

Invoked, when the admin task is cancelled

Output
Exception

configureParameter

public void configureParameter (string $name , string $setter )

Prepares parameters for automatic parameter handling

Input
string$namename of the parameter
string$settersetter method
Output
Exception

getAdminControls

public void getAdminControls ()

Output
Exception

getAdministrationPage

public string getAdministrationPage ()

Output
string administration page URL
Exception

getAdminTemplate

public string getAdminTemplate ()

Output
string all admin snippets
Exception

getBrickObject

public BaseObject getBrickObject ()

Output
BaseObject brick database record
Exception

getCell

public LCell getCell ()

Output
LCell cell in which this brick resides
Exception

getDescriptiveName

public string getDescriptiveName ()

Output
string descriptive name of the brick, default is class name
Exception

getHasAdministrationPage

public boolean getHasAdministrationPage ()

Output
boolean wheter the brick has an administration page, usually in 'packages'
Exception

getIsVisible

public boolean getIsVisible ()

Output
boolean wheter the brick is visible
Exception

getPanel

public string getPanel ()

Output
string which panel to show (Admin, Normal)
Exception

getParameters

public TMap getParameters ()

Output
TMap parameters for brick
Exception

getShowAdminPanel

public boolean getShowAdminPanel ()

Output
boolean wheter to show the admin panel
Exception

getUniqueValidationGroup

public string getUniqueValidationGroup ()

Output
string validation group
Exception

onInit

public void onInit (mixed $param )

- sets slave

  • prepares admin controls, if nedded

Input
mixed$param
Output
Exception

onPreRender

public void onPreRender (mixed $param )

prepares display or admin panel

Input
mixed$param
Output
Exception

setAdminControls

public void setAdminControls (mixed $obj )

Input
mixed$obj
Output
Exception

setBrickObject

public void setBrickObject (BaseObject $obj )

Input
BaseObject$objbrick database record
Output
Exception

setCell

public void setCell (LCell $value )

Input
LCell$valuecell in which this brick resides
Output
Exception

setPanel

public void setPanel (string $mode )

Input
string$modewhich panel to show (Admin, Normal)
Output
Exception

setParameters

public void setParameters (TMap $arr )

sets and saved brick parameters

Input
TMap$arrparameters for brick
Output
Exception

setUniqueValidationGroup

public void setUniqueValidationGroup (string $value )

Input
string$valuevalidation group
Output
Exception