OTRS API Reference JavaScript

Namespace: Core.UI

Core. UI

This namespace contains all UI functions.
Author:
  • OTRS AG
Source:

Namespaces

Accessibility
Accordion
ActionRow
AdvancedChart
AllocationList
Autocomplete
Datepicker
Dialog
DnD
Floater
InputFields
Notification
Popup
Resizable
RichTextEditor
Table
TreeSelection

Methods

(static) GetID($Element) → {String}

Returns the ID of the Element and creates one for it if nessessary.
Parameters:
Name Type Description
$Element jQueryObject The HTML element
Source:
Returns:
ID of the element
Type
String

(static) InitCheckboxSelection($Element)

This function initializes a click event for tables / divs with checkboxes. If you click in the table cell / div around the checkbox the checkbox will be selected. A possible MasterAction will not be executed.
Parameters:
Name Type Description
$Element jQueryObject The element selector which describes the element(s) which surround the checkboxes.
Source:

(static) InitMessageBoxClose()

This function initializes the close buttons for the message boxes that show server messages.
Source:

(static) InitWidgetActionToggle()

This function initializes the toggle mechanism for all widgets with a WidgetAction toggle icon.
Source:

(static) RegisterToggleTwoContainer($ClickedElement, $Element1, $Element2)

Registers click event to toggle the container and get initial order of columns.
Parameters:
Name Type Description
$ClickedElement jQueryObject
$Element1 jQueryObject First container element.
$Element2 jQueryObject Second container element.
Source:

(static) ScrollTo($Element)

Scrolls the active window until an element is visible.
Parameters:
Name Type Description
$Element jQueryObject
Source:

(static) Shake($id)

"Shakes" the element.
Parameters:
Name Type Description
$id jQueryObject The element to shake.
Source:

(static) ToggleTwoContainer($Element1, $Element2)

This functions toggles two Containers with a nice slide effect.
Parameters:
Name Type Description
$Element1 jQueryObject First container element.
$Element2 jQueryObject Second container element.
Source: