ilTooltipGUI Class Reference

This is a utility class for the yui tooltips. More...

Collaboration diagram for ilTooltipGUI:

Static Public Member Functions
static	addTooltip ( $a_el_id, $a_text, $a_container="", $a_my="bottom center", $a_at="top center", $a_use_htmlspecialchars=true)
	Adds a tooltip to an HTML element. More...
static	getToolTip ( $a_el_id, $a_text, $a_container="", $a_my="bottom center", $a_at="top center", $a_use_htmlspecialchars=true)
	Get tooltip js code. More...
static	init ()
	Initializes the needed tooltip libraries. More...

Static Protected Attributes
static	$initialized = false
static	$library_initialized = false

Detailed Description

This is a utility class for the yui tooltips.

this only works, if a parent has class="yui-skin-sam" attached.

Definition at line 8 of file class.ilTooltipGUI.php.

Member Function Documentation

addTooltip()

static ilTooltipGUI::addTooltip (   $a_el_id,   $a_text,   $a_container = "",   $a_my = "bottom center",   $a_at = "top center",   $a_use_htmlspecialchars = true  )

static

Adds a tooltip to an HTML element.

Parameters

string	$a_el_id	element id
string	$a_el_id	tooltip text
string	$a_el_id	element id of container the tooltip should be added to

Definition at line 20 of file class.ilTooltipGUI.php.

      {
        // to get rid of globals here, we need to change the
        // process in learning modules, e.g. which does not work with $DIC (since it does not
        // use the standard template)
        $tpl = $GLOBALS["tpl"];
        
        self::init();
 
        $code = self::getTooltip(
            $a_el_id,
            $a_text,
            $a_container,
            $a_my,
            $a_at,
            $a_use_htmlspecialchars
        );
        $tpl->addOnLoadCode($code);
    }

References $GLOBALS, $tpl, and init().

Referenced by ilTabsGUI\__getHTML(), ilMainMenuGUI\addToolbarTooltip(), ilTable2GUI\fillHeader(), ilObjectListGUI\getHeaderAction(), ilAdvancedSelectionListGUI\getHTML(), ilRatingGUI\getHTML(), ilGroupedListGUI\getHTML(), ilPageObjectGUI\getTinyMenu(), ilBadgeManagementGUI\listBadges(), ilMainMenuGUI\renderHelpButtons(), ilPortfolioPageGUI\renderMyCourses(), ilContainerObjectiveGUI\renderProgressBar(), and ilContainerObjectiveGUI\renderProgressMeter().

Here is the call graph for this function:

Here is the caller graph for this function:

getToolTip()

static ilTooltipGUI::getToolTip (   $a_el_id,   $a_text,   $a_container = "",   $a_my = "bottom center",   $a_at = "top center",   $a_use_htmlspecialchars = true  )

static

Get tooltip js code.

Parameters

string	$a_el_id	element id
string	$a_el_id	tooltip text
string	$a_el_id	element id of container the tooltip should be added to

Definition at line 53 of file class.ilTooltipGUI.php.

      {
        $addstr = "";
 
        // not needed, just make sure the position plugin is included
        //              $addstr.= ", position: {viewport: $('#fixed_content')}";
        
        if ($a_container != "") {
            $addstr .= ", container: '" . $a_container . "'";
        }
 
        if ($a_use_htmlspecialchars) {
            $a_text = htmlspecialchars(str_replace(array("\n", "\r"), "", $a_text));
        } else {
            $a_text = str_replace(array("\n", "\r", "'", '"'), array("", "", "\'", '\"'), $a_text);
        }
        return 'il.Tooltip.add("' . $a_el_id . '", {' .
            ' context:"' . $a_el_id . '",' .
            ' my:"' . $a_my . '",' .
            ' at:"' . $a_at . '",' .
            ' text:"' . $a_text . '" ' . $addstr . '} );';
    }

init()

static ilTooltipGUI::init ( )

static

Initializes the needed tooltip libraries.

Definition at line 85 of file class.ilTooltipGUI.php.

    {
        // for globals use, see comment above
        $tpl = $GLOBALS["tpl"];
        
        if (!self::$initialized) {
            $tpl->addCss("./libs/bower/bower_components/qtip2/dist/jquery.qtip.min.css");
            $tpl->addJavascript("./libs/bower/bower_components/qtip2/dist/jquery.qtip.min.js");
            $tpl->addJavascript("./Services/UIComponent/Tooltip/js/ilTooltip.js");
 
            // use setTimeout as a workaround, since the last parameter is ignored
            $tpl->addOnLoadCode('setTimeout(function() {il.Tooltip.init();}, 500);', 3);
            self::$initialized = true;
        }
    }

References $GLOBALS, and $tpl.

Referenced by addTooltip(), ilHelpViewLayoutProvider\getMainBarModification(), and ilPreviewGUI\initPreview().

Here is the caller graph for this function:

Field Documentation

$initialized

ilTooltipGUI::$initialized = false

staticprotected

Definition at line 10 of file class.ilTooltipGUI.php.

$library_initialized

ilTooltipGUI::$library_initialized = false

staticprotected

Definition at line 11 of file class.ilTooltipGUI.php.

---

The documentation for this class was generated from the following file:

• Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php