CSGuiSelectionList
extends CSGuiComponent
in package
The CSGuiComponent is the root class of all CSGui classes and represents any HTML representable component
The usage of all CSGui classes is the same:
- Get an object through a call to the corresponding CSGui::create[Component]
- Configure the object by setter functions
- Output custom HTML where ever you like
- Finally call the getHtml method on the object and echo the returned html code
The CSGuiComponent delivers therefore only the makeHtml function as well as popup handler code.
Tags
Table of Contents
- $isDisabled : mixed
- $isPortal : mixed
- $MAX_LENGTH : mixed
- $popup : mixed
- $popupIDField : mixed
- $popupUrl : mixed
- __call() : mixed
- __construct() : mixed
- addAdditionalInputParams() : void
- Adds additional string to the internal input params.
- addButton() : mixed
- 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.
- addJSAPI() : void
- Preloads a js API library instead of using CS.loadAPI in the code
- addJSCode() : void
- Adds a js code snippet to the windows internal js scripts as they are used in the head or directly to the component
- 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
- addParam() : mixed
- 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
- getAdditionalParam() : mixed
- getAllFields() : array<string|int, mixed>
- The default handling to get the fields for an given record.
- getClassFieldsValue() : mixed
- The default handling to get the class fields value.
- getConfiguration() : mixed
- getController() : object
- returns the controller of this gui component
- getFieldsValue() : array<string|int, mixed>
- The default handling to get the fields value.
- getImageFieldIdForClass() : mixed
- getRecord() : mixed
- getRecordIDs() : mixed
- getRecordNumber() : mixed
- getSourceRecord() : Record
- Returns the source record of this selection list. May be null, if the selection list is used without an object context (e.g. in the CS options)
- getViewMode() : mixed
- hasConfigClass() : mixed
- hideViewModeButtons() : mixed
- isPortal() : bool
- Returns whether the component is used in the portal
- makeForwardUrl() : mixed
- makeHtml() : string
- Returns the complete HTML representation of the component
- 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
- Removes an item form the CSGuiSelectionList component This function removes only the available Popups defined in CSGuiSelectionListPopup.php.
- 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
- setAdditionalValues() : mixed
- setConfiguration() : mixed
- setController() : void
- sets the controller for the gui component
- setEditable() : mixed
- setIDs() : mixed
- setImageFields() : mixed
- setInputDialogParams() : mixed
- setListFields() : mixed
- setMovable() : mixed
- setPortalMode() : void
- Sets the component to the browsers portal
- setRootIDs() : mixed
- setShowMultipleReferences() : mixed
- setSourceRecord() : void
- Sets the source record of the selection list that this api refers to.
- setStyle() : mixed
- setThumbFields() : mixed
- setValues() : mixed
- setViewMode() : mixed
- throwError() : void
- Throws a CSException
Properties
$isDisabled
public
mixed
$isDisabled
= \false
Tags
$isPortal
public
static mixed
$isPortal
= \false
Tags
$MAX_LENGTH
public
static mixed
$MAX_LENGTH
= 70
Tags
$popup
public
mixed
$popup
Tags
$popupIDField
public
mixed
$popupIDField
Tags
$popupUrl
public
mixed
$popupUrl
Tags
Methods
__call()
public
__call(mixed $methodName, mixed $methodParams) : mixed
Parameters
- $methodName : mixed
- $methodParams : mixed
Tags
Return values
mixed —__construct()
public
__construct(mixed $aRecordClasses, mixed $jsonString[, mixed $sInputName = '' ][, mixed $additionalInputParams = '' ][, mixed $additionalParams = array() ][, mixed $oSourceRecord = null ]) : mixed
Parameters
- $aRecordClasses : mixed
- $jsonString : mixed
- $sInputName : mixed = ''
- $additionalInputParams : mixed = ''
- $additionalParams : mixed = array()
- $oSourceRecord : mixed = null
Tags
Return values
mixed —addAdditionalInputParams()
Adds additional string to the internal input params.
public
addAdditionalInputParams(mixed $string) : void
Parameters
- $string : mixed
Tags
Return values
void —addButton()
public
addButton(mixed $buttonImage, mixed $buttonJS[, mixed $buttonTooltip = '' ][, mixed $hideOnReadonly = true ]) : mixed
Parameters
- $buttonImage : mixed
- $buttonJS : mixed
- $buttonTooltip : mixed = ''
- $hideOnReadonly : mixed = true
Tags
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
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 $sCsslink) : void
Parameters
- $sCsslink : string
-
the href of the css file
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 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
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 $sHref) : void
Parameters
- $sHref : 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 —addParam()
public
addParam(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
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 —getAdditionalParam()
public
getAdditionalParam(mixed $key) : mixed
Parameters
- $key : mixed
Tags
Return values
mixed —getAllFields()
The default handling to get the fields for an given record.
public
getAllFields(mixed $oRecord[, int $iViewMode = CS_SELECTIONLIST_LIST ]) : array<string|int, mixed>
Parameters
- $oRecord : mixed
- $iViewMode : int = CS_SELECTIONLIST_LIST
Tags
Return values
array<string|int, mixed> —getClassFieldsValue()
The default handling to get the class fields value.
public
getClassFieldsValue(mixed $aFieldsValue, mixed $aFieldIds, mixed $oItem, mixed $aData[, bool $bIncludeLabel = TRUE ]) : mixed
Parameters
- $aFieldsValue : mixed
- $aFieldIds : mixed
- $oItem : mixed
- $aData : mixed
- $bIncludeLabel : bool = TRUE
Tags
Return values
mixed —getConfiguration()
public
getConfiguration() : mixed
Tags
Return values
mixed —getController()
returns the controller of this gui component
public
getController() : object
Tags
Return values
object —the controller of the gui component
getFieldsValue()
The default handling to get the fields value.
public
getFieldsValue(mixed $oRecord[, int $iViewMode = CS_SELECTIONLIST_LIST ][, bool $bIncludeLabel = TRUE ]) : array<string|int, mixed>
Parameters
- $oRecord : mixed
- $iViewMode : int = CS_SELECTIONLIST_LIST
- $bIncludeLabel : bool = TRUE
Tags
Return values
array<string|int, mixed> —getImageFieldIdForClass()
public
getImageFieldIdForClass(mixed $sClassName) : mixed
Parameters
- $sClassName : mixed
Tags
Return values
mixed —getRecord()
public
getRecord(mixed $id[, mixed $sClassName = '' ]) : mixed
Parameters
- $id : mixed
- $sClassName : mixed = ''
Tags
Return values
mixed —getRecordIDs()
public
getRecordIDs(mixed $section[, mixed $returnNegative = false ]) : mixed
Parameters
- $section : mixed
- $returnNegative : mixed = false
Tags
Return values
mixed —getRecordNumber()
public
getRecordNumber() : mixed
Tags
Return values
mixed —getSourceRecord()
Returns the source record of this selection list. May be null, if the selection list is used without an object context (e.g. in the CS options)
public
getSourceRecord() : Record
Tags
Return values
Record —Returns an instance of Record (in most cases an Item)
getViewMode()
public
getViewMode() : mixed
Tags
Return values
mixed —hasConfigClass()
public
hasConfigClass() : mixed
Tags
Return values
mixed —hideViewModeButtons()
public
hideViewModeButtons() : mixed
Tags
Return values
mixed —isPortal()
Returns whether the component is used in the portal
public
static isPortal() : bool
Tags
Return values
bool —whether the portal mode is activated
makeForwardUrl()
public
static makeForwardUrl(mixed $url[, mixed $useRequestParams = array() ]) : mixed
Parameters
- $url : mixed
- $useRequestParams : mixed = array()
Tags
Return values
mixed —makeHtml()
Returns the complete HTML representation of the component
public
makeHtml([mixed $delayedLoading = false ]) : string
May be called only once for each object in most cases.
Parameters
- $delayedLoading : mixed = false
Tags
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
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()
Removes an item form the CSGuiSelectionList component This function removes only the available Popups defined in CSGuiSelectionListPopup.php.
public
popupRemoveItem(string $label[, bool $evalCondition = true ][, array<string|int, mixed> $aNamespaces = array() ]) : void
To manipulate already existing popup items use the CSGuiSelectionListPlugin Plugin addToPopup-method.
Parameters
- $label : string
-
The same value as for CSGuiComponent::popupRemoveItem. The translated label name.
- $evalCondition : bool = true
-
This parameter is not supported on CSGuiSelectionList
- $aNamespaces : array<string|int, mixed> = array()
-
This parameter is not supported on CSGuiSelectionList
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 —setAdditionalValues()
public
setAdditionalValues(mixed $additionalValues[, mixed $sRecordClass = null ]) : mixed
Parameters
- $additionalValues : mixed
- $sRecordClass : mixed = null
Tags
Return values
mixed —setConfiguration()
public
setConfiguration(mixed $config) : mixed
Parameters
- $config : mixed
Tags
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
Tags
Return values
void —setEditable()
public
setEditable(mixed $bEditable) : mixed
Parameters
- $bEditable : mixed
Tags
Return values
mixed —setIDs()
public
setIDs(mixed $SelectedIDs[, mixed $InheritedIDs = array() ][, mixed $DeletedIDs = array() ]) : mixed
Parameters
- $SelectedIDs : mixed
- $InheritedIDs : mixed = array()
- $DeletedIDs : mixed = array()
Tags
Return values
mixed —setImageFields()
public
setImageFields(mixed $aImageFieldIds) : mixed
Parameters
- $aImageFieldIds : mixed
Tags
Return values
mixed —setInputDialogParams()
public
setInputDialogParams(mixed $paramsArray) : mixed
Parameters
- $paramsArray : mixed
Tags
Return values
mixed —setListFields()
public
setListFields(mixed $fieldsArray) : mixed
Parameters
- $fieldsArray : mixed
Tags
Return values
mixed —setMovable()
public
setMovable(mixed $bMovable) : mixed
Parameters
- $bMovable : mixed
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 —setRootIDs()
public
setRootIDs(mixed $rootIDs) : mixed
Parameters
- $rootIDs : mixed
Tags
Return values
mixed —setShowMultipleReferences()
public
setShowMultipleReferences(mixed $bShowMultipleReferences) : mixed
Parameters
- $bShowMultipleReferences : mixed
Tags
Return values
mixed —setSourceRecord()
Sets the source record of the selection list that this api refers to.
public
setSourceRecord(mixed $oSourceRecord) : void
Parameters
- $oSourceRecord : mixed
-
An object containing the source record for this selection list. This may be an instance of Record or an instance of CSItemApiItem.
Tags
Return values
void —setStyle()
public
setStyle(mixed $sStyle) : mixed
Parameters
- $sStyle : mixed
Tags
Return values
mixed —setThumbFields()
public
setThumbFields(mixed $fieldsArray) : mixed
Parameters
- $fieldsArray : mixed
Tags
Return values
mixed —setValues()
public
setValues(mixed $json) : mixed
Parameters
- $json : mixed
Tags
Return values
mixed —setViewMode()
public
setViewMode([mixed $mode = null ]) : mixed
Parameters
- $mode : mixed = null
Tags
Return values
mixed —throwError()
Throws a CSException
public
static throwError(string $sMessage, int $iCode) : void
Parameters
- $sMessage : string
- $iCode : int