CSGui
in package
Tags
Table of Contents
- NAVIGATION_TYPE_PORTAL = 0
- Defines the available types for the global navigation.
- NAVIGATION_TYPE_UI_FRAMEWORK = 1
- TREE_SETTINGS_NODE_PREFIX_ADMINISTRATION = self::TREE_SETTINGS_NODE_PREFIX_GENERAL
- TREE_SETTINGS_NODE_PREFIX_APPCONFIG = 'AppConfig'
- TREE_SETTINGS_NODE_PREFIX_CONNECTORS_AND_MODULES = 'ConnectorsModules'
- TREE_SETTINGS_NODE_PREFIX_DATACONFIG = 'DataConfig'
- TREE_SETTINGS_NODE_PREFIX_GENERAL = 'GeneralConfig'
- Defines the id prefixes for the main nodes of the settings tree.
- TREE_SETTINGS_NODE_PREFIX_PROCESSCONFIG = 'ProcessConfig'
- TREE_SETTINGS_NODE_PREFIX_USER_MANAGEMENT = self::TREE_SETTINGS_NODE_PREFIX_GENERAL
- createApiDocumentation() : CSGuiApiDocumentation
- Creates a new CSGuiApiDocumentation
- createButtonBar() : CSGuiButtonBar
- Creates a new CSGuiButtonBar object
- createCategoryItemTree() : CSGuiCategoryItemTree
- Creates a new CSGuiCategoryItemTree
- createComboBox() : CSGuiComboBox
- Creates a new CSGuiComboBox component
- createDialog() : CSGuiDialog
- Creates a new CSGuiDialog object
- createDynamicTree() : CSGuiDynamicTree
- Creates a new CSGuiDynamicTree
- createEditor() : CSGuiEditor
- Creates a new CSGuiEditor
- createEditorDialog() : CSGuiEditorDialog
- Creates a new CSGuiEditorDialog
- createEditorTable() : CSGuiTable
- Creates a new CSGuiTable with the default editor classes set.
- createExtendedSearch() : CSGuiExtendedSearch
- Creates a new CSGuiExtendedSearch component
- createFieldsetPane() : CSGuiFieldSetPane
- Creates a new CSGuiFieldSetPane object
- createFileTree() : CSGuiFileTree
- Creates a new CSGuiFileTree
- createFilterRecordTree() : CSGuiFilterRecordTree
- Creates a new CSGuiFilterRecordTree
- createForm() : CSGuiForm
- Creates a new CSGuiForm component
- createIdmlEditor() : CSGuiIdmlEditor
- Creates a new CSGuiIdmlEditor component
- createItemComparatorTable() : CSGuiItemComparatorTable
- Creates a new CSGuiItemComparatorTable component
- createItemEditorDialog() : CSGuiItemEditorDialog
- Creates a new CSGuiItemEditorDialog
- createItemList() : CSGuiItemList
- Creates a new CSGuiItemList
- createList() : CSGuiList
- Creates a new CSGuiList
- createMenubar() : CSGuiMenubar
- Creates a new CSGuiMenubar object
- createMixedTree() : CSGuiMixedTree
- Creates a new CSGuiMixedTree
- createModalDialog() : CSGuiModalDialog
- Creates a new CSGuiModalDialog object.
- createModalEditor() : CSGuiModalEditor
- Creates a new CSGuiModalEditor object.
- createNotesControl() : CSGuiNotesControl
- Creates a new CSGuiNotesControl component
- createNotesEditor() : CSGuiNotesEditor
- Creates a new CSGuiNotesEditor component
- createNumberField() : CSGuiNumberField
- Creates a new CSGuiNumberField component
- createOverviewArea() : CSGuiOverviewArea
- Creates a new CSGuiOverviewArea An overview area is a set of tables in the main area and some links on the right border.
- createPopup() : CSGuiComponent
- Creates a new CSGuiComponent
- createRating() : CSGuiRating
- Creates a new CSGuiRating component
- createRichEditor() : CSGuiRichEditor
- Creates a new CSGuiRichEditor with given type.
- createSectionPane() : CSGuiSectionPane
- Creates a new CSGuiSectionPane object
- createSelectionList() : CSGuiSelectionList
- Creates a new CSSelectionList component
- createSimpleEditor() : CSGuiSimpleEditor
- Creates a new CSGuiSimpleEditor
- createSimpleSearch() : CSGuiSimpleSearch
- Creates a new CSGuiSimpleSearch component
- createSlidePane() : CSGuiSlidePane
- Creates a new CSGuiSlidePane object
- createSlider() : CSGuiSlider
- Creates a new CSGuiSlider component
- createSplitArea() : CSGuiSplitArea
- Creates a new CSGuiSplitArea To create the area you may specify the following types: - CSGUI_SPLITAREA_TYPE_WITH_PADDING_WHITE - the core body is white and has a padding - CSGUI_SPLITAREA_TYPE_NO_PADDING_WHITE - the core body is white and has no padding
- createStateMenu() : CSGuiStateMenu
- Creates a new State Menu
- createStaticTree() : CSGuiStaticTree
- Creates a new CSGuiStaticTree
- createStoryTree() : CSGuiStoryTree
- Creates a new CSGuiStoryTree
- createSwitchPane() : CSGuiSwitchPane
- Creates a new CSGuiSwitchPane object
- createTabbedPane() : CSGuiTabbedPane
- Creates a new CSGuiTabbedPane object
- createTable() : CSGuiTable
- Creates a new CSGuiTable A CSGui Table is a table with rows and columns that are formatted in the typical CS style.
- createThumbList() : CSGuiThumbList
- Creates a new CSGuiThumbList
- createThumbListViewer() : CSGuiThumbListViewer
- Creates a new CSGuiThumbListViewer which creates an automatically CSGuiThumbList for given records
- createThumbTable() : CSGuiThumbTable
- Creates a new CSGuiThumbTable A CSGui Thumb Table is a table with Thumbnails organized in rows and columns
- createToolbar() : CSGuiToolbar
- Creates a new CSGuiToolbar object
- createTreePane() : CSGuiTreePane
- Creates a new CSGuiTreePane object
- createTreeRecordTree() : CSGuiTreeRecordTree
- Creates a new CSGuiTreeRecordTree
- createUpload() : CSGuiUpload
- Creates a new CSGuiUpload component.
- createUploadComponentDialog() : CSGuiUploadComponentDialog
- Creates a new CSGuiUploadComponentDialog Used for CSGuiUpload component, to show various dialogs like FileConfigDialog or ReportDialog
- createUploadConfigDialog() : CSGuiUploadFileConfigDialog
- Creates a new Dialog for CSGuiUpload component.
- createUploadDialog() : CSGuiUploadDialog
- Creates a new CSGuiUploadDialog component.
- createUploadReportDialog() : CSGuiUploadReportDialog
- Creates a new Dialog for CSGuiUpload component.
- createUserdefinedTree() : CSGuiTree
- Creates a new CSGuiTree for a userdefined tree
- createWindow() : CSGuiWindow
- Creates a new CSGuiWindow object
- csShowModalDialog() : string
- Creates JS Code that opens a new CS modal dialog.
- getJqueryPath() : string
- Return an include path to the jQuery library.
- getJqueryPluginPath() : string
- Return an include path to the jQuery plugin which is in ADMIN_LOCAL/lib/javascript/jquery/plugins subfolder.
- translatePane() : string
- Translates a pane without the sorting identifiers e.g. "001|"
- translateSection() : string
- Translates a section without the sorting identifiers e.g. "001|", "?1*1"
Constants
NAVIGATION_TYPE_PORTAL
Defines the available types for the global navigation.
public
int
NAVIGATION_TYPE_PORTAL
= 0
Tags
NAVIGATION_TYPE_UI_FRAMEWORK
public
mixed
NAVIGATION_TYPE_UI_FRAMEWORK
= 1
Tags
TREE_SETTINGS_NODE_PREFIX_ADMINISTRATION
public
mixed
TREE_SETTINGS_NODE_PREFIX_ADMINISTRATION
= self::TREE_SETTINGS_NODE_PREFIX_GENERAL
Tags
TREE_SETTINGS_NODE_PREFIX_APPCONFIG
public
mixed
TREE_SETTINGS_NODE_PREFIX_APPCONFIG
= 'AppConfig'
Tags
TREE_SETTINGS_NODE_PREFIX_CONNECTORS_AND_MODULES
public
mixed
TREE_SETTINGS_NODE_PREFIX_CONNECTORS_AND_MODULES
= 'ConnectorsModules'
Tags
TREE_SETTINGS_NODE_PREFIX_DATACONFIG
public
mixed
TREE_SETTINGS_NODE_PREFIX_DATACONFIG
= 'DataConfig'
Tags
TREE_SETTINGS_NODE_PREFIX_GENERAL
Defines the id prefixes for the main nodes of the settings tree.
public
string
TREE_SETTINGS_NODE_PREFIX_GENERAL
= 'GeneralConfig'
Tags
TREE_SETTINGS_NODE_PREFIX_PROCESSCONFIG
public
mixed
TREE_SETTINGS_NODE_PREFIX_PROCESSCONFIG
= 'ProcessConfig'
Tags
TREE_SETTINGS_NODE_PREFIX_USER_MANAGEMENT
public
mixed
TREE_SETTINGS_NODE_PREFIX_USER_MANAGEMENT
= self::TREE_SETTINGS_NODE_PREFIX_GENERAL
Tags
Methods
createApiDocumentation()
Creates a new CSGuiApiDocumentation
public
static createApiDocumentation() : CSGuiApiDocumentation
Tags
Return values
CSGuiApiDocumentation —a new CSGuiApiDocumentation
createButtonBar()
Creates a new CSGuiButtonBar object
public
static createButtonBar() : CSGuiButtonBar
Tags
Return values
CSGuiButtonBar —a new CSGuiButtonBar
createCategoryItemTree()
Creates a new CSGuiCategoryItemTree
public
static createCategoryItemTree(string|object $mItemName[, string $sHref = '' ][, string $sTarget = '' ][, string $sSqlFilter = '' ]) : CSGuiCategoryItemTree
Parameters
- $mItemName : string|object
-
The item or the name of the item type the tree should be loaded from
- $sHref : string = ''
-
The url to open onClick
- $sTarget : string = ''
-
The target of the url to open onClick
- $sSqlFilter : string = ''
-
Additional sql filter limiting the records displayed in the tree
Tags
Return values
CSGuiCategoryItemTree —a new CSGuiCategoryItemTree
createComboBox()
Creates a new CSGuiComboBox component
public
static createComboBox([string $name = '' ][, string $id = '' ][, string $defaultValue = '' ][, bool $sortEntries = false ][, array<string|int, mixed> $attributes = array() ]) : CSGuiComboBox
Parameters
- $name : string = ''
-
the name of the combo box
- $id : string = ''
-
the id of the combo box
- $defaultValue : string = ''
-
the default value that should be visible in the combo box
- $sortEntries : bool = false
-
when true, the entries in the ComboBox are sorted alphabetically
- $attributes : array<string|int, mixed> = array()
-
attributes to add to the combo box
Tags
Return values
CSGuiComboBox —a new CSGuiComboBox
createDialog()
Creates a new CSGuiDialog object
public
static createDialog([int $type = CSGUI_DIALOG_TYPE_WHITE_PADDING ]) : CSGuiDialog
The following types of CSGuiDialogs are available:
- CSGUI_DIALOG_TYPE_WHITE - defines a dialog with a plain white internal area
- CSGUI_DIALOG_TYPE_WHITE_PADDING - defines a dialog with a plain white internal area but a padding
- CSGUI_DIALOG_TYPE_GRAY - defines a dialog with a plain white internal area
- CSGUI_DIALOG_TYPE_GRAY_PADDING - defines a dialog with a plain white internal area but a padding
Parameters
- $type : int = CSGUI_DIALOG_TYPE_WHITE_PADDING
-
Type of the CSGuiDialog using the predefined constants as documented above
Tags
Return values
CSGuiDialog —a new CSGuiDialog
createDynamicTree()
Creates a new CSGuiDynamicTree
public
static createDynamicTree([string $href = "" ][, string $target = "" ]) : CSGuiDynamicTree
Parameters
- $href : string = ""
-
the url to open onClick
- $target : string = ""
-
the target of the url to open onClick
Tags
Return values
CSGuiDynamicTree —a new CSGuiDynamicTree
createEditor()
Creates a new CSGuiEditor
public
static createEditor(mixed $RecordName[, bool $autoCreateAllFieldsHtml = true ]) : CSGuiEditor
Parameters
- $RecordName : mixed
- $autoCreateAllFieldsHtml : bool = true
-
if true the editor creates the form with the fields automatically
Tags
Return values
CSGuiEditor —a new CSGuiEditor
createEditorDialog()
Creates a new CSGuiEditorDialog
public
static createEditorDialog(mixed|string $RecordName[, int $type = CSGUI_EDITOR_DIALOG_TYPE_TABBEDPANE ]) : CSGuiEditorDialog
Parameters
- $RecordName : mixed|string
-
Record $RecordName the Record or the name of the record type the editor should be loaded from
- $type : int = CSGUI_EDITOR_DIALOG_TYPE_TABBEDPANE
Tags
Return values
CSGuiEditorDialog —a new CSGuiEditorDialog or a CSGuiItemEditorDialog if the $RecordName is an item.
createEditorTable()
Creates a new CSGuiTable with the default editor classes set.
public
static createEditorTable([string $height = '100%' ]) : CSGuiTable
This is used in the and can be used anywhere where this look & feel is required.
Parameters
- $height : string = '100%'
-
the height the table may have
Tags
Return values
CSGuiTable —a new CSGuiTable
createExtendedSearch()
Creates a new CSGuiExtendedSearch component
public
static createExtendedSearch([string $recordType = '' ]) : CSGuiExtendedSearch
Parameters
- $recordType : string = ''
-
the record class for which the extended search should be build
Tags
Return values
CSGuiExtendedSearch —a new CSGuiExtendedSearch
createFieldsetPane()
Creates a new CSGuiFieldSetPane object
public
static createFieldsetPane([bool $gray = true ]) : CSGuiFieldSetPane
Parameters
- $gray : bool = true
-
if true the pane is gray, otherwise white
Tags
Return values
CSGuiFieldSetPane —a new CSGuiFieldSetPane
createFileTree()
Creates a new CSGuiFileTree
public
static createFileTree([string $baseDir = 'data/media' ][, string $href = '' ][, string $target = '' ]) : CSGuiFileTree
Parameters
- $baseDir : string = 'data/media'
-
the root directory of the file tree relative to the project root directory
- $href : string = ''
-
the url to open onClick
- $target : string = ''
-
the target of the url to open onClick
Tags
Return values
CSGuiFileTree —a new CSGuiFileTree
createFilterRecordTree()
Creates a new CSGuiFilterRecordTree
public
static createFilterRecordTree(string|object $RecordName, string $filteredField[, string $href = "" ][, string $target = "" ][, string $sqlFilter = '' ]) : CSGuiFilterRecordTree
Parameters
- $RecordName : string|object
-
the Record or the name of the record type the tree should be loaded from
- $filteredField : string
-
the field the tree should be filtered for
- $href : string = ""
-
the url to open onClick
- $target : string = ""
-
the target of the url to open onClick
- $sqlFilter : string = ''
-
additional sql filter limiting the records displayed in the tree
Tags
Return values
CSGuiFilterRecordTree —a new CSGuiFilterRecordTree
createForm()
Creates a new CSGuiForm component
public
static createForm([string $action = '' ][, bool $useOutputBuffering = false ]) : CSGuiForm
Parameters
- $action : string = ''
-
the forms action
- $useOutputBuffering : bool = false
-
whether all echoed output should be buffered within the form
Tags
Return values
CSGuiForm —a new CSGuiForm
createIdmlEditor()
Creates a new CSGuiIdmlEditor component
public
static createIdmlEditor(mixed $idml) : CSGuiIdmlEditor
Parameters
- $idml : mixed
-
an idml file as string or an instance of an CSIdmlDocument object
Tags
Return values
CSGuiIdmlEditor —a new CSGuiIdmlEditor
createItemComparatorTable()
Creates a new CSGuiItemComparatorTable component
public
static createItemComparatorTable(CSItemComparatorData $oCSItemComparatorData) : CSGuiItemComparatorTable
Parameters
- $oCSItemComparatorData : CSItemComparatorData
-
The data to use in the CSGuiItemComparator. This object should be created with the CSItemApi::getComparator-method
Tags
Return values
CSGuiItemComparatorTable —A new CSGuiItemComparatorTable
createItemEditorDialog()
Creates a new CSGuiItemEditorDialog
public
static createItemEditorDialog(mixed $RecordName[, int $type = CSGUI_EDITOR_DIALOG_TYPE_TABBEDPANE ]) : CSGuiItemEditorDialog
Parameters
- $RecordName : mixed
- $type : int = CSGUI_EDITOR_DIALOG_TYPE_TABBEDPANE
-
One of the CSGUI_EDITOR_DIALOG_TYPE_* constants.
Tags
Return values
CSGuiItemEditorDialog —createItemList()
Creates a new CSGuiItemList
public
static createItemList(mixed $RecordName) : CSGuiItemList
Parameters
- $RecordName : mixed
Tags
Return values
CSGuiItemList —a new CSGuiItemList
createList()
Creates a new CSGuiList
public
static createList(mixed $RecordName) : CSGuiList
Parameters
- $RecordName : mixed
Tags
Return values
CSGuiList —a new CSGuiList or a CSGuiItemList if the $RecordName is an item.
createMenubar()
Creates a new CSGuiMenubar object
public
static createMenubar([string $popupHandlerURL = '' ][, string $id = 'CSGuiMenubar_default' ]) : CSGuiMenubar
Parameters
- $popupHandlerURL : string = ''
- $id : string = 'CSGuiMenubar_default'
-
Optional id of the CSGuiMenubar if you use more than one menubar in the current window or frame
Tags
Return values
CSGuiMenubar —a new CSGuiMenubar
createMixedTree()
Creates a new CSGuiMixedTree
public
static createMixedTree() : CSGuiMixedTree
Tags
Return values
CSGuiMixedTree —a new CSGuiMixedTree
createModalDialog()
Creates a new CSGuiModalDialog object.
public
static createModalDialog([string $title = '' ][, string $subTitle = '' ][, string $type = 'CSGUI_DIALOG_TYPE_GRAY_PADDING' ]) : CSGuiModalDialog
A CSGuiModalDialog is a modal window that allows the user to enter parameters.
The CSGuiModalDialog Framework automatically sets default values according to the dialog parameters to all input fields and collects all values back upon confirmation.
Any dialog must be opened with window.csShowModalDialog(). The window parameters can be used to set various options:
- DialogTitle
- DialogSubTitle
To get the return value of the opened Dialog a callback function must be given, which receives as first parameter the return value on close of the dialog.
- e.g. window.csShowModalDialog( URL_TO_DIALOG, {'DialogTitle' : 'MyDialogTitle', 'DialogSubTitle' : 'MySubTitle'}, '', function(myReturnValueOfDialog) } );
Since CS15.1: The dialog is not displayed in 'native' modal dialog anymore because all modern browser does not support window.showModalDialog anymore.
To interact with the opened dialog you must use the CSGuiDialog javascript variable which references to the api of the Dialog. e.g. CSGuiDialog.close(myReturnValue); // to close the dialog
If the dialog window is not created by calling window.csShowModalDialog but with e.g. window.open(URL...); following js methods are available: (see ModalDialog.js)
- cancel : to cancel/close the dialog
- closeDialog(myReturnValue) : closes the dialog, the given "myReturnValue" can only work with window.csShowModalDialog calls
Parameters
- $title : string = ''
-
Title of the CSGuiModalDialog
- $subTitle : string = ''
-
subTitle of the CSGuiModalDialog
- $type : string = 'CSGUI_DIALOG_TYPE_GRAY_PADDING'
-
Type of the CSGuiModalDialog, possible values are the various CSGUI_DIALOG_TYPE_*
Tags
Return values
CSGuiModalDialog —a new CSGuiModalDialog
createModalEditor()
Creates a new CSGuiModalEditor object.
public
static createModalEditor([bool $autoCreateAllFieldsHtml = true ][, string $RecordName = null ][, string $type = 'CSGUI_DIALOG_TYPE_WHITE' ]) : CSGuiModalEditor
A CSGuiModalEditor is a modal window that allows the user to enter parameters AND blocks the window so the user is not able to interact with CS.
To get the return value of the opened Dialog a callback function must be given, which receives as first parameter the return value on close of the dialog. e.g. window.csShowModalDialog( URL_TO_DIALOG, {'DialogTitle' : 'MyDialogTitle', 'DialogSubTitle' : 'MySubTitle'}, '', function(myReturnValueOfDialog) } );
Since CS15.1: The dialog is not displayed in 'native' modal dialog anymore because all modern browser does not support window.showModalDialog anymore.
To interact within the opened dialog you must use the CSGuiDialog javascript variable which references to the api of the Dialog. e.g. CSGuiDialog.close(myReturnValue); // to close the dialog
If the dialog window is not created by calling window.csShowModalDialog but with e.g. window.open(URL...); following js methods are available: (see ModalDialog.js)
- cancel : to cancel/close the dialog
- closeDialog(myReturnValue) : closes the dialog, the given "myReturnValue" can only work with window.csShowModalDialog calls
Parameters
- $autoCreateAllFieldsHtml : bool = true
-
If true the editor creates the form with the fields automatically.
- $RecordName : string = null
-
Record $RecordName the Record or the name of the record type the editor should be loaded from or null if none
- $type : string = 'CSGUI_DIALOG_TYPE_WHITE'
-
Type of the CSGuiModalDialog, possible values are the various CSGUI_DIALOG_TYPE_*
Tags
Return values
CSGuiModalEditor —a new CSGuiModalEditor
createNotesControl()
Creates a new CSGuiNotesControl component
public
static createNotesControl() : CSGuiNotesControl
Tags
Return values
CSGuiNotesControl —a new CSGuiNotesControl
createNotesEditor()
Creates a new CSGuiNotesEditor component
public
static createNotesEditor() : CSGuiNotesEditor
Tags
Return values
CSGuiNotesEditor —a new CSGuiNotesEditor
createNumberField()
Creates a new CSGuiNumberField component
public
static createNumberField([string $name = '' ][, string $id = '' ][, string $defaultValue = '' ][, array<string|int, mixed> $interval = array() ][, int $precision = 2 ][, bool $readonly = false ][, string $attributes = '' ][, string $tooltip = '' ]) : CSGuiNumberField
Parameters
- $name : string = ''
-
the name of the number field
- $id : string = ''
-
the id of the number field
- $defaultValue : string = ''
-
the default value that should be visible in the number field
- $interval : array<string|int, mixed> = array()
-
array of one or two values indicating the interval the typed in number may be in
- $precision : int = 2
-
the precision of the number
- $readonly : bool = false
-
if true, the field is readonly and may be only changed by clicking the arrow buttons
- $attributes : string = ''
-
additional attributes to add to the number field
- $tooltip : string = ''
-
tooltip that should appear when the user points the mouse cursor on the input field
Tags
Return values
CSGuiNumberField —a new CSGuiNumberField
createOverviewArea()
Creates a new CSGuiOverviewArea An overview area is a set of tables in the main area and some links on the right border.
public
static createOverviewArea([string $id = 'CSGuiOverviewArea_default' ][, string $cols = '2' ]) : CSGuiOverviewArea
A typical example is the CS CRM start page.
Parameters
- $id : string = 'CSGuiOverviewArea_default'
-
an optional id for the overview area if you require more than one areas in one html document
- $cols : string = '2'
-
the amount of columns the sub tables should be organized in
Tags
Return values
CSGuiOverviewArea —a new CSGuiOverviewArea
createPopup()
Creates a new CSGuiComponent
public
static createPopup() : CSGuiComponent
Tags
Return values
CSGuiComponent —a new CSGuiComponent
createRating()
Creates a new CSGuiRating component
public
static createRating(Record $record, int $subType[, int $totalRating = 1 ][, int $state = 1 ]) : CSGuiRating
Parameters
- $record : Record
-
the record to rate
- $subType : int
-
the subtype of the Rating, e.g. the configurationID
- $totalRating : int = 1
- $state : int = 1
Tags
Return values
CSGuiRating —a new CSGuiRating
createRichEditor()
Creates a new CSGuiRichEditor with given type.
public
static createRichEditor([string $sName = '' ][, string $sType = '' ]) : CSGuiRichEditor
If no Type given, the default type will be taken.
Parameters
- $sName : string = ''
-
The unique name of the editor.
- $sType : string = ''
-
The type of the editor. Possible types: CSGuiRichEditor::EDITORTYPE_DEFAULT, CSGuiRichEditor::EDITORTYPE_CKEDITOR
Tags
Return values
CSGuiRichEditor —createSectionPane()
Creates a new CSGuiSectionPane object
public
static createSectionPane([string $id = 'CSGuiSectionPane_default' ][, string $type = 'nostyle' ]) : CSGuiSectionPane
Parameters
- $id : string = 'CSGuiSectionPane_default'
-
optional id of the CSGuiSectionPane if you use more than one pane in the current window or frame
- $type : string = 'nostyle'
-
the type of the section pane
Tags
Return values
CSGuiSectionPane —a new CSGuiSectionPane
createSelectionList()
Creates a new CSSelectionList component
public
static createSelectionList(array<string|int, mixed>|string $aRecordClasses, string $jsonString, string $inputName[, string $inputAttributes = '' ][, array<string|int, mixed> $additionalAttributes = array() ][, object $oSourceRecord = null ]) : CSGuiSelectionList
Parameters
- $aRecordClasses : array<string|int, mixed>|string
-
The class name of the record(s) to use as array or comma separated list of record classes. An dummy object or and array of dummy objects is also acceptable.
- $jsonString : string
-
The json string containing the data values.
- $inputName : string
-
The name of the input element containing the values.
- $inputAttributes : string = ''
-
Additional attributes which should be added to the input.
- $additionalAttributes : array<string|int, mixed> = array()
-
Additional attributes which should be available in the List.
- $oSourceRecord : object = null
-
The record that contains the configuration in which the selection list is defined.
Tags
Return values
CSGuiSelectionList —a new CSGuiSelectionList
createSimpleEditor()
Creates a new CSGuiSimpleEditor
public
static createSimpleEditor(mixed $RecordName) : CSGuiSimpleEditor
Parameters
- $RecordName : mixed
Tags
Return values
CSGuiSimpleEditor —a new CSGuiSimpleEditor
createSimpleSearch()
Creates a new CSGuiSimpleSearch component
public
static createSimpleSearch([string $recordType = '' ]) : CSGuiSimpleSearch
Parameters
- $recordType : string = ''
-
the record class for which the simple search should be build
Tags
Return values
CSGuiSimpleSearch —a new CSGuiSimpleSearch
createSlidePane()
Creates a new CSGuiSlidePane object
public
static createSlidePane([string $id = 'CSGuiSlidePane_default' ][, string $class = '' ]) : CSGuiSlidePane
Parameters
- $id : string = 'CSGuiSlidePane_default'
-
optional id of the CSGuiSectionPane if you use more than one pane in the current window or frame
- $class : string = ''
-
the class of the section pane
Tags
Return values
CSGuiSlidePane —a new CSGuiSlidePane
createSlider()
Creates a new CSGuiSlider component
public
static createSlider([string $range = '' ][, string $step = '' ][, string $name = '' ][, string $id = '' ]) : CSGuiSlider
Parameters
- $range : string = ''
-
the range of the slider
- $step : string = ''
-
the step of the slider
- $name : string = ''
-
the name of the slider
- $id : string = ''
-
the id of the slider
Tags
Return values
CSGuiSlider —a new CSGuiSlider
createSplitArea()
Creates a new CSGuiSplitArea To create the area you may specify the following types: - CSGUI_SPLITAREA_TYPE_WITH_PADDING_WHITE - the core body is white and has a padding - CSGUI_SPLITAREA_TYPE_NO_PADDING_WHITE - the core body is white and has no padding
public
static createSplitArea([string $id = null ][, int $type = CSGUI_SPLITAREA_TYPE_WITH_PADDING_WHITE ]) : CSGuiSplitArea
Parameters
- $id : string = null
-
an optional id for the split area if you require more than one splitarea in one html document
- $type : int = CSGUI_SPLITAREA_TYPE_WITH_PADDING_WHITE
-
the type of the split area
Tags
Return values
CSGuiSplitArea —a new CSGuiSplitArea
createStateMenu()
Creates a new State Menu
public
static createStateMenu(CSItemApiItem $oItem[, string $sID = 'CSGuiStateMenu' ]) : CSGuiStateMenu
Parameters
- $oItem : CSItemApiItem
-
the item
- $sID : string = 'CSGuiStateMenu'
-
the optional ID of the component
Tags
Return values
CSGuiStateMenu —createStaticTree()
Creates a new CSGuiStaticTree
public
static createStaticTree([string $href = "" ][, string $target = "" ]) : CSGuiStaticTree
Parameters
- $href : string = ""
-
the url to open onClick
- $target : string = ""
-
the target of the url to open onClick
Tags
Return values
CSGuiStaticTree —a new CSGuiStaticTree
createStoryTree()
Creates a new CSGuiStoryTree
public
static createStoryTree([string $href = '' ][, string $target = '' ]) : CSGuiStoryTree
Parameters
- $href : string = ''
-
the url to open onClick
- $target : string = ''
-
the target of the url to open onClick
Tags
Return values
CSGuiStoryTree —a new CSGuiStoryTree
createSwitchPane()
Creates a new CSGuiSwitchPane object
public
static createSwitchPane([string $id = 'CSGuiSwitchPane_default' ]) : CSGuiSwitchPane
Parameters
- $id : string = 'CSGuiSwitchPane_default'
-
optional id of the CSGuiSwitchPane if you use more than one pane in the current window or frame
Tags
Return values
CSGuiSwitchPane —a new CSGuiSwitchPane
createTabbedPane()
Creates a new CSGuiTabbedPane object
public
static createTabbedPane([string $id = 'CSGuiTabbedPane_default' ][, mixed $startTab = null ][, string $paneID = '' ]) : CSGuiTabbedPane
Parameters
- $id : string = 'CSGuiTabbedPane_default'
-
optional id of the CSGuiTabbedPane if you use more than one pane in the current window or frame
- $startTab : mixed = null
- $paneID : string = ''
Tags
Return values
CSGuiTabbedPane —a new CSGuiTabbedPane
createTable()
Creates a new CSGuiTable A CSGui Table is a table with rows and columns that are formatted in the typical CS style.
public
static createTable([string $tableClass = 'CSGuiTable' ][, array<string|int, mixed> $columnClasses = array() ]) : CSGuiTable
Additionaly the CSGuiTables can be made selectable and dragable for each row.
Parameters
- $tableClass : string = 'CSGuiTable'
-
an optional CSS class for the table
- $columnClasses : array<string|int, mixed> = array()
-
optional array with classes to be used for each column
Tags
Return values
CSGuiTable —a new CSGuiTable
createThumbList()
Creates a new CSGuiThumbList
public
static createThumbList() : CSGuiThumbList
A CSGui Thumb List is a list of documented thumbnails, one thumbnail for each row The Image is on the left hand side, while the titled description is on the right hand side
Tags
Return values
CSGuiThumbList —a new CSGuiThumbList
createThumbListViewer()
Creates a new CSGuiThumbListViewer which creates an automatically CSGuiThumbList for given records
public
static createThumbListViewer(string $RecordName, string $type[, string $subType = '' ]) : CSGuiThumbListViewer
Parameters
- $RecordName : string
-
the name of the record type the view should be loaded from
- $type : string
-
the type of the viewer to which plugins could react
- $subType : string = ''
-
the type of the viewer to which plugins could react
Tags
Return values
CSGuiThumbListViewer —a new CSGuiThumbListList.
createThumbTable()
Creates a new CSGuiThumbTable A CSGui Thumb Table is a table with Thumbnails organized in rows and columns
public
static createThumbTable() : CSGuiThumbTable
Tags
Return values
CSGuiThumbTable —a new CSGuiThumbTable
createToolbar()
Creates a new CSGuiToolbar object
public
static createToolbar([int $type = CSGUI_TOOLBAR_TYPE_HORIZONTAL_LARGE ][, string $id = 'CSGuiToolbar_default' ]) : CSGuiToolbar
The following types of CSGuiToolbars are available:
- CSGUI_TOOLBAR_TYPE_HORIZONTAL_LARGE - defines the normal horizontal toolbars
- CSGUI_TOOLBAR_TYPE_HORIZONTAL_SMALL - defines the normal small horizontal toolbars
- CSGUI_TOOLBAR_TYPE_VERTICAL - defines a vertical Win2003 look and feel toolbar
- CSGUI_TOOLBAR_TYPE_HORIZONTAL - defines a horizontal Win2003 look and feel toolbar
Parameters
- $type : int = CSGUI_TOOLBAR_TYPE_HORIZONTAL_LARGE
-
Type of the CSGuiToolbar using the predefined constants as documented above
- $id : string = 'CSGuiToolbar_default'
-
Optional id of the CSGuiToolbar if you use more than one toolbar in the current window or frame
Tags
Return values
CSGuiToolbar —a new CSGuiToolbar
createTreePane()
Creates a new CSGuiTreePane object
public
static createTreePane([string $id = 'CSGuiTreePane_default' ]) : CSGuiTreePane
Parameters
- $id : string = 'CSGuiTreePane_default'
-
optional id of the CSGuiTreePane if you use more than one pane in the current window or frame
Tags
Return values
CSGuiTreePane —a new CSGuiTreePane
createTreeRecordTree()
Creates a new CSGuiTreeRecordTree
public
static createTreeRecordTree(string|object $RecordName[, string $href = "" ][, string $target = "" ][, string|CSItemSearchFilter $sqlFilter = '' ]) : CSGuiTreeRecordTree
Parameters
- $RecordName : string|object
-
the Record or the name of the record type the tree should be loaded from
- $href : string = ""
-
the url to open onClick
- $target : string = ""
-
the target of the url to open onClick
- $sqlFilter : string|CSItemSearchFilter = ''
-
additional sql filter limiting the records displayed in the tree
Tags
Return values
CSGuiTreeRecordTree —a new CSGuiTreeRecordTree
createUpload()
Creates a new CSGuiUpload component.
public
static createUpload() : CSGuiUpload
Tags
Return values
CSGuiUpload —createUploadComponentDialog()
Creates a new CSGuiUploadComponentDialog Used for CSGuiUpload component, to show various dialogs like FileConfigDialog or ReportDialog
public
static createUploadComponentDialog() : CSGuiUploadComponentDialog
Tags
Return values
CSGuiUploadComponentDialog —createUploadConfigDialog()
Creates a new Dialog for CSGuiUpload component.
public
static createUploadConfigDialog() : CSGuiUploadFileConfigDialog
The component is used to configure a upload setting for each, each of same type and all selected files.
Tags
Return values
CSGuiUploadFileConfigDialog —createUploadDialog()
Creates a new CSGuiUploadDialog component.
public
static createUploadDialog() : CSGuiUploadDialog
Tags
Return values
CSGuiUploadDialog —createUploadReportDialog()
Creates a new Dialog for CSGuiUpload component.
public
static createUploadReportDialog() : CSGuiUploadReportDialog
The component is used to show Reports for Uploaded File(s).
Tags
Return values
CSGuiUploadReportDialog —createUserdefinedTree()
Creates a new CSGuiTree for a userdefined tree
public
static createUserdefinedTree(CSGuiTree $tree[, string $href = "" ][, string $target = "" ]) : CSGuiTree
Parameters
- $tree : CSGuiTree
-
the userdefined tree class which must inherit the CSTree class
- $href : string = ""
-
the url to open onClick
- $target : string = ""
-
the target of the url to open onClick
Tags
Return values
CSGuiTree —a new CSGuiTree
createWindow()
Creates a new CSGuiWindow object
public
static createWindow() : CSGuiWindow
Tags
Return values
CSGuiWindow —a new CSGuiWindow
csShowModalDialog()
Creates JS Code that opens a new CS modal dialog.
public
static csShowModalDialog(string $dialogFile[, string $argueObjectName = '' ][, string $sWindowFeatures = '' ][, string $sCallbackJs = '' ]) : string
Since CS15.1 A callback function must be given to interact with the return value of the opened dialog on dialog close.
Parameters
- $dialogFile : string
-
relative path to the php file providing the dialog content using a CSGuiModalDialog
- $argueObjectName : string = ''
-
JS name of an object that holds the dialog arguments as properties
- $sWindowFeatures : string = ''
-
Various window features like: dialogHeight, dialogWidth...
- $sCallbackJs : string = ''
-
Javascript function string which should be called on dialog close. For more detail information see CSGui.showModalDialog in CSGui.js
Tags
Return values
string —JS Code that opens the dialog.
getJqueryPath()
Return an include path to the jQuery library.
public
static getJqueryPath() : string
Tags
Return values
string —getJqueryPluginPath()
Return an include path to the jQuery plugin which is in ADMIN_LOCAL/lib/javascript/jquery/plugins subfolder.
public
static getJqueryPluginPath(string $sPluginName) : string
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
string —If file exists path to the file otherwise empty string.
translatePane()
Translates a pane without the sorting identifiers e.g. "001|"
public
static translatePane(string $sPaneTitle[, mixed $sModuleName = '' ][, mixed $mLanguage = '' ]) : string
Parameters
- $sPaneTitle : string
-
the pane title to translate
- $sModuleName : mixed = ''
- $mLanguage : mixed = ''
Tags
Return values
string —translated pane title
translateSection()
Translates a section without the sorting identifiers e.g. "001|", "?1*1"
public
static translateSection(string $sSectionTitle[, mixed $sModuleName = '' ][, mixed $mLanguage = '' ]) : string
Parameters
- $sSectionTitle : string
-
the section title to translate
- $sModuleName : mixed = ''
- $mLanguage : mixed = ''
Tags
Return values
string —translated section title