CSToolboxGui
in package
The Toolbox Dialog
Tags
Table of Contents
- addLink() : CSToolboxGuiLink
- Adds a link to the toolbox
- getContext() : CSItemApiItem
- Retrieves the current context item
- getImageUrl() : string|null
- Gets the image url
- getTitle() : string|null
- Gets the title of the dialog
- makeHtml() : string
- Creates the complete HTML output
- setContext() : void
- Sets the context object
- setFooterHtml() : void
- Allows to set a footer text
- setHeaderHtml() : void
- Sets the header html
- setImageUrl() : void
- Sets the image url
- setTitle() : void
- Sets the title of the dialog
Methods
addLink()
Adds a link to the toolbox
public
addLink(string $sName, string $sLabel[, string|null $sLink = null ][, string|null $sIcon = null ]) : CSToolboxGuiLink
Parameters
- $sName : string
- $sLabel : string
- $sLink : string|null = null
- $sIcon : string|null = null
Tags
Return values
CSToolboxGuiLink —getContext()
Retrieves the current context item
public
getContext() : CSItemApiItem
Tags
Return values
CSItemApiItem —getImageUrl()
Gets the image url
public
getImageUrl() : string|null
Tags
Return values
string|null —getTitle()
Gets the title of the dialog
public
getTitle() : string|null
Tags
Return values
string|null —makeHtml()
Creates the complete HTML output
public
makeHtml() : string
Tags
Return values
string —setContext()
Sets the context object
public
setContext(CSItemApiItem $oItem) : void
Parameters
- $oItem : CSItemApiItem
Tags
Return values
void —setFooterHtml()
Allows to set a footer text
public
setFooterHtml(mixed $sHtml) : void
Parameters
- $sHtml : mixed
Tags
Return values
void —setHeaderHtml()
Sets the header html
public
setHeaderHtml(mixed $sHtml) : void
Parameters
- $sHtml : mixed
Tags
Return values
void —setImageUrl()
Sets the image url
public
setImageUrl(string $sImageUrl) : void
Parameters
- $sImageUrl : string
Tags
Return values
void —setTitle()
Sets the title of the dialog
public
setTitle(string $sTitle) : void
Parameters
- $sTitle : string