CSGuiDialog
extends CSGuiWindow
in package
The CSGuiDialog is a classical CONTENTSERV window with a toolbar and an inner area
The inner area can be filled with content by simple echo statements. At the end the makeHtml method creates the output. This class has no public constructor, use the factory method instead.
Tags
Table of Contents
- $additionalHead : mixed
- $ajaxReloadCompleteWindow : mixed
- $ajaxReloadParts : mixed
- $bodyAttributes : mixed
- $bodyClasses : mixed
- $charset : mixed
- $csscodes : mixed
- $csslinks : mixed
- $doctype : mixed
- $isAjaxReloadable : mixed
- $isDisabled : mixed
- $isPortal : mixed
- $jscodes : mixed
- $jslinks : mixed
- $jsprototyping : mixed
- $menubar : CSGuiMenubar
- $menubarIsVisible : mixed
- $metaData : mixed
- $popup : mixed
- $popupIDField : mixed
- $popupUrl : mixed
- $rightTitle : mixed
- $subTitleIsVisible : mixed
- $title : mixed
- $titleIsDark : mixed
- $titleIsVisible : mixed
- $toolbar : CSGuiToolbar
- $toolbarIsVisible : mixed
- $toolbarSize : mixed
- $type : mixed
- $windowTitle : mixed
- __construct() : mixed
- CSGuiDialog constructor.
- activateCompression() : mixed
- Activates GZIP-Compression for this window
- activateDragAndDropHandling() : void
- Activates drag and drop support for all browsers on this window.
- activateNotes() : mixed
- Activates the note mode for this window. If activated notes can be placed anywhere within the given target
- addBodyAttributes() : void
- Adds attributes to the body tag of the window
- addBodyClass() : void
- Adds a class to the body tag of the window
- addContent() : void
- Adds any html output to the inner area of the window
- addCSSCode() : void
- Adds a css snippet to the windows internal css code as they are used in the head Note that links to urls within the file must be relative to the forward.php
- addCSSLink() : void
- Adds a link to the windows external cascading style sheets Note that - that the admin.css is included by default - the link to the file is from the browsers point of view relative to the forward.php - that links to urls within the file are relative to the css file location.
- addFile() : void
- Includes any html or php file to the inner area of the window while executing contained php code
- addHeadHtml() : void
- Add head content
- addImportantJSCode() : void
- Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.
- addJSAPI() : void
- Preloads a js API library instead of using CS.loadAPI in the code
- addJSCode() : void
- Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.
- addJSLink() : void
- Adds a link to the windows external js scripts Note that the link to the file is from the browsers point of view relative to the forward.php
- addJSUtils() : void
- Preloads a js util library instead of using CS.loadUtils in the code
- addMeta() : void
- Adds a meta data to the windows head
- addRightTitle() : void
- Adds content to the right part of the title label below the toolbar The title is not translated.
- disableJSPrototyping() : mixed
- Due to backward compatibility CONTENTSERV uses prototyping on the javascript Object context (Object.prototype).
- enableJQuery() : void
- Enables JQuery by loading all required libraries
- enableJQueryEasy() : void
- Enables JQuery easy by loading all required libraries (experimental only)
- enableJQueryPlugin() : bool
- Enables jQuery plugin.
- enableJQueryUI() : void
- Enables JQuery UI by loading all required libraries (experimental only)
- enablePluginCalls() : mixed
- Enables / disables all calls to CSGuiComponent plugins, if it is not wanted
- getBasePath() : string
- Returns the path to be used as a base for other page links
- getController() : object
- returns the controller of this gui component
- getIEMetaCompatible() : mixed
- Get the X-UA-Compatible meta tag string with given IE version.
- getTopWindow() : CSGuiWindow
- Returns the instance of the first opened CSGuiWindow component, which had not been build using makeHtml This method offers the possibility to place scripts, ... in the windows head section
- isAjaxReloadRequest() : bool
- Returns whether this request is a ajax reload request
- isPortal() : bool
- Returns whether the component is used in the portal
- makeBody() : mixed
- makeForwardUrl() : mixed
- makeHead() : mixed
- makeHtml() : string
- Creates an html representation of the window according to the current settings
- makeHtmlBegin() : mixed
- makeHtmlEnd() : mixed
- makeJSCode() : string
- Returns a string with script-tags.
- makeOuterBody() : mixed
- makeOuterHead() : mixed
- menubarAddHandle() : void
- Adds a handle as next item in the dialogs Menubar
- menubarAddHelp() : void
- Adds a help popup menu to the dialogs Menubar
- menubarAddItem() : void
- Adds a menu entry to the dialogs Menubar
- menubarAddLink() : void
- Adds a menu to the dialogs Menubar, which represents a link
- menubarAddMenu() : void
- Adds a popup menu to the dialogs Menubar, which request a popup menu from the server if it is clicked
- menubarAddPopup() : void
- Adds a popup menu to the dialogs Menubar. If there had been already one popup defined with the same label this popup is appended to it.
- menubarAddUploadItem() : CSGuiToolbarButton
- Adds an upload button to the menubar The button is displayed on the upper border of the dialog.
- menubarIsCollapsed() : bool
- Tells if the menubar is collapsed, either by explicitly calling the setCollapsed method or by the default settings in the skin options.
- menubarRemoveAllMenus() : void
- Removes all menus from the dialogs Menubar
- menubarSetCollapsed() : mixed
- Collapses the menubar into a toolbar button with context menu
- menubarSetRightTitle() : void
- Sets an arbitrary html text on the right end of the menubar
- menubarSetUrl() : void
- Changes the url where the menubar should be loaded from when using the menubarAddMenu function.
- menubarSetVisible() : void
- Sets the visibility of the menubar
- popupAddCheckboxItem() : void
- Adds a checkbox popup item to the end of the current component's popup
- popupAddItem() : void
- Adds a popup item to the end of the current component's popup
- popupAddJavascriptFunction() : void
- Adds a Javascript method to the components Javascript which can be used to display a popup.
- popupAddSeparator() : void
- Adds a popup separator item to the end of the current component's popup
- popupAddSubMenuDefinition() : void
- Adds a definition (Icon, GroupIdentifier, GroupIndex) for a sub menu entry.
- popupEnableDebugMode() : mixed
- popupEvaluateCode() : mixed
- Provides a condition which must be true if the popup item should be available
- popupGetJavascript() : string
- Creates a javascript onContext='...' code, which can be inserted in a html component
- popupGetMultipleRequestID() : bool
- This function may be used to check whether the request is a popupRequest for multiple elements.
- popupGetRequestID() : string
- If a user request a popup the id describing the kind of request is returned here This function may also be used to check whether the request is a popupRequest.
- popupInsertItem() : void
- Adds a popup item into a specified location of the current component's popup
- popupMakeHtml() : mixed
- Creates the final popup html code
- popupRemoveAllItems() : void
- Completely removes all popup items from the component
- popupRemoveItem() : void
- Remove one items from the popup for the component
- popupRemoveItemsByNamespace() : void
- Remove multiple from the popup specified by the namespace. All items having all the passed namespaces will be removed even if they are having more than the passed.
- popupSetCharset() : string
- Sets the encoding for the popup components
- popupSetDefaultPopup() : void
- Sets the default popup for the component
- popupSetRequestID() : void
- Overwrites the id returned by popupSetRequestID
- popupSetUrl() : void
- Changes the url where the popup should be loaded from.
- popupSetVisible() : void
- Enables or disables the visiblity of the popup.
- popupUseDefaultItem() : void
- Adds a standard popup item to the end of the current component's popup
- setAjaxReloadable() : mixed
- Defines whether this window can be reloaded using ajax request to optimize performance
- setAjaxReloadCompleteWindow() : void
- Defines that the complete window contents must be reloaded If not set only the parts defined using the setAjaxReloadPart method are changed
- setAjaxReloadPart() : string
- If this window is defined ajax reloadable and a ajax reload request is passed this method can be used to change only parts of the html If no ajax part is defined the complete body ('CSGuiWindowBody') and head ('CSGuiWindowHead') is passed
- setBasePath() : void
- Defines the path to be used as a base for other page links
- setBodyAttributes() : void
- Sets the attributes in the body tag of the window
- setCharset() : void
- Overwrites the default charset of the html document (UTF-8)
- setController() : void
- sets the controller for the gui component
- setDoctype() : void
- Overwrites the default Doctype of the html document
- setFullHeight() : void
- Sets whether the html and body tag should get 100% height attributes
- setIEMetaCompatible() : void
- Overwrites the default meta http-equiv of the html document.
- setMinimizeToContent() : mixed
- Defines whether the dialog fills 100% width and 100% height or is should minized to its contents real size.
- setPortalMode() : void
- Sets the component to the browsers portal
- setPreviewImageUrl() : void
- Sets a preview image that should be displayed next to the title
- setRightTitle() : void
- Sets the right part of the title label below the toolbar The title is not translated.
- setSubTitleVisible() : void
- Sets the visibility of the the sub title line below the title By default the subtitle is visible.
- setTitle() : void
- Sets the left title label below the toolbar The title is not translated. Note that this is not the title of the window.
- setTitleDark() : void
- Gives the title a dark background, normally when later a toolbar is added etc.
- setTitleVisible() : void
- Sets the visibility of the title line below the toolbar By default this line is visible.
- setType() : void
- Changes the type of the dialog
- setUniqueID() : void
- Sets the CSUniqueID for this window
- setWindowTitle() : void
- Sets the window title as it is used in the heads title element
- throwError() : void
- Throws a CSException
- toolbarAddButton() : CSGuiToolbarButton
- Adds a button to the toolbar The button is displayed on the upper border of the dialog.
- toolbarAddCheckboxButton() : CSGuiToolbarButton
- Adds a checkbox button to the toolbar
- toolbarAddComponent() : void
- Adds an arbitrary html text with subtitle to the toolbar
- toolbarAddSeparator() : CSGuiToolbarButton
- Adds a toolbar separator
- toolbarAddTextfield() : CSGuiToolbarButton
- Adds a text input to the toolbar
- toolbarAddUploadButton() : CSGuiToolbarButton
- Adds an upload button to the toolbar The button is displayed on the upper border of the dialog.
- toolbarRemoveAllButtons() : void
- Removes all buttons from the toolbar
- toolbarRemoveButton() : void
- Removes a button from the toolbar
- toolbarSetRightTitle() : void
- Sets an arbitrary html text with subtitle on the right end of the toolbar
- toolbarSetSize() : void
- Can be set to false if the toolbar should appear in a small version
- toolbarSetVisible() : void
- Sets the visibility of the toolbar
Properties
$additionalHead
public
mixed
$additionalHead
= ""
Tags
$ajaxReloadCompleteWindow
public
mixed
$ajaxReloadCompleteWindow
= \false
Tags
$ajaxReloadParts
public
mixed
$ajaxReloadParts
= array()
Tags
$bodyAttributes
public
mixed
$bodyAttributes
= ''
Tags
$bodyClasses
public
mixed
$bodyClasses
= array()
Tags
$charset
public
mixed
$charset
Tags
$csscodes
public
mixed
$csscodes
= array()
Tags
$csslinks
public
mixed
$csslinks
= array()
Tags
$doctype
public
mixed
$doctype
Tags
$isAjaxReloadable
public
mixed
$isAjaxReloadable
= \false
Tags
$isDisabled
public
mixed
$isDisabled
= \false
Tags
$isPortal
public
static mixed
$isPortal
= \false
Tags
$jscodes
public
mixed
$jscodes
= array('before' => array(), 'after' => array(), 'important' => array())
Tags
$jslinks
public
mixed
$jslinks
= array()
Tags
$jsprototyping
public
mixed
$jsprototyping
= \true
Tags
$menubar
public
CSGuiMenubar
$menubar
Tags
$menubarIsVisible
public
mixed
$menubarIsVisible
= \true
Tags
$metaData
public
mixed
$metaData
= array()
Tags
$popup
public
mixed
$popup
Tags
$popupIDField
public
mixed
$popupIDField
Tags
$popupUrl
public
mixed
$popupUrl
Tags
$rightTitle
public
mixed
$rightTitle
= ''
Tags
$subTitleIsVisible
public
mixed
$subTitleIsVisible
= \true
Tags
$title
public
mixed
$title
Tags
$titleIsDark
public
mixed
$titleIsDark
= \FALSE
Tags
$titleIsVisible
public
mixed
$titleIsVisible
= \true
Tags
$toolbar
public
CSGuiToolbar
$toolbar
Tags
$toolbarIsVisible
public
mixed
$toolbarIsVisible
= \true
Tags
$toolbarSize
public
mixed
$toolbarSize
= \true
Tags
$type
public
mixed
$type
Tags
$windowTitle
public
mixed
$windowTitle
Tags
Methods
__construct()
CSGuiDialog constructor.
public
__construct([int $type = CSGUI_DIALOG_TYPE_WHITE_PADDING ]) : mixed
Parameters
- $type : int = CSGUI_DIALOG_TYPE_WHITE_PADDING
Tags
Return values
mixed —activateCompression()
Activates GZIP-Compression for this window
public
static activateCompression([bool $activate = true ]) : mixed
Parameters
- $activate : bool = true
-
whether the window should be compressed using gzip, or not
Tags
Return values
mixed —activateDragAndDropHandling()
Activates drag and drop support for all browsers on this window.
public
activateDragAndDropHandling() : void
If required special mouse handlers are registered.
Tags
Return values
void —activateNotes()
Activates the note mode for this window. If activated notes can be placed anywhere within the given target
public
activateNotes(mixed $mContextModules, string $contextRecord, string $contextID[, string $subContext = '' ][, float $zoom = '100' ][, string $targetElementID = '' ][, bool $autoLoad = true ]) : mixed
Parameters
- $mContextModules : mixed
-
The context module of the note as a string (for a single module) or an array in case the notes for multiple modules should be returned.
- $contextRecord : string
-
The record context the notes should be stored for
- $contextID : string
-
The context id the notes should be stored for
- $subContext : string = ''
-
An optional subcontext the notes should be stored for
- $zoom : float = '100'
-
The current zoom level in percent
- $targetElementID : string = ''
-
The ID of the element the notes should be placed relative to. If null the window is the target
- $autoLoad : bool = true
-
If true, the CSNotes.LoadNotes-JS-Method is executed to load all notes. Otherwise this method must be called by the developer
Tags
Return values
mixed —addBodyAttributes()
Adds attributes to the body tag of the window
public
addBodyAttributes(string $bodyAttributes) : void
Parameters
- $bodyAttributes : string
-
the additional attributes to be added to the body tag
Tags
Return values
void —addBodyClass()
Adds a class to the body tag of the window
public
addBodyClass(string $className) : void
Parameters
- $className : string
-
the additional classname to be added to the body tag
Tags
Return values
void —addContent()
Adds any html output to the inner area of the window
public
addContent(string $content) : void
The inner content is captured with output buffering and returned later with the makeHtml method. Alternatively it's therefore possible to echo or output content directly.
Parameters
- $content : string
-
the content to be added
Tags
Return values
void —addCSSCode()
Adds a css snippet to the windows internal css code as they are used in the head Note that links to urls within the file must be relative to the forward.php
public
addCSSCode(string $code) : void
Parameters
- $code : string
-
the code of the css without any <style> elements
Tags
Return values
void —addCSSLink()
Adds a link to the windows external cascading style sheets Note that - that the admin.css is included by default - the link to the file is from the browsers point of view relative to the forward.php - that links to urls within the file are relative to the css file location.
public
addCSSLink(string $href) : void
Parameters
- $href : string
-
the href of the css file
Tags
Return values
void —addFile()
Includes any html or php file to the inner area of the window while executing contained php code
public
addFile(string $file) : void
Parameters
- $file : string
-
the file to be added relative to the admin/forward.php
Tags
Return values
void —addHeadHtml()
Add head content
public
addHeadHtml(string $html) : void
Parameters
- $html : string
-
the content in form of HTML which should be added to the head
Tags
Return values
void —addImportantJSCode()
Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.
public
addImportantJSCode(string $sCodeSnippet) : void
The added code snippet is marked as 'important'. This code snippets are added BEFORE JavaScript code snippets added with addJSCode-method
Parameters
- $sCodeSnippet : string
-
The pure JavaScript code (without script-tags)
Tags
Return values
void —addJSAPI()
Preloads a js API library instead of using CS.loadAPI in the code
public
addJSAPI(string $api) : void
Parameters
- $api : string
-
the name of the CS API library in the ../admin/modules/[MODULE]/CS[MODULE].js directory
Tags
Return values
void —addJSCode()
Adds JavaScript code snippet to the windows internal scripts as they are used in the HEAD.
public
addJSCode(string $code[, bool $before = true ]) : void
Parameters
- $code : string
-
The code of the js without any <javasctipt> elements
- $before : bool = true
-
If set to TRUE, the given code snippet is added to the head otherwise after BODY
Tags
Return values
void —addJSLink()
Adds a link to the windows external js scripts Note that the link to the file is from the browsers point of view relative to the forward.php
public
addJSLink(string $href) : void
Parameters
- $href : string
-
the href of the js
Tags
Return values
void —addJSUtils()
Preloads a js util library instead of using CS.loadUtils in the code
public
addJSUtils(string $util) : void
Parameters
- $util : string
-
the name of the CS Util library in the ../admin/core/utils/js/ directory
Tags
Return values
void —addMeta()
Adds a meta data to the windows head
public
addMeta(string $name, string $content) : void
Parameters
- $name : string
- $content : string
Tags
Return values
void —addRightTitle()
Adds content to the right part of the title label below the toolbar The title is not translated.
public
addRightTitle(string $sTitle) : void
Parameters
- $sTitle : string
-
the title of the caption below the toolbar
Tags
Return values
void —disableJSPrototyping()
Due to backward compatibility CONTENTSERV uses prototyping on the javascript Object context (Object.prototype).
public
disableJSPrototyping() : mixed
This causes error in many scripts as the can not iterate through objects using for (var XXX in object) If no internal CS method is used which requires prototyping it can be disabled. In future version it might be disabled as standard behaviour
Tags
Return values
mixed —enableJQuery()
Enables JQuery by loading all required libraries
public
enableJQuery() : void
Tags
Return values
void —enableJQueryEasy()
Enables JQuery easy by loading all required libraries (experimental only)
public
enableJQueryEasy() : void
Tags
Return values
void —enableJQueryPlugin()
Enables jQuery plugin.
public
enableJQueryPlugin(string $sPluginName) : bool
For possible plugins see ADMIN_LOCAL/lib/javascript/jquery/plugins subfolder.
Parameters
- $sPluginName : string
-
The name of the jquery plugin (case sensitive) and without the "jquery." prefix. To load the jquery.cookie.js plugin give only "cookie" as param.
Tags
Return values
bool —Whenever the plugin path was found or not.
enableJQueryUI()
Enables JQuery UI by loading all required libraries (experimental only)
public
enableJQueryUI() : void
Tags
Return values
void —enablePluginCalls()
Enables / disables all calls to CSGuiComponent plugins, if it is not wanted
public
static enablePluginCalls([bool $enabled = false ]) : mixed
Parameters
- $enabled : bool = false
-
whether plugin calls may be used
Tags
Return values
mixed —getBasePath()
Returns the path to be used as a base for other page links
public
getBasePath() : string
Tags
Return values
string —getController()
returns the controller of this gui component
public
getController() : object
Tags
Return values
object —the controller of the gui component
getIEMetaCompatible()
Get the X-UA-Compatible meta tag string with given IE version.
public
getIEMetaCompatible(mixed $iIEVersion) : mixed
This string is used to render the window in desired mode (+ quircks mode).
Parameters
- $iIEVersion : mixed
Tags
Return values
mixed —getTopWindow()
Returns the instance of the first opened CSGuiWindow component, which had not been build using makeHtml This method offers the possibility to place scripts, ... in the windows head section
public
static getTopWindow() : CSGuiWindow
Tags
Return values
CSGuiWindow —the top CSGuiWindow in the script
isAjaxReloadRequest()
Returns whether this request is a ajax reload request
public
isAjaxReloadRequest() : bool
Tags
Return values
bool —whether a ajax reload request is passed
isPortal()
Returns whether the component is used in the portal
public
static isPortal() : bool
Tags
Return values
bool —whether the portal mode is activated
makeBody()
public
makeBody() : mixed
Tags
Return values
mixed —makeForwardUrl()
public
static makeForwardUrl(mixed $url[, mixed $useRequestParams = array() ]) : mixed
Parameters
- $url : mixed
- $useRequestParams : mixed = array()
Tags
Return values
mixed —makeHead()
public
makeHead() : mixed
Tags
Return values
mixed —makeHtml()
Creates an html representation of the window according to the current settings
public
makeHtml() : string
Tags
Return values
string —html of the window
makeHtmlBegin()
public
makeHtmlBegin() : mixed
Tags
Return values
mixed —makeHtmlEnd()
public
makeHtmlEnd() : mixed
Tags
Return values
mixed —makeJSCode()
Returns a string with script-tags.
public
makeJSCode([string $section = 'before' ]) : string
Parameters
- $section : string = 'before'
Tags
Return values
string —makeOuterBody()
public
makeOuterBody() : mixed
Tags
Return values
mixed —makeOuterHead()
public
makeOuterHead() : mixed
Tags
Return values
mixed —menubarAddHandle()
Adds a handle as next item in the dialogs Menubar
public
menubarAddHandle() : void
Tags
Return values
void —menubarAddHelp()
Adds a help popup menu to the dialogs Menubar
public
menubarAddHelp([string $module = '' ]) : void
Parameters
- $module : string = ''
-
the module for which the help should be displayed
Tags
Return values
void —menubarAddItem()
Adds a menu entry to the dialogs Menubar
public
menubarAddItem(string $label, string $javascript[, string $img = "" ][, string $menubar = 'GUI_MENU_FILE' ]) : void
Parameters
- $label : string
-
the label which is displayed in the entry
- $javascript : string
-
the javascript code which is executed when clickin on the entry
- $img : string = ""
-
the image of the popup relative to the images/popup folder
- $menubar : string = 'GUI_MENU_FILE'
-
the label which is displayed in the menu
Tags
Return values
void —menubarAddLink()
Adds a menu to the dialogs Menubar, which represents a link
public
menubarAddLink(string $label[, string $href = '#' ][, string $target = '' ][, string $onClick = '' ][, string $accesskey = '' ]) : void
Parameters
- $label : string
-
the label which is displayed in the menu
- $href : string = '#'
-
the href of the link
- $target : string = ''
-
the target frame of the link
- $onClick : string = ''
-
the javascript code which is called when clicking on the link
- $accesskey : string = ''
-
the keybord access key of the menu
Tags
Return values
void —menubarAddMenu()
Adds a popup menu to the dialogs Menubar, which request a popup menu from the server if it is clicked
public
menubarAddMenu(string $id, string $label[, string $src = '' ][, string $accesskey = '' ]) : void
Parameters
- $id : string
-
the id which is added to the popup request
- $label : string
-
the label which is displayed in the menu
- $src : string = ''
-
the url where the popup is requested from. If it is not set the url definied with the menubarSetUrl method is taken.
- $accesskey : string = ''
-
the keybord access key of the menu
Tags
Return values
void —menubarAddPopup()
Adds a popup menu to the dialogs Menubar. If there had been already one popup defined with the same label this popup is appended to it.
public
menubarAddPopup(string $label[, CSGuiComponent $popup = null ][, string $accesskey = '' ]) : void
Parameters
- $label : string
-
the label which is displayed in the menu.
- $popup : CSGuiComponent = null
-
the CSGuiComponent which contains the Popup or null if it is the popup defined in the dialog
- $accesskey : string = ''
-
the keybord access key of the menu
Tags
Return values
void —menubarAddUploadItem()
Adds an upload button to the menubar The button is displayed on the upper border of the dialog.
public
menubarAddUploadItem(string $title, string $onUpload[, string $image = '' ][, array<string|int, mixed> $allowedFileTypes = array() ]) : CSGuiToolbarButton
Parameters
- $title : string
-
the label of the button
- $onUpload : string
-
the javascript to execute where the javascript variable 'filePath' contains the path to the uploaded file
- $image : string = ''
-
the image file relative to the admin/images/toolbar directory
- $allowedFileTypes : array<string|int, mixed> = array()
-
the filetypes which may be uploaded
Tags
Return values
CSGuiToolbarButton —menubarIsCollapsed()
Tells if the menubar is collapsed, either by explicitly calling the setCollapsed method or by the default settings in the skin options.
public
menubarIsCollapsed() : bool
Tags
Return values
bool —true if collapsed, false otherwise
menubarRemoveAllMenus()
Removes all menus from the dialogs Menubar
public
menubarRemoveAllMenus() : void
Tags
Return values
void —menubarSetCollapsed()
Collapses the menubar into a toolbar button with context menu
public
menubarSetCollapsed([bool $boolean = true ]) : mixed
Parameters
- $boolean : bool = true
Tags
Return values
mixed —menubarSetRightTitle()
Sets an arbitrary html text on the right end of the menubar
public
menubarSetRightTitle(string $title[, string $tooltip = '' ]) : void
Parameters
- $title : string
-
the text in the menubar
- $tooltip : string = ''
-
the tooltip of the title text in the menubar
Tags
Return values
void —menubarSetUrl()
Changes the url where the menubar should be loaded from when using the menubarAddMenu function.
public
menubarSetUrl([string $menubarUrl = '' ]) : void
It can be set if the pure forward name is not sufficient or another file should be used for a popup request This is an important option to add additional GET parameters, which should be available again for popups You can add additionalParameters to the forward url using the & seperator, e.g 'destination.php¶m1=true'
Parameters
- $menubarUrl : string = ''
-
the url where the menubar popups are defined
Tags
Return values
void —menubarSetVisible()
Sets the visibility of the menubar
public
menubarSetVisible(bool $boolean) : void
By default the menubar is visible but can be hidden with this method.
Parameters
- $boolean : bool
-
whether to show the menubar or not
Tags
Return values
void —popupAddCheckboxItem()
Adds a checkbox popup item to the end of the current component's popup
public
popupAddCheckboxItem(mixed $sLabel, mixed $sJavascript[, mixed $bIsEnabled = true ][, mixed $bIsSelected = false ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void
Parameters
- $sLabel : mixed
- $sJavascript : mixed
- $bIsEnabled : mixed = true
- $bIsSelected : mixed = false
- $sAccessKey : mixed = ''
- $bEvalCondition : mixed = true
- $mNamespaces : mixed = array()
- $sGroupIdentifier : mixed = ''
- $iGroupIndex : mixed
Tags
Return values
void —popupAddItem()
Adds a popup item to the end of the current component's popup
public
popupAddItem(string $sLabel[, string $sJavascript = '' ][, int $bIsEnabled = true ][, string $sIconPath = '' ][, string $sAccessKey = '' ][, bool $bEvalCondition = true ][, array<string|int, mixed>|string $mNamespaces = array() ][, string $sGroupIdentifier = '' ], int $iGroupIndex) : void
Parameters
- $sLabel : string
-
label of the popup item. It can use '//' to create a submenu, e.g. 'submenu_label//sub_submenu_label//label'
- $sJavascript : string = ''
-
Javascript code to call with the popup item
- $bIsEnabled : int = true
-
can be false if the popup item should be visible but disabled
- $sIconPath : string = ''
-
Image of the item relative to the admin/images/popup/ directory
- $sAccessKey : string = ''
-
Keyboard access key of the popup item
- $bEvalCondition : bool = true
-
If the condition should be evaluated.
- $mNamespaces : array<string|int, mixed>|string = array()
-
The namespace for the button like "workflow"
- $sGroupIdentifier : string = ''
-
The identifier to add the popup item to a group, which has separator at the beginning and at the end.
- $iGroupIndex : int
-
The index of the group. The index will be used to order the groups. The lowest index will be taken of all popup items inside of a group.
Tags
Return values
void —popupAddJavascriptFunction()
Adds a Javascript method to the components Javascript which can be used to display a popup.
public
popupAddJavascriptFunction([string $jsName = 'displayComponentPopup' ]) : void
It can be called with the given name and the requested POPUPID and event (event object) as argument, e.g. displayComponentPopup(ID, event)
Parameters
- $jsName : string = 'displayComponentPopup'
-
the name of the Javascript method, if it should be different from the standard 'displayComponentPopup'
Tags
Return values
void —popupAddSeparator()
Adds a popup separator item to the end of the current component's popup
public
popupAddSeparator([string $evalCondition = true ][, string $subMenu = '' ]) : void
Parameters
- $evalCondition : string = true
-
optional php condition to be evaluated as true to let the popup item be available
- $subMenu : string = ''
-
optional sub menu the separator should be placed within. It can use '//' to add the seperator within a submenu, e.g. 'submenu_label//subsubmenu_label'
Tags
Return values
void —popupAddSubMenuDefinition()
Adds a definition (Icon, GroupIdentifier, GroupIndex) for a sub menu entry.
public
popupAddSubMenuDefinition(string $sSubMenuLabel, string $sIcon[, string $sGroupIdentifier = '' ], int $iGroupIndex) : void
Parameters
- $sSubMenuLabel : string
-
The target sub menu label
- $sIcon : string
-
THe icon of the sub menu.
- $sGroupIdentifier : string = ''
-
The group identifier
- $iGroupIndex : int
-
The index of the group.
Tags
Return values
void —popupEnableDebugMode()
public
popupEnableDebugMode() : mixed
Tags
Return values
mixed —popupEvaluateCode()
Provides a condition which must be true if the popup item should be available
public
popupEvaluateCode(mixed $evalCode) : mixed
Sometimes it is necessary to evaluate further code to define a $evalCondition. As the condition only returns one value, this can not be done there. Therefore any phpCode can be evaluated using the popupEvaluateCode method. Here e.g. conditions can be stored in variables which can be used in the $evalCondition later. {RecordID} can be used to get the id of the current selected item
Parameters
- $evalCode : mixed
Tags
Return values
mixed —popupGetJavascript()
Creates a javascript onContext='...' code, which can be inserted in a html component
public
popupGetJavascript(string $id[, string $innerHtml = "" ][, string $elementName = 'span' ][, string $embedAttribute = 'oncontextmenu' ][, string $additionalAttributes = "" ][, string $popupUrl = '' ][, string $popupIDField = '' ][, string $jsCode = '' ]) : string
Parameters
- $id : string
-
The value which will can be received using the popupGetRequestID() method
- $innerHtml : string = ""
-
The content of the optional html element is not empty. If this value is not set the $id is used instead
- $elementName : string = 'span'
-
An optional html element name which will contain the attribute
- $embedAttribute : string = 'oncontextmenu'
-
The attribute which should contain the JavaScript code
- $additionalAttributes : string = ""
-
Additional attributes which should be additionally added to the oncontext command
- $popupUrl : string = ''
-
Overwrites the standard url where the popup is defined
- $popupIDField : string = ''
-
Overwrites the standard IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified
- $jsCode : string = ''
-
The JavaScript code which should be evaluated before the contextmenu is shown
Tags
Return values
string —The JavaScript code or a complete html element which will create the popup request
popupGetMultipleRequestID()
This function may be used to check whether the request is a popupRequest for multiple elements.
public
popupGetMultipleRequestID() : bool
Tags
Return values
bool —whether a popup request for multiple items have been sent
popupGetRequestID()
If a user request a popup the id describing the kind of request is returned here This function may also be used to check whether the request is a popupRequest.
public
popupGetRequestID() : string
Tags
Return values
string —the ID for which a popup is requested
popupInsertItem()
Adds a popup item into a specified location of the current component's popup
public
popupInsertItem(mixed $mIndex, mixed $sLabel[, mixed $sJavascript = '' ][, mixed $bIsEnabled = true ][, mixed $sIconPath = '' ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void
Parameters
- $mIndex : mixed
- $sLabel : mixed
- $sJavascript : mixed = ''
- $bIsEnabled : mixed = true
- $sIconPath : mixed = ''
- $sAccessKey : mixed = ''
- $bEvalCondition : mixed = true
- $mNamespaces : mixed = array()
- $sGroupIdentifier : mixed = ''
- $iGroupIndex : mixed
Tags
Return values
void —popupMakeHtml()
Creates the final popup html code
public
popupMakeHtml(mixed $PopupID) : mixed
Parameters
- $PopupID : mixed
Tags
Return values
mixed —popupRemoveAllItems()
Completely removes all popup items from the component
public
popupRemoveAllItems([array<string|int, mixed> $keep = array() ][, bool $recursive = false ]) : void
Parameters
- $keep : array<string|int, mixed> = array()
-
the labels of the items which may be kept
- $recursive : bool = false
-
whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees
Tags
Return values
void —popupRemoveItem()
Remove one items from the popup for the component
public
popupRemoveItem(string $label[, string|bool $evalCondition = true ][, array<string|int, mixed>|string $aNamespaces = array() ]) : void
Parameters
- $label : string
-
label of the popup item
- $evalCondition : string|bool = true
-
optional php condition to be evaluated as true to let the popup item be available {RecordID} can be used to get the id of the current selected item
- $aNamespaces : array<string|int, mixed>|string = array()
-
Either a simple string for a namespace like "workflow" or an array for further specification like array("Workflow", "123"). All items having the same label and all namespaces passed set (even if they are having more) will be removed.
Tags
Return values
void —popupRemoveItemsByNamespace()
Remove multiple from the popup specified by the namespace. All items having all the passed namespaces will be removed even if they are having more than the passed.
public
popupRemoveItemsByNamespace([array<string|int, mixed> $aNamespaces = array() ]) : void
Parameters
- $aNamespaces : array<string|int, mixed> = array()
-
An array containing all the defined namespaces for the popup items to be removed
Tags
Return values
void —popupSetCharset()
Sets the encoding for the popup components
public
popupSetCharset(mixed $charset) : string
Parameters
- $charset : mixed
Tags
Return values
string —$charset the new characterset
popupSetDefaultPopup()
Sets the default popup for the component
public
popupSetDefaultPopup(CSGuiPopup $popup) : void
Parameters
- $popup : CSGuiPopup
-
Popup object to use as popup for the component
Tags
Return values
void —popupSetRequestID()
Overwrites the id returned by popupSetRequestID
public
popupSetRequestID(string $id) : void
Parameters
- $id : string
-
the value of the id to overwrite
Tags
Return values
void —popupSetUrl()
Changes the url where the popup should be loaded from.
public
popupSetUrl([string $popupUrl = '' ][, string $idField = 'POPUP_ID' ][, bool $recursive = false ]) : void
It can be set if the pure forward name is not sufficient or another file should be used for a popup request This is an important option to add additional GET parameters, which should be available again for popups You can add additionalParameters to the forward url using the & seperator, e.g 'destination.php¶m1=true'
Parameters
- $popupUrl : string = ''
-
the url where the popup is defined
- $idField : string = 'POPUP_ID'
-
the IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified
- $recursive : bool = false
-
whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees
Tags
Return values
void —popupSetVisible()
Enables or disables the visiblity of the popup.
public
popupSetVisible([bool $visibility = null ]) : void
If a popupAddItem is called before, the popup is automatically set to visible . If you only create the popup menu when recieving the popupGetRequestID parameter you have to enable the popup menu manually. You can even hide the popup completly be setting the $visibility to false
Parameters
- $visibility : bool = null
-
whether the component has a visible popup menu
Tags
Return values
void —popupUseDefaultItem()
Adds a standard popup item to the end of the current component's popup
public
popupUseDefaultItem(string $label[, string|bool $evalCondition = true ]) : void
The popupitems defined using the popupSetDefaultPopup can be reused after popupRemoveAllItems has been called. This offers the possibility to reuse working popupitems in a userdefined popupmenu The type of popup item which should be used is defined by the $label parameter. This label represents the label of the original item
Parameters
- $label : string
-
label of the popup item
- $evalCondition : string|bool = true
-
php condition to be evaluated as true to let the popup item be available
Tags
Return values
void —setAjaxReloadable()
Defines whether this window can be reloaded using ajax request to optimize performance
public
setAjaxReloadable([bool $isAjaxReloadable = true ]) : mixed
Parameters
- $isAjaxReloadable : bool = true
-
whether this window can be ajax reloaded
Tags
Return values
mixed —setAjaxReloadCompleteWindow()
Defines that the complete window contents must be reloaded If not set only the parts defined using the setAjaxReloadPart method are changed
public
setAjaxReloadCompleteWindow([mixed $ajaxReloadCompleteWindow = true ]) : void
Parameters
- $ajaxReloadCompleteWindow : mixed = true
Tags
Return values
void —setAjaxReloadPart()
If this window is defined ajax reloadable and a ajax reload request is passed this method can be used to change only parts of the html If no ajax part is defined the complete body ('CSGuiWindowBody') and head ('CSGuiWindowHead') is passed
public
setAjaxReloadPart(string $id, string $html) : string
Parameters
- $id : string
-
the id of the html element which should be replaced
- $html : string
-
the new html code for this element. If set to the boolean false this part is never added (until resetted with true)
Tags
Return values
string —the $html
setBasePath()
Defines the path to be used as a base for other page links
public
setBasePath(string $sHref) : void
Parameters
- $sHref : string
Tags
Return values
void —setBodyAttributes()
Sets the attributes in the body tag of the window
public
setBodyAttributes(string $bodyAttributes) : void
Parameters
- $bodyAttributes : string
-
the attributes to be added to the body tag
Tags
Return values
void —setCharset()
Overwrites the default charset of the html document (UTF-8)
public
setCharset(string $charset[, bool $changeLocale = true ]) : void
The charset argument is used in the content-type meta tag in the form
Parameters
- $charset : string
-
the charset to use for the document
- $changeLocale : bool = true
-
whether the new characterset should be applied to all translations
Tags
Return values
void —setController()
sets the controller for the gui component
public
setController(object $oController) : void
Parameters
- $oController : object
-
the controller for the gui component
Tags
Return values
void —setDoctype()
Overwrites the default Doctype of the html document
public
setDoctype(string $sDocType) : void
Parameters
- $sDocType : string
-
The DOCTYPE line to use for the document
Tags
Return values
void —setFullHeight()
Sets whether the html and body tag should get 100% height attributes
public
setFullHeight([bool $fullHeight = true ]) : void
Parameters
- $fullHeight : bool = true
-
whether 100% height should be used
Tags
Return values
void —setIEMetaCompatible()
Overwrites the default meta http-equiv of the html document.
public
setIEMetaCompatible(string $sNewIEMetaCompatible) : void
Parameters
- $sNewIEMetaCompatible : string
-
The meta http-equiv line to use for the document. If set to FALSE the IE meta tag will be deactivated/removed.
Tags
Return values
void —setMinimizeToContent()
Defines whether the dialog fills 100% width and 100% height or is should minized to its contents real size.
public
setMinimizeToContent([mixed $minimizeMode = true ]) : mixed
Parameters
- $minimizeMode : mixed = true
Tags
Return values
mixed —setPortalMode()
Sets the component to the browsers portal
public
static setPortalMode([mixed $isPortal = true ]) : void
Parameters
- $isPortal : mixed = true
Tags
Return values
void —setPreviewImageUrl()
Sets a preview image that should be displayed next to the title
public
setPreviewImageUrl(string $sPreviewImageUrl) : void
Parameters
- $sPreviewImageUrl : string
-
the URL of the image
Tags
Return values
void —setRightTitle()
Sets the right part of the title label below the toolbar The title is not translated.
public
setRightTitle(string $title) : void
Parameters
- $title : string
-
the title of the caption below the toolbar
Tags
Return values
void —setSubTitleVisible()
Sets the visibility of the the sub title line below the title By default the subtitle is visible.
public
setSubTitleVisible(bool $boolean) : void
Parameters
- $boolean : bool
-
whether the sub title should be visible or not
Tags
Return values
void —setTitle()
Sets the left title label below the toolbar The title is not translated. Note that this is not the title of the window.
public
setTitle(string $title) : void
Parameters
- $title : string
-
the title of the caption below the toolbar
Tags
Return values
void —setTitleDark()
Gives the title a dark background, normally when later a toolbar is added etc.
public
setTitleDark([bool $boolean = TRUE ]) : void
Parameters
- $boolean : bool = TRUE
-
whether the title should be dark, default TRUE
Tags
Return values
void —setTitleVisible()
Sets the visibility of the title line below the toolbar By default this line is visible.
public
setTitleVisible(bool $boolean) : void
Parameters
- $boolean : bool
-
whether the title line below the toolbar should be visible or not
Tags
Return values
void —setType()
Changes the type of the dialog
public
setType([mixed $type = CSGUI_DIALOG_TYPE_WHITE_PADDING ]) : void
Parameters
- $type : mixed = CSGUI_DIALOG_TYPE_WHITE_PADDING
Tags
Return values
void —setUniqueID()
Sets the CSUniqueID for this window
public
setUniqueID([bool|string $id = true ]) : void
Parameters
- $id : bool|string = true
-
the new uniqueID either as string or as bool (false: no uniqueID is set, true: a random uniqueID is set)
Tags
Return values
void —setWindowTitle()
Sets the window title as it is used in the heads title element
public
setWindowTitle(string $title) : void
Parameters
- $title : string
-
the title to use for the document
Tags
Return values
void —throwError()
Throws a CSException
public
static throwError(string $sMessage, int $iCode) : void
Parameters
- $sMessage : string
- $iCode : int
Tags
Return values
void —toolbarAddButton()
Adds a button to the toolbar The button is displayed on the upper border of the dialog.
public
toolbarAddButton(string $image, string $title[, string $href = '#' ][, string $target = '_self' ][, string $onclick = '' ][, string $accesskey = '' ][, string $menubar = 'GUI_MENU_FILE' ][, string $additionalAttributes = '' ][, string $index = -1 ]) : CSGuiToolbarButton
Parameters
- $image : string
-
the image file relative to the admin/images/toolbar directory
- $title : string
-
the label of the button
- $href : string = '#'
-
the url to open on click
- $target : string = '_self'
-
the target of the opened url
- $onclick : string = ''
-
javascript code to be evaluated on click
- $accesskey : string = ''
-
the keybord access key of the button
- $menubar : string = 'GUI_MENU_FILE'
-
the popupmenu in the menubar the button should be displayed or '' if it should not be displayed
- $additionalAttributes : string = ''
-
additional attributes which should be added to the button
- $index : string = -1
-
either the index as a number or in the form GUI_MENU_UPDATE+1 to define the position of the toolbar button in the toolbar. If set to -1 it is appended to the end
Tags
Return values
CSGuiToolbarButton —the defined button
toolbarAddCheckboxButton()
Adds a checkbox button to the toolbar
public
toolbarAddCheckboxButton(string $image, array<string|int, mixed> $titles[, array<string|int, mixed> $hrefs = array('#') ][, array<string|int, mixed> $targets = array('_self') ][, array<string|int, mixed> $onclicks = array('') ][, bool $defaultState = true ][, string $accesskey = '' ][, string $id = '' ][, string $visibility = '' ][, string $menubar = 'GUI_MENU_FILE' ][, string $additionalAttributes = '' ][, string $groupName = '' ]) : CSGuiToolbarButton
Parameters
- $image : string
-
the images of the button relative to the admin/images/toolbar or in case of the CSGUI_TOOLBAR_TYPE_VERTICAL or CSGUI_TOOLBAR_TYPE_HORIZONTAL relative to the admin/images/popup directory
- $titles : array<string|int, mixed>
-
the text or tooltip title of the button
- $hrefs : array<string|int, mixed> = array('#')
-
the links of the button
- $targets : array<string|int, mixed> = array('_self')
-
the targets of the link of the button
- $onclicks : array<string|int, mixed> = array('')
-
javascript code to be evaluated onClick if this javascript functions return the boolean value 'false' the button toggle is canceld
- $defaultState : bool = true
-
the default state of the button (true => first state is used, false => second state is used)
- $accesskey : string = ''
-
the keybord accelerator to navigate to the button with the alt key
- $id : string = ''
-
an optional id of the toolbar if you want to use more than one toolbar at the same time
- $visibility : string = ''
-
the visibility with the form GROUP:NAME
- $menubar : string = 'GUI_MENU_FILE'
-
the popupmenu in the menubar the button should be displayed or '' if it should not be displayed
- $additionalAttributes : string = ''
-
additional attributes which should be added to the button
- $groupName : string = ''
-
a string with a group name. Only one button of a group can be active at the same time
Tags
Return values
CSGuiToolbarButton —the created button object
toolbarAddComponent()
Adds an arbitrary html text with subtitle to the toolbar
public
toolbarAddComponent(string $html[, string $title = " " ]) : void
Parameters
- $html : string
-
the text in the first line
- $title : string = " "
-
the text in the second line
Tags
Return values
void —toolbarAddSeparator()
Adds a toolbar separator
public
toolbarAddSeparator() : CSGuiToolbarButton
Tags
Return values
CSGuiToolbarButton —toolbarAddTextfield()
Adds a text input to the toolbar
public
toolbarAddTextfield(string $name, string $onsubmit[, string $title = '' ][, string $id = '' ][, string $visibility = '' ]) : CSGuiToolbarButton
Parameters
- $name : string
-
the name of the textfield
- $onsubmit : string
-
the js code which is called when pressing enter
- $title : string = ''
-
the text or tooltip title next to the textfield
- $id : string = ''
-
the id of the input
- $visibility : string = ''
-
the visibility with the form GROUP:NAME
Tags
Return values
CSGuiToolbarButton —the created button object
toolbarAddUploadButton()
Adds an upload button to the toolbar The button is displayed on the upper border of the dialog.
public
toolbarAddUploadButton(string $title, string $onUpload[, string $image = '' ][, array<string|int, mixed> $allowedFileTypes = array() ]) : CSGuiToolbarButton
Parameters
- $title : string
-
the label of the button
- $onUpload : string
-
the javascript to execute where the javascript variable 'filePath' contains the path to the uploaded file
- $image : string = ''
-
the image file relative to the admin/images/toolbar directory
- $allowedFileTypes : array<string|int, mixed> = array()
-
the filetypes which may be uploaded
Tags
Return values
CSGuiToolbarButton —toolbarRemoveAllButtons()
Removes all buttons from the toolbar
public
toolbarRemoveAllButtons() : void
Tags
Return values
void —toolbarRemoveButton()
Removes a button from the toolbar
public
toolbarRemoveButton(string $name) : void
Parameters
- $name : string
-
the name of the toolbar to remove
Tags
Return values
void —toolbarSetRightTitle()
Sets an arbitrary html text with subtitle on the right end of the toolbar
public
toolbarSetRightTitle(string $menubarTitle[, string $toolbarTitle = '' ][, mixed $tooltip = '' ]) : void
Parameters
- $menubarTitle : string
-
the text in the menubar
- $toolbarTitle : string = ''
-
the text in the toolbar
- $tooltip : mixed = ''
Tags
Return values
void —toolbarSetSize()
Can be set to false if the toolbar should appear in a small version
public
toolbarSetSize([bool $large = true ]) : void
Parameters
- $large : bool = true
-
whether to use the large or small toolbar
Tags
Return values
void —toolbarSetVisible()
Sets the visibility of the toolbar
public
toolbarSetVisible(bool $boolean) : void
By default the toolbar is visible but can be hidden with this method.
Parameters
- $boolean : bool
-
whether to show the toolbar or not