Contentserv PHP API

CSWidgetSidebarLayout 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
getLeftSidebar()  : CSPortalGuiSidebar
Get the left sidebar API object
getNavigator()  : CSPortalGuiNavigator
Get current navigator
getOuterBottombar()  : CSPortalGuiToolbar
Get outer bottombar API object
getOuterLayoutManager()  : CSPortalGuiLayoutManager
Get outer layout manager object
getOuterToolbar()  : CSPortalGuiToolbar
Get outer toolbar API object
getRightSidebar()  : CSPortalGuiSidebar
Get the right sidebar API object
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
setLeftSidebarVisible()  : mixed
Hide the left sidebar completely
setNavigatorVisible()  : void
Hide navigator from Widget toolbar but keep toolbar
setOuterBottombarVisible()  : void
Hide outer bottombar completely
setOuterToolbarVisible()  : void
Hide outer toolbar completely
setRightSidebarVisible()  : mixed
Hide the right sidebar completely
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 —

getLeftSidebar()

Get the left sidebar API object

public getLeftSidebar() : CSPortalGuiSidebar
Tags
access

public

Return values
CSPortalGuiSidebar —

getNavigator()

Get current navigator

public getNavigator() : CSPortalGuiNavigator
Tags
access

public

Return values
CSPortalGuiNavigator —

getOuterBottombar()

Get outer bottombar API object

public getOuterBottombar() : CSPortalGuiToolbar
Tags
access

public

Return values
CSPortalGuiToolbar —

getOuterLayoutManager()

Get outer layout manager object

public getOuterLayoutManager() : CSPortalGuiLayoutManager
Tags
access

public

Return values
CSPortalGuiLayoutManager —

getOuterToolbar()

Get outer toolbar API object

public getOuterToolbar() : CSPortalGuiToolbar
Tags
access

public

Return values
CSPortalGuiToolbar —

getRightSidebar()

Get the right sidebar API object

public getRightSidebar() : CSPortalGuiSidebar
Tags
access

public

Return values
CSPortalGuiSidebar —

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 —

setLeftSidebarVisible()

Hide the left sidebar completely

public setLeftSidebarVisible([bool $visible = true ]) : mixed
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
mixed —

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 —

setOuterBottombarVisible()

Hide outer bottombar completely

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

true for visible, false otherwise

Tags
access

public

Return values
void —

setOuterToolbarVisible()

Hide outer toolbar completely

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

true for visible, false otherwise

Tags
access

public

Return values
void —

setRightSidebarVisible()

Hide the right sidebar completely

public setRightSidebarVisible([bool $visible = true ]) : mixed
Parameters
$visible : bool = true

true for visible, false otherwise

Tags
access

public

Return values
mixed —

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