Contentserv PHP API

CSGuiListPresenter extends CSGuiPresenter
in package

Core

GUI

PHP wrapper for the CONTENTSERV generic JS list presenter component.

IMPL_JQUERYEASY


    public
    mixed
    IMPL_JQUERYEASY
    = 'jqueryeasy'

PROP_ACTIVESTATE


    public
    mixed
    PROP_ACTIVESTATE
    = 'activeState'

PROP_COLUMNS


    public
    mixed
    PROP_COLUMNS
    = 'columns'

PROP_DEFICON_FOLDER


    public
    mixed
    PROP_DEFICON_FOLDER
    = 'folder'

PROP_DEFICON_PAGE


    public
    mixed
    PROP_DEFICON_PAGE
    = 'page'

PROP_DEFICONS


    public
    mixed
    PROP_DEFICONS
    = 'icons'

PROP_EMPTY_MESSAGE


    public
    mixed
    PROP_EMPTY_MESSAGE
    = 'emptyMessage'

PROP_EVAL_FIELD_ISFOLDER


    public
    mixed
    PROP_EVAL_FIELD_ISFOLDER
    = 'ISFOLDER'

PROP_EVAL_FIELD_ITEMID

Possible EVAL String variable Names (for all events)


    public
    mixed
    PROP_EVAL_FIELD_ITEMID
    = 'ITEMID'

PROP_EVAL_FIELD_ITEMIDLIST

Possible EVAL String variable Names (for all events)


    public
    mixed
    PROP_EVAL_FIELD_ITEMIDLIST
    = 'ITEMIDLIST'

PROP_EVAL_FIELD_LABEL


    public
    mixed
    PROP_EVAL_FIELD_LABEL
    = 'LABEL'

PROP_EVAL_FIELD_LISTLEVEL


    public
    mixed
    PROP_EVAL_FIELD_LISTLEVEL
    = 'LISTLEVEL'

PROP_EVAL_FIELD_PARENTID


    public
    mixed
    PROP_EVAL_FIELD_PARENTID
    = 'PARENTID'

PROP_EVAL_FIELD_RECORDCLASS


    public
    mixed
    PROP_EVAL_FIELD_RECORDCLASS
    = 'RECORDCLASS'

PROP_EVAL_FIELD_RECORDCONTEXT


    public
    mixed
    PROP_EVAL_FIELD_RECORDCONTEXT
    = 'RECORDCONTEXT'

PROP_EVAL_FIELD_SELECTED


    public
    mixed
    PROP_EVAL_FIELD_SELECTED
    = 'SELECTED'

PROP_EVENT_FN


    public
    mixed
    PROP_EVENT_FN
    = 'fn'

PROP_EVENT_SUBTYPE


    public
    mixed
    PROP_EVENT_SUBTYPE
    = 'subType'

PROP_EVENT_TYPE


    public
    mixed
    PROP_EVENT_TYPE
    = 'type'

PROP_EVENTS


    public
    mixed
    PROP_EVENTS
    = 'events'

PROP_FITCOLUMNS


    public
    mixed
    PROP_FITCOLUMNS
    = 'fitColumns'

PROP_GETLISTURL


    public
    mixed
    PROP_GETLISTURL
    = 'getlisturl'

PROP_GROUPFIELD


    public
    mixed
    PROP_GROUPFIELD
    = 'groupField'

PROP_HEIGHT


    public
    mixed
    PROP_HEIGHT
    = 'height'

PROP_IDFIELD


    public
    mixed
    PROP_IDFIELD
    = 'idfield'

PROP_IMPLEMENTATION


    public
    mixed
    PROP_IMPLEMENTATION
    = 'implementation'

PROP_LOADING_MESSAGE


    public
    mixed
    PROP_LOADING_MESSAGE
    = 'loadingMessage'

PROP_ONCLICK


    public
    mixed
    PROP_ONCLICK
    = 'onclick'

PROP_ONCTXMENU


    public
    mixed
    PROP_ONCTXMENU
    = 'oncontextmenu'

PROP_ONDBLCLICK


    public
    mixed
    PROP_ONDBLCLICK
    = 'ondblclick'

PROP_ONLOADERROR


    public
    mixed
    PROP_ONLOADERROR
    = 'onloaderror'

PROP_ONLOADSUCCESS


    public
    mixed
    PROP_ONLOADSUCCESS
    = 'onloadsuccess'

PROP_ONROWSELECT


    public
    mixed
    PROP_ONROWSELECT
    = 'onrowselect'

PROP_ONROWUNSELECT


    public
    mixed
    PROP_ONROWUNSELECT
    = 'onrowunselect'

PROP_ONSELECT


    public
    mixed
    PROP_ONSELECT
    = 'onselect'

PROP_ONUPDATE


    public
    mixed
    PROP_ONUPDATE
    = 'onupdate'

PROP_RECORDCLASS


    public
    mixed
    PROP_RECORDCLASS
    = 'recordClass'

PROP_RECORDCONTEXT


    public
    mixed
    PROP_RECORDCONTEXT
    = 'recordContext'

PROP_ROOTID


    public
    mixed
    PROP_ROOTID
    = 'rootid'

PROP_SELECTIONTYPE_CART


    public
    mixed
    PROP_SELECTIONTYPE_CART
    = 'cart'

PROP_SELECTIONTYPE_CUSTOM


    public
    mixed
    PROP_SELECTIONTYPE_CUSTOM
    = 'custom'

PROP_SHOWSELECTION


    public
    mixed
    PROP_SHOWSELECTION
    = 'showSelection'

PROP_SHOWWORKFLOWICON


    public
    mixed
    PROP_SHOWWORKFLOWICON
    = 'showWorkflowIcon'

PROP_SUBLIST_CONFIG


    public
    mixed
    PROP_SUBLIST_CONFIG
    = 'sublistconfig'

PROP_VIEWMODE


    public
    mixed
    PROP_VIEWMODE
    = 'viewmode'

PROP_WIDTH


    public
    mixed
    PROP_WIDTH
    = 'width'

VIEWMODE_CONTENT


    public
    mixed
    VIEWMODE_CONTENT
    = 'content'

VIEWMODE_DETAILS


    public
    mixed
    VIEWMODE_DETAILS
    = 'details'

VIEWMODE_GROUPED


    public
    mixed
    VIEWMODE_GROUPED
    = 'grouped'

$isDisabled


    public
        mixed
    $isDisabled
     = \false

$isPortal


    public
    static    mixed
    $isPortal
     = \false

$popup


    public
        mixed
    $popup

$popupIDField


    public
        mixed
    $popupIDField

$popupUrl


    public
        mixed
    $popupUrl

__construct()


    public
                __construct(string $sDataSourceUrl[, string $sId = '' ]) : mixed

Parameters

$sDataSourceUrl : string: The data source REST service URL to pass the ID to, e.g. "admin/rest/itemdatasource/list/Pdmarticle".
$sId : string = '': the internal ID of this component

Return values

mixed —

activateSearchListeningForWidgets()


    public
                activateSearchListeningForWidgets(mixed $sSearchType, mixed $sSubType) : mixed

Parameters

$sSearchType : mixed
$sSubType : mixed

Return values

mixed —

addClass()


    public
                addClass(mixed $sClass) : mixed

Parameters

$sClass : mixed

Return values

mixed —

addColumn()


    public
                addColumn(mixed $sFieldName[, mixed $sLabel = '' ][, mixed $iIndex = NULL ]) : mixed

Parameters

$sFieldName : mixed
$sLabel : mixed = ''
$iIndex : mixed = NULL

Return values

mixed —

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 $sCode) : void

Parameters

$sCode : string: the code of the css without any <style> elements

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 $sCsslink) : void

Parameters

$sCsslink : string: the href of the css file

Return values

void —

addEventListener()

Adds an event listener to this presenter instance.


    public
                addEventListener(string $sType, string|array<string|int, mixed> $sSubType, string $sCallbackExpression) : bool

Example: $oPresenter->addJSCode(' function reloadMyPresenter(event) { // {CSEvent} event - the current event (see CSEvent) which occurred. var sEventType = event.getType(); if (sEventType == "myEvent") { this.reload(); // 'this' - references to the own presenter, So only the created (this) presenter will be reloaded. } } ');

$oPresenter->addEventListener('myEvent', 'myEventSubType', 'reloadMyPresenter');

If you have multiple presenter, just create a unique JS function for each presenter.

$sJsOtherPresenterReloadFnName = $oOtherPresenter->getID() . 'reloadMyPresenter'; $oOtherPresenter->addJSCode(' function ' . $sJsOtherPresenterReloadFnName . '(event) { // do stuff only for $oOtherPresenter } ');

// give the callback function a unique name $oOtherPresenter->addEventListener('myEvent', 'myEventSubType', $sJsOtherPresenterReloadFnName);

Parameters

$sType : string: A event type.
$sSubType : string|array<string|int, mixed>: A event subtype
$sCallbackExpression : string: A name of the JS function which should be called. The given function must be added with addJSCode()-method previously. The given function will be called by the framework, changes the 'this' reference to the own presenter and forwards the event object to the function as first parameter.

Return values

bool —

Whenever an event was added successfully or not.

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

Return values

void —

addJSCode()

Adds a js code snippet to the windows internal js scripts as they are used in the head or directly to the component


    public
                addJSCode(string $sCode) : void

Parameters

$sCode : string: the code of the js without any <javasctipt> elements

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 $sHref) : void

Parameters

$sHref : string: the href of the js

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

Return values

void —

addOnUpdateCallback()


    public
                addOnUpdateCallback(mixed $sCallbackExpression) : mixed

Parameters

$sCallbackExpression : mixed

Return values

mixed —

enableJQuery()

Enables JQuery by loading all required libraries


    public
                enableJQuery() : void

Return values

void —

enableJQueryEasy()

Enables JQuery easy by loading all required libraries (experimental only)


    public
                enableJQueryEasy() : void

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.

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

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

Return values

mixed —

getConfig()


    public
                getConfig([mixed $sKey = NULL ][, mixed $mDefault = NULL ]) : mixed

Parameters

$sKey : mixed = NULL
$mDefault : mixed = NULL

Return values

mixed —

getController()

returns the controller of this gui component


    public
                getController() : object

Return values

object —

the controller of the gui component

getId()

Query the global presenter component's unique ID.


    public
                getId() : string

Return values

string —

The global component ID, used to uniquely identify the it within the generated scripts/HTML.

getViewModeNames()


    public
                getViewModeNames() : mixed

Return values

mixed —

getViewModes()


    public
                getViewModes() : mixed

Return values

mixed —

isPortal()

Returns whether the component is used in the portal


    public
            static    isPortal() : bool

Return values

bool —

whether the portal mode is activated

loadConfiguration()


    public
                loadConfiguration(mixed $sConfigFileName) : mixed

Parameters

$sConfigFileName : mixed

Return values

mixed —

makeForwardUrl()


    public
            static    makeForwardUrl(mixed $url[, mixed $useRequestParams = array() ]) : mixed

Parameters

$url : mixed
$useRequestParams : mixed = array()

Return values

mixed —

makeHtml()

Returns the complete HTML representation of the component


    public
                makeHtml() : string

May be called only once for each object in most cases.

Return values

string —

some html code for JS, CSS tags

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

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.

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'

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'

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.

Return values

void —

popupEnableDebugMode()


    public
                popupEnableDebugMode() : mixed

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

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

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

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

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

Return values

void —

popupMakeHtml()

Creates the final popup html code


    public
                popupMakeHtml(mixed $PopupID) : mixed

Parameters

$PopupID : mixed

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

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.

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

Return values

void —

popupSetCharset()

Sets the encoding for the popup components


    public
                popupSetCharset(mixed $charset) : string

Parameters

$charset : mixed

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

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

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&param1=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

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

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

Return values

void —

setActiveState()

Sets the initial active state (by default true).


    public
                setActiveState(bool $bActiveOrNot) : void

If set to true (default) the presenter is immediacy (ready) visible. If set to false the presenter will proceed the same steps but onLoadSuccess the designed presenter will be hidden.

Parameters

$bActiveOrNot : bool: Whenever the initial active state should be true or false

Return values

void —

setColumns()


    public
                setColumns(mixed $aColumnProps) : mixed

Parameters

$aColumnProps : mixed

Return values

mixed —

setConfig()


    public
                setConfig(mixed $sKey, mixed $mValue) : mixed

Parameters

$sKey : mixed
$mValue : mixed

Return values

mixed —

setConfigs()


    public
                setConfigs(mixed $amValues) : mixed

Parameters

$amValues : mixed

Return values

mixed —

setController()

sets the controller for the gui component


    public
                setController(object $oController) : void

Parameters

$oController : object: the controller for the gui component

Return values

void —

setDefaultIcons()


    public
                setDefaultIcons(mixed $asIconUrls) : mixed

Parameters

$asIconUrls : mixed

Return values

mixed —

setDetailViewMethod()


    public
                setDetailViewMethod(mixed $sDetailViewMethod) : mixed

Parameters

$sDetailViewMethod : mixed

Return values

mixed —

setDetailViewTemplate()


    public
                setDetailViewTemplate(mixed $sDetailViewTemplate) : mixed

Parameters

$sDetailViewTemplate : mixed

Return values

mixed —

setEmptyMessage()


    public
                setEmptyMessage(mixed $sMessage) : mixed

Parameters

$sMessage : mixed

Return values

mixed —

setHeight()


    public
                setHeight(mixed $mHeight) : mixed

Parameters

$mHeight : mixed

Return values

mixed —

setId()

Set the global presenter component's unique ID.


    public
                setId(string $sId) : CSGuiPresenter

Parameters

$sId : string: The global component ID, used to uniquely identify the it within the generated scripts/HTML.

Return values

CSGuiPresenter —

The current presenter instance.

setIdFields()


    public
                setIdFields(mixed $asIdFieldNames) : mixed

Parameters

$asIdFieldNames : mixed

Return values

mixed —

setInitialViewMode()


    public
                setInitialViewMode(mixed $sViewMode) : mixed

Parameters

$sViewMode : mixed

Return values

mixed —

setListUrl()


    public
                setListUrl(mixed $sDataSourceUrls) : mixed

Parameters

$sDataSourceUrls : mixed

Return values

mixed —

setLoadingMessage()


    public
                setLoadingMessage(mixed $sMessage) : mixed

Parameters

$sMessage : mixed

Return values

mixed —

setOnClick()


    public
                setOnClick(mixed $sJsCode) : mixed

Parameters

$sJsCode : mixed

Return values

mixed —

setOnDblClick()


    public
                setOnDblClick(mixed $sJsCode) : mixed

Parameters

$sJsCode : mixed

Return values

mixed —

setOnLoadError()


    public
                setOnLoadError(mixed $sJsCode) : mixed

Parameters

$sJsCode : mixed

Return values

mixed —

setOnLoadSuccess()


    public
                setOnLoadSuccess(mixed $sJsCode) : mixed

Parameters

$sJsCode : mixed

Return values

mixed —

setOnSelect()


    public
                setOnSelect(mixed $sJsCode) : mixed

Parameters

$sJsCode : mixed

Return values

mixed —

setPortalMode()

Sets the component to the browsers portal


    public
            static    setPortalMode([mixed $isPortal = true ]) : void

Parameters

$isPortal : mixed = true

Return values

void —

setRecordType()


    public
                setRecordType(mixed $sRecordClass[, mixed $sRecordContext = NULL ]) : mixed

Parameters

$sRecordClass : mixed
$sRecordContext : mixed = NULL

Return values

mixed —

setRootId()


    public
                setRootId(mixed $iRootId) : mixed

Parameters

$iRootId : mixed

Return values

mixed —

setSelectionVisible()


    public
                setSelectionVisible([mixed $mType = self::PROP_SELECTIONTYPE_CUSTOM ]) : mixed

Parameters

$mType : mixed = self::PROP_SELECTIONTYPE_CUSTOM

Return values

mixed —

setSubList()


    public
                setSubList(CSGuiListPresenter $oSubList) : mixed

Parameters

$oSubList : CSGuiListPresenter

Return values

mixed —

setTooltip()


    public
                setTooltip(mixed $sTooltipText[, mixed $sTooltipId = NULL ]) : mixed

Parameters

$sTooltipText : mixed
$sTooltipId : mixed = NULL

Return values

mixed —

setWidth()


    public
                setWidth(mixed $mWidth) : mixed

Parameters

$mWidth : mixed

Return values

mixed —

setWorkflowIconVisible()


    public
                setWorkflowIconVisible([mixed $bShow = FALSE ]) : mixed

Parameters

$bShow : mixed = FALSE

Return values

mixed —

throwError()

Throws a CSException


    public
            static    throwError(string $sMessage, int $iCode) : void

Parameters

$sMessage : string
$iCode : int

Return values

void —

CSGuiListPresenter extends CSGuiPresenter in package Core GUI

Tags

Table of Contents

Constants

IMPL_JQUERYEASY

Tags

PROP_ACTIVESTATE

Tags

PROP_COLUMNS

Tags

PROP_DEFICON_FOLDER

Tags

PROP_DEFICON_PAGE

Tags

PROP_DEFICONS

Tags

PROP_EMPTY_MESSAGE

Tags

PROP_EVAL_FIELD_ISFOLDER

Tags

PROP_EVAL_FIELD_ITEMID

Tags

PROP_EVAL_FIELD_ITEMIDLIST

Tags

PROP_EVAL_FIELD_LABEL

Tags

PROP_EVAL_FIELD_LISTLEVEL

Tags

PROP_EVAL_FIELD_PARENTID

Tags

PROP_EVAL_FIELD_RECORDCLASS

Tags

PROP_EVAL_FIELD_RECORDCONTEXT

Tags

PROP_EVAL_FIELD_SELECTED

Tags

PROP_EVENT_FN

Tags

PROP_EVENT_SUBTYPE

Tags

PROP_EVENT_TYPE

Tags

PROP_EVENTS

Tags

PROP_FITCOLUMNS

Tags

PROP_GETLISTURL

Tags

PROP_GROUPFIELD

Tags

PROP_HEIGHT

Tags

PROP_IDFIELD

Tags

PROP_IMPLEMENTATION

Tags

PROP_LOADING_MESSAGE

Tags

PROP_ONCLICK

Tags

PROP_ONCTXMENU

Tags

PROP_ONDBLCLICK

Tags

PROP_ONLOADERROR

Tags

PROP_ONLOADSUCCESS

Tags

PROP_ONROWSELECT

Tags

PROP_ONROWUNSELECT

Tags

PROP_ONSELECT

Tags

PROP_ONUPDATE

Tags

PROP_RECORDCLASS

Tags

PROP_RECORDCONTEXT

Tags

CSGuiListPresenter extends CSGuiPresenter
in package

Core

GUI