CSPortalGui
in package
Tags
Table of Contents
- createBottomBar() : CSPortalGuiToolbar
- Creates a Bottombar that allows to add buttons, captions and other components
- createDetailsViewer() : CSPortalGuiDetailsViewer
- Creates an area that is typically used to show details of a data object
- createDialog() : CSPortalGuiDialog
- Creates a dialog window in the CSPortal style
- createDialogbar() : CSPortalGuiToolbar
- Creates a Dialogbar that allows to add buttons, captions and other components
- createEditor() : CSPortalGuiEditor
- Adapts any CSGuiEditor component to a portal look and feel.
- createForm() : CSPortalGuiForm
- Creates a html form with labeled input fields
- createFreeText() : CSPortalGuiFreeText
- Creates a free formatable html text area
- createLayoutManager() : CSPortalGuiLayoutManager
- Creates a layout manager that makes it easy to create widget or dialog layouts with components attached to the borders
- createList() : CSPortalGuiList
- Creates a iPhone like list in a Widget
- createLoadingMessage() : string
- Returns a standardized loading message for the CSPortal
- createMessage() : CSPortalGuiMessage
- Creates a message snippet with a title and message and optionally with an image
- createNavigator() : CSPortalGuiNavigator
- Creates a breadcrumb like navigation path typically used at the top of widgets
- createRecordEditor() : CSPortalGuiRecordEditor
- Creates a simple html form as editor with labeled input fields from a record This component is deprecated. It is recommended to use the createEditor method insted
- createSearchbar() : CSPortalGuiSearchbar
- Creates an iPhone like search bar
- createSearchbox() : CSPortalGuiSearchbox
- Creates an iPhone like search box
- createSectionPane() : CSPortalGuiSectionPane
- Creates a CSPortalGuiSectionPane
- createSelection() : CSPortalGuiSelection
- Creates a Selection Component
- createSidebar() : CSPortalGuiSidebar
- Creates a Sidebar that allows to add Sections with other components
- 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
- createTabbedPane() : CSPortalGuiTabbedPane
- Creates a CSPortalGuiTable
- createTable() : CSPortalGuiSectionPane
- Creates a CSPortalGuiSectionPane
- createThumbNavigator() : CSPortalGuiThumbNavigator
- Creates a thumb navigator
- createToolbar() : CSPortalGuiToolbar
- Creates a Toolbar that allows to add buttons, captions and other components
- createWindow() : CSPortalGuiWindow
- Creates a popup window in the CSPortal style
Methods
createBottomBar()
Creates a Bottombar that allows to add buttons, captions and other components
public
static createBottomBar([string $type = CSPORTALGUI_BOTTOMBAR_TYPE_SMALL ][, string $id = '' ]) : CSPortalGuiToolbar
Bottombars should be used at the bottom of widgets
Example:
$toolbar = CSPortalGui::createBottombar(); $toolbar->addTextButton('Save', 'alert("saved");'); $toolbar->setTitle('Test'); $toolbar->addButton('images/save.gif', 'alert("clicked");', 'Click to save', 'right'); echo $toolbar->makeHtml();
Parameters
- $type : string = CSPORTALGUI_BOTTOMBAR_TYPE_SMALL
-
the type of the toolbar as CSPORTALGUI_BOTTOMBAR_TYPE_[SMALL|BIG]
- $id : string = ''
Tags
Return values
CSPortalGuiToolbar —createDetailsViewer()
Creates an area that is typically used to show details of a data object
public
static createDetailsViewer([string $title = '' ]) : CSPortalGuiDetailsViewer
See the CSPortalGuiDetailViewer for further description of the viewer concept
Parameters
- $title : string = ''
-
the title of the viewer area
Tags
Return values
CSPortalGuiDetailsViewer —createDialog()
Creates a dialog window in the CSPortal style
public
static createDialog() : CSPortalGuiDialog
Tags
Return values
CSPortalGuiDialog —createDialogbar()
Creates a Dialogbar that allows to add buttons, captions and other components
public
static createDialogbar([string $type = CSPORTALGUI_DIALOGBAR_TYPE_SMALL ][, string $id = '' ]) : CSPortalGuiToolbar
Dialogbars should be used at the bottom of dialog popup windows.
Example:
$toolbar = CSPortalGui::createDialogbar(); $toolbar->addTextButton('Save', 'alert("saved");'); $toolbar->setTitle('Test'); $toolbar->addButton('images/save.gif', 'alert("clicked");', 'Click to save', 'right'); echo $toolbar->makeHtml();
Parameters
- $type : string = CSPORTALGUI_DIALOGBAR_TYPE_SMALL
-
the type of the toolbar as CSPORTALGUI_DIALOGBAR_TYPE_[SMALL|BIG]
- $id : string = ''
Tags
Return values
CSPortalGuiToolbar —createEditor()
Adapts any CSGuiEditor component to a portal look and feel.
public
static createEditor(mixed $source) : CSPortalGuiEditor
It can be build on a CSGuiEditor and also on any Record for which a CSGuiEditor is transparently created It inherits all methods from the contained editor and therefore can be used like a standard with methods like ->addField ...
Parameters
- $source : mixed
-
either a Record for a standard editor or a CSGuiEditor $csGuiEditor which should be relayouted
Tags
Return values
CSPortalGuiEditor —createForm()
Creates a html form with labeled input fields
public
static createForm([string $caption = null ]) : CSPortalGuiForm
Parameters
- $caption : string = null
Tags
Return values
CSPortalGuiForm —createFreeText()
Creates a free formatable html text area
public
static createFreeText([bool $withPadding = true ]) : CSPortalGuiFreeText
This component should be used to create arbitrary html output.
Parameters
- $withPadding : bool = true
Tags
Return values
CSPortalGuiFreeText —createLayoutManager()
Creates a layout manager that makes it easy to create widget or dialog layouts with components attached to the borders
public
static createLayoutManager() : CSPortalGuiLayoutManager
The Layout Manager defines areas with north, south, east, west and center and floats components added to these areas automatically.
Tags
Return values
CSPortalGuiLayoutManager —createList()
Creates a iPhone like list in a Widget
public
static createList([string $listID = '' ][, string $type = 'list' ]) : CSPortalGuiList
Parameters
- $listID : string = ''
-
optional id of the list
- $type : string = 'list'
-
the viewmode of the list
Tags
Return values
CSPortalGuiList —createLoadingMessage()
Returns a standardized loading message for the CSPortal
public
static createLoadingMessage() : string
Note, that there's also a JScript method CSPortal.isLoading(true|false, reason)
Tags
Return values
string —createMessage()
Creates a message snippet with a title and message and optionally with an image
public
static createMessage(string $title, string $message) : CSPortalGuiMessage
Parameters
- $title : string
- $message : string
Tags
Return values
CSPortalGuiMessage —createNavigator()
Creates a breadcrumb like navigation path typically used at the top of widgets
public
static createNavigator() : CSPortalGuiNavigator
When calling the getView()->getNavigator() method of a CSWidget Plugin such a Navigator is automatically created. Therefore the Navigator is normally not created directly using this factory method here.
Tags
Return values
CSPortalGuiNavigator —createRecordEditor()
Creates a simple html form as editor with labeled input fields from a record This component is deprecated. It is recommended to use the createEditor method insted
public
static createRecordEditor(string|Record $record) : CSPortalGuiRecordEditor
Parameters
- $record : string|Record
Tags
Return values
CSPortalGuiRecordEditor —createSearchbar()
Creates an iPhone like search bar
public
static createSearchbar(string $jsSearchFunction[, string $caption = 'Search' ][, string $default = '' ]) : CSPortalGuiSearchbar
When the user enters a search phrase and presses return a javascript function will be called and the search phrase passed to this as variable.
Example:
$searchbar = CSPortalGui::createSearchbar("function search(query){alert(query)}"); echo $searchbar->makeHtml();
Parameters
- $jsSearchFunction : string
-
the javascript function to be called on search
- $caption : string = 'Search'
- $default : string = ''
Tags
Return values
CSPortalGuiSearchbar —createSearchbox()
Creates an iPhone like search box
public
static createSearchbox(string $jsSearchFunction[, string $caption = 'Search' ][, string $default = '' ][, string $extendedSearchJS = '' ]) : CSPortalGuiSearchbox
When the user enters a search phrase and presses return a javascript function will be called and the search phrase passed to this as variable.
Example:
$searchbox = CSPortalGui::createSearchbox("function search(query){alert(query)}"); echo $searchbox->makeHtml();
Parameters
- $jsSearchFunction : string
-
the javascript function to be called on search
- $caption : string = 'Search'
- $default : string = ''
- $extendedSearchJS : string = ''
Tags
Return values
CSPortalGuiSearchbox —createSectionPane()
Creates a CSPortalGuiSectionPane
public
static createSectionPane([string $id = 'default' ][, string $type = 'default' ]) : CSPortalGuiSectionPane
Section panes can be used to group output into sections which can be opened and closed by the user.
Note: If you have two or more sections on the same html page you have to provide an ID to make sure that they work properly.
Parameters
- $id : string = 'default'
-
an optional id of the section pane
- $type : string = 'default'
-
???
Tags
Return values
CSPortalGuiSectionPane —createSelection()
Creates a Selection Component
public
static createSelection([string $sLabel = '' ], int $sId[, string $sCSSClass = '' ]) : CSPortalGuiSelection
Parameters
- $sLabel : string = ''
- $sId : int
- $sCSSClass : string = ''
Tags
Return values
CSPortalGuiSelection —createSidebar()
Creates a Sidebar that allows to add Sections with other components
public
static createSidebar([string $id = '' ]) : CSPortalGuiSidebar
Example:
$sidebar = CSPortalGui::createSidebar(); $sidebar->addListSection( 'MySidebarSection', CSPortalGui::createList() ); $sidebar->addPane( 'CSGuiPane' ); echo 'Content from the CSGuiPane'; $sidebar->addListSection( 'MySidebarSection', CSPortalGui::createDetailViewer() ); echo $sidebar->makeHtml();
Parameters
- $id : string = ''
Tags
Return values
CSPortalGuiSidebar —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 = 'CSGuiSplitArea_default' ][, int $type = CSGUI_SPLITAREA_TYPE_WITH_PADDING_WHITE ]) : CSGuiSplitArea
Parameters
- $id : string = 'CSGuiSplitArea_default'
-
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
createTabbedPane()
Creates a CSPortalGuiTable
public
static createTabbedPane([string $id = 'default' ]) : CSPortalGuiTabbedPane
Tables can be used to output structured data in a table layout
Parameters
- $id : string = 'default'
-
an optional id of the tabbed pane
Tags
Return values
CSPortalGuiTabbedPane —createTable()
Creates a CSPortalGuiSectionPane
public
static createTable([mixed $tableClass = 'CSGuiTable' ][, array<string|int, mixed> $columnClasses = array() ]) : CSPortalGuiSectionPane
Section panes can be used to group output into sections which can be opened and closed by the user.
Note: If you have two or more sections on the same html page you have to provide an ID to make sure that they work properly.
Parameters
- $tableClass : mixed = 'CSGuiTable'
- $columnClasses : array<string|int, mixed> = array()
-
an optional array with css classes
Tags
Return values
CSPortalGuiSectionPane —createThumbNavigator()
Creates a thumb navigator
public
static createThumbNavigator() : CSPortalGuiThumbNavigator
Tags
Return values
CSPortalGuiThumbNavigator —createToolbar()
Creates a Toolbar that allows to add buttons, captions and other components
public
static createToolbar([string $type = CSPORTALGUI_TOOLBAR_TYPE_SMALL ][, string $id = '' ]) : CSPortalGuiToolbar
There are three different kind of toolbars with the same behaviour but different look and feel:
- The Toolbar
- The Bottombar (delivered by the CSPortalGui::createBottombar method)
- The Dialogbar (delivered by the CSPortalGui::createDialogbar method)
The Bottombar should be used for toolbars at the bottom of a widget. The Dialogbar should be used for toolbars at the bottom of a popup window and normally shows buttons like 'Save' or 'Cancel'.
Example:
$toolbar = CSPortalGui::createToolbar(); $toolbar->addTextButton('Save', 'alert("saved");'); $toolbar->setTitle('Test'); $toolbar->addButton('images/save.gif', 'alert("clicked");', 'Click to save', 'right'); echo $toolbar->makeHtml();
Parameters
- $type : string = CSPORTALGUI_TOOLBAR_TYPE_SMALL
-
the type of the toolbar as CSPORTALGUI_TOOLBAR_TYPE_[SMALL|BIG]
- $id : string = ''
Tags
Return values
CSPortalGuiToolbar —createWindow()
Creates a popup window in the CSPortal style
public
static createWindow() : CSPortalGuiWindow