Contentserv PHP API

CSWidgetDefaultLayout extends CSWidgetLayout
in package

This class describes the default CSWidgets layout

Tags
since
5.2

Table of Contents

__construct()  : CSWidgetLayout
Constructer
addContent()  : void
set layout center content from HTML
getBottomBar()  : CSPortalGuiToolbar
Get bottom bar API object
getLayoutManager()  : CSPortalGuiLayoutManager
Get current layout manager object
getNavigator()  : CSPortalGuiNavigator
Get current navigator
getToolbar()  : CSPortalGuiToolbar
Get toolbar API object
isVisible()  : bool
Get current visiblity of Widget content
makeHtml()  : string
Create layout HTML
setBottombarVisible()  : void
Hide bottom bar completely
setNavigatorVisible()  : void
Hide navigator from Widget toolbar but keep toolbar
setSearchbarVisible()  : void
Hide searchbar.
setToolbarVisible()  : void
Hide toolbar completely
setVisible()  : void
Hide Widget content

Methods

addContent()

set layout center content from HTML

public addContent(string $content) : void
Parameters
$content : string

HTML content of Widget center

Tags
access

public

Return values
void —

getBottomBar()

Get bottom bar API object

public getBottomBar() : CSPortalGuiToolbar
Tags
access

public

Return values
CSPortalGuiToolbar —

getLayoutManager()

Get current layout manager object

public getLayoutManager() : CSPortalGuiLayoutManager
Tags
access

public

Return values
CSPortalGuiLayoutManager —

getNavigator()

Get current navigator

public getNavigator() : CSPortalGuiNavigator
Tags
access

public

Return values
CSPortalGuiNavigator —

getToolbar()

Get toolbar API object

public getToolbar() : CSPortalGuiToolbar
Tags
access

public

Return values
CSPortalGuiToolbar —

isVisible()

Get current visiblity of Widget content

public isVisible() : bool
Tags
access

public

Return values
bool —

makeHtml()

Create layout HTML

public makeHtml([string $navigationID = '' ][, string $subRequestID = '' ]) : string
Parameters
$navigationID : string = ''

current position in the Widget navigation map

$subRequestID : string = ''

if sub request this refers to the kind of sub request

Tags
access

pubic

Return values
string —

HTML output of layout

setBottombarVisible()

Hide bottom bar completely

public setBottombarVisible([bool $visible = true ]) : void
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
void —

setNavigatorVisible()

Hide navigator from Widget toolbar but keep toolbar

public setNavigatorVisible([bool $visible = true ]) : void
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
void —

setSearchbarVisible()

Hide searchbar.

public setSearchbarVisible([bool $visible = true ]) : void
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
void —

setToolbarVisible()

Hide toolbar completely

public setToolbarVisible([bool $visible = true ]) : void
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
void —

setVisible()

Hide Widget content

public setVisible([bool $visible = true ]) : void
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results