ilYuiUtil Class Reference

Yahoo YUI Library Utility functions. More...

Collaboration diagram for ilYuiUtil:

Static Public Member Functions
static	initConnection (ilTemplate $a_main_tpl=null)
	Init YUI Connection module. More...
static	initEvent ()
	Init YUI Event. More...
static	initDom ()
	Init YUI Dom. More...
static	initAnimation ()
	Init YUI Animation. More...
static	initDragDrop ()
	Init YUI Drag and Drop. More...
static	initDomEvent ()
	Init YUI DomEvent. More...
static	initPanel ($a_resize=false, ilTemplate $a_main_tpl=null)
	Init yui panel. More...
static	initConnectionWithAnimation ()
	Init YUI Connection module. More...
static	initMenu ()
	Init YUI Menu module. More...
static	initOverlay (ilTemplate $a_main_tpl=null)
	Init YUI Overlay module. More...
static	initSimpleDialog ()
	Init YUI Simple Dialog. More...
static	initAssessmentWizard ()
	Init assessment wizard. More...
static	initDragDropList ()
	init drag & drop list More...
static	initDragDropAnimation ()
	init drag & drop and animation More...
static	initElementSelection ()
	init element selection More...
static	getDragDropList ($id_source, $title_source, $source, $id_dest, $title_dest, $dest)
	get a drag & drop list More...
static	addYesNoDialog ($dialogname, $headertext, $message, $yesaction, $noaction, $defaultyes, $icon="help")
static	initCalendar ()
	init calendar More...
static	initButtonControl ()
	init button control In the moment used for calendar color picker button More...
static	initColorPicker ()
	init color picker button More...
static	initTabView ()
	Init YUI TabView component. More...
static	initJson ()
	Init YUI JSON component. More...
static	initLayout ()
	Init layout (alpha!) More...
static	initTreeView ()
	Init treeView. More...
static	initTooltip ()
	Init YUI Event. More...
static	getLocalPath ($a_name="")
	Get local path of a YUI js file. More...

Data Fields
const	YUI_BASE = "./libs/bower/bower_components/yui2/build"

Static Protected Member Functions
static	addContainerCss (ilTemplate $a_main_tpl=null)
	Add container css. More...

Detailed Description

Yahoo YUI Library Utility functions.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

addContainerCss()

static ilYuiUtil::addContainerCss ( ilTemplate  $a_main_tpl = null )

staticprotected

Add container css.

Definition at line 529 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        if ($a_main_tpl == null) {
            $tpl = $DIC["tpl"];
        } else {
            $tpl = $a_main_tpl;
        }

        $tpl->addCss(self::getLocalPath("container/assets/skins/sam/container.css"));
    }

addYesNoDialog()

static ilYuiUtil::addYesNoDialog (   $dialogname,   $headertext,   $message,   $yesaction,   $noaction,   $defaultyes,   $icon = "help"  )

static

Definition at line 297 of file class.ilYuiUtil.php.

References $DIC, $lng, $message, $template, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $lng = $DIC->language();

        self::initSimpleDialog();

        $template = new ilTemplate("tpl.yes_no_dialog.js", true, true, "Services/YUI");
        $template->setVariable("DIALOGNAME", $dialogname);
        $template->setVariable("YES_ACTION", $yesaction);
        $template->setVariable("NO_ACTION", $noaction);
        $template->setVariable("DIALOG_HEADER", $headertext);
        $template->setVariable("DIALOG_MESSAGE", $message);
        $template->setVariable("TEXT_YES", $lng->txt("yes"));
        $template->setVariable("TEXT_NO", $lng->txt("no"));
        switch ($icon) {
            case "warn":
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_WARN");
                break;
            case "tip":
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_TIP");
                break;
            case "info":
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_INFO");
                break;
            case "block":
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_BLOCK");
                break;
            case "alarm":
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_ALARM");
                break;
            case "help":
            default:
                $template->setVariable("ICON", "YAHOO.widget.SimpleDialog.ICON_HELP");
                break;
        }
        if ($defaultyes) {
            $template->touchBlock("isDefaultYes");
        } else {
            $template->touchBlock("isDefaultNo");
        }
        $tpl->setCurrentBlock("HeadContent");
        $tpl->setVariable("CONTENT_BLOCK", $template->get());
        $tpl->parseCurrentBlock();
    }

getDragDropList()

static ilYuiUtil::getDragDropList (   $id_source,   $title_source,   $source,   $id_dest,   $title_dest,   $dest  )

static

get a drag & drop list

Definition at line 265 of file class.ilYuiUtil.php.

References $id, $name, $source, and $template.

    {
        self::initDragDropList();

        $template = new ilTemplate("tpl.dragdroplist.html", true, true, "Services/YUI");
        foreach ($source as $id => $name) {
            $template->setCurrentBlock("source_element");
            $template->setVariable("ELEMENT_ID", $id);
            $template->setVariable("ELEMENT_NAME", $name);
            $template->parseCurrentBlock();
            $template->setCurrentBlock("element");
            $template->setVariable("ELEMENT_ID", $id);
            $template->parseCurrentBlock();
        }
        foreach ($dest as $id => $name) {
            $template->setCurrentBlock("dest_element");
            $template->setVariable("ELEMENT_ID", $id);
            $template->setVariable("ELEMENT_NAME", $name);
            $template->parseCurrentBlock();
            $template->setCurrentBlock("element");
            $template->setVariable("ELEMENT_ID", $id);
            $template->parseCurrentBlock();
        }
        $template->setVariable("TITLE_LIST_1", $title_source);
        $template->setVariable("TITLE_LIST_2", $title_dest);
        $template->setVariable("LIST_1", $id_source);
        $template->setVariable("LIST_2", $id_dest);

        return $template->get();
    }

getLocalPath()

static ilYuiUtil::getLocalPath (   $a_name = "" )

static

Get local path of a YUI js file.

Definition at line 520 of file class.ilYuiUtil.php.

Referenced by ilSCORM13Player\debugGUI(), ilCOPageHTMLExport\exportSupportScripts(), and ilObjContentObject\getSupplyingExportFiles().

    {
        return self::YUI_BASE . "/" . $a_name;
    }

Here is the caller graph for this function:

initAnimation()

static ilYuiUtil::initAnimation ( )

static

Init YUI Animation.

Definition at line 61 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilPropertyFormGUI\getContent().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
    }

Here is the caller graph for this function:

initAssessmentWizard()

static ilYuiUtil::initAssessmentWizard ( )

static

Init assessment wizard.

Definition at line 202 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/button/button-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container-min.js");
        $tpl->addCss(self::YUI_BASE . "/button/assets/skins/sam/button.css");
        self::addContainerCss();
    }

initButtonControl()

static ilYuiUtil::initButtonControl ( )

static

init button control In the moment used for calendar color picker button

public

Returns

void

Definition at line 375 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");

        $tpl->addJavaScript(self::YUI_BASE . "/container/container_core-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/menu/menu-min.js");

        $tpl->addJavaScript(self::YUI_BASE . "/button/button-min.js");

        $tpl->addCss(self::YUI_BASE . "/button/assets/skins/sam/button.css");
        $tpl->addCss(self::YUI_BASE . "/menu/assets/skins/sam/menu.css");
    }

initCalendar()

static ilYuiUtil::initCalendar ( )

static

init calendar

public

Returns

Definition at line 353 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/calendar/calendar-min.js");

        $tpl->addCss(self::YUI_BASE . "/calendar/assets/skins/sam/calendar.css");
        $tpl->addCss("./Services/Calendar/css/calendar.css");
    }

initColorPicker()

static ilYuiUtil::initColorPicker ( )

static

init color picker button

public

Returns

void

Definition at line 401 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilColorPickerInputGUI\insert(), and ilTRBLColorPickerInputGUI\insert().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        self::initButtonControl();

        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/slider/slider-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/colorpicker/colorpicker-min.js");

        $tpl->addCss('./Services/Form/css/color_picker.css');
        $tpl->addCss(self::YUI_BASE . "/colorpicker/assets/skins/sam/colorpicker.css");
    }

Here is the caller graph for this function:

initConnection()

static ilYuiUtil::initConnection ( ilTemplate  $a_main_tpl = null )

static

Init YUI Connection module.

Definition at line 18 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilBlockGUI\__construct(), ilAccordionGUI\addJavaScript(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilMainMenuGUI\getHTML(), ilInternalLinkGUI\getInitHTML(), ilExplorer\getOutput(), ilCloudPluginInitGUI\initGUI(), ilMediaPlayerGUI\initJavascript(), ilLMPresentationGUI\layout(), ilTable2GUI\renderFilter(), ilAdvancedSelectionListGUI\setAsynch(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        if ($a_main_tpl == null) {
            $tpl = $DIC["tpl"];
        } else {
            $tpl = $a_main_tpl;
        }
        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/connection/connection-min.js");
    }

Here is the caller graph for this function:

initConnectionWithAnimation()

static ilYuiUtil::initConnectionWithAnimation ( )

static

Init YUI Connection module.

Definition at line 135 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilTestOutputGUI\executeCommand(), ilTestPlayerDynamicQuestionSetGUI\executeCommand(), and ilFlashFileInputGUI\insert().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/connection/connection-min.js");
    }

Here is the caller graph for this function:

initDom()

static ilYuiUtil::initDom ( )

static

Init YUI Dom.

Definition at line 48 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilPropertyFormGUI\getContent(), and ilTemplate\show().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
    }

Here is the caller graph for this function:

initDomEvent()

static ilYuiUtil::initDomEvent ( )

static

Init YUI DomEvent.

Definition at line 90 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilSetupGUI\__construct(), ilTestServiceGUI\getPassListOfAnswersWithScoring(), assTextQuestionGUI\getTestOutput(), ilCalendarAppointmentGUI\initForm(), ilObjSessionGUI\initForm(), and ilConsultationHoursGUI\initFormSequence().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
    }

Here is the caller graph for this function:

initDragDrop()

static ilYuiUtil::initDragDrop ( )

static

Init YUI Drag and Drop.

Definition at line 75 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilHierarchyFormGUI\__construct(), ilCalendarMonthGUI\addScheduleFilter(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilCalendarDayGUI\executeCommand(), ilSurveyPageGUI\renderPage(), ilCalendarWeekGUI\show(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");
    }

Here is the caller graph for this function:

initDragDropAnimation()

static ilYuiUtil::initDragDropAnimation ( )

static

init drag & drop and animation

Definition at line 236 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
    }

initDragDropList()

static ilYuiUtil::initDragDropList ( )

static

init drag & drop list

Definition at line 220 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
        $tpl->addCss("./Services/YUI/templates/default/DragDropList.css");
    }

initElementSelection()

static ilYuiUtil::initElementSelection ( )

static

init element selection

Definition at line 251 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");
    }

initEvent()

static ilYuiUtil::initEvent ( )

static

Init YUI Event.

Definition at line 35 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilPropertyFormGUI\getContent().

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
    }

Here is the caller graph for this function:

initJson()

static ilYuiUtil::initJson ( )

static

Init YUI JSON component.

Author

jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 439 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilChatroomBlockGUI\getHTML().

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/json/json-min.js");
    }

Here is the caller graph for this function:

initLayout()

static ilYuiUtil::initLayout ( )

static

Init layout (alpha!)

Definition at line 452 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addCss(self::YUI_BASE . "/assets/skins/sam/resize.css");
        $tpl->addCss(self::YUI_BASE . "/assets/skins/sam/layout.css");

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/resize/resize-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/layout/layout-min.js");
    }

initMenu()

static ilYuiUtil::initMenu ( )

static

Init YUI Menu module.

Definition at line 150 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container_core.js");
        $tpl->addJavaScript(self::YUI_BASE . "/menu/menu-min.js");
        $tpl->addCss(self::YUI_BASE . "/menu/assets/menu.css");
    }

initOverlay()

static ilYuiUtil::initOverlay ( ilTemplate  $a_main_tpl = null )

static

Init YUI Overlay module.

Definition at line 166 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilTermsOfServiceAcceptanceHistoryTableGUI\__construct(), ilTestScoringByQuestionsGUI\getActiveSubTabId(), ilOverlayGUI\initJavascript(), and ilAssLacLegendGUI\initOverlay().

    {
        global $DIC;

        if ($a_main_tpl == null) {
            $tpl = $DIC["tpl"];
        } else {
            $tpl = $a_main_tpl;
        }

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container_core-min.js");
        self::addContainerCss($tpl);
    }

Here is the caller graph for this function:

initPanel()

static ilYuiUtil::initPanel (   $a_resize = false, ilTemplate  $a_main_tpl = null  )

static

Init yui panel.

public

Parameters

void

Returns

void

Definition at line 109 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

Referenced by ilTermsOfServiceAcceptanceHistoryTableGUI\__construct(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilTestScoringByQuestionsGUI\getActiveSubTabId(), ilTaggingGUI\initJavascript(), ilNoteGUI\initJavascript(), ilLPObjectStatisticsLPTableGUI\initLearningProgressDetailsLayer(), ilExplorerSelectInputGUI\render(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        if ($a_main_tpl != null) {
            $tpl = $a_main_tpl;
        } else {
            $tpl = $DIC["tpl"];
        }

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container-min.js");
        self::addContainerCss($tpl);
        $tpl->addCss("./Services/Calendar/css/panel_min.css");

        if ($a_resize) {
            $tpl->addCss(self::YUI_BASE . "/resize/assets/skins/sam/resize.css");
            $tpl->addJavaScript(self::YUI_BASE . "/utilities/utilities-min.js");
            $tpl->addJavaScript(self::YUI_BASE . "/resize/resize-min.js");
        }
    }

Here is the caller graph for this function:

initSimpleDialog()

static ilYuiUtil::initSimpleDialog ( )

static

Init YUI Simple Dialog.

Definition at line 185 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/dragdrop/dragdrop-min.js");
        self::addContainerCss();
        $tpl->addCss("./Services/YUI/templates/default/tpl.simpledialog.css");
    }

initTabView()

static ilYuiUtil::initTabView ( )

static

Init YUI TabView component.

Definition at line 421 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addCss(self::YUI_BASE . "/tabview/assets/skins/sam/tabview.css");
        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/element/element-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/tabview/tabview-min.js");
    }

initTooltip()

static ilYuiUtil::initTooltip ( )

static

Init YUI Event.

Definition at line 488 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        self::addContainerCss();
        $tpl->addJavaScript(self::YUI_BASE . "/yahoo-dom-event/yahoo-dom-event.js");
        $tpl->addJavaScript(self::YUI_BASE . "/animation/animation-min.js");
        $tpl->addJavaScript(self::YUI_BASE . "/container/container-min.js");
    }

initTreeView()

static ilYuiUtil::initTreeView ( )

static

Init treeView.

Definition at line 473 of file class.ilYuiUtil.php.

References $DIC, and $tpl.

    {
        global $DIC;

        $tpl = $DIC["tpl"];

        $tpl->addJavaScript(self::getLocalPath() . '/yahoo/yahoo-min.js');
        $tpl->addJavaScript(self::getLocalPath() . '/event/event-min.js');
        $tpl->addJavaScript(self::getLocalPath() . '/treeview/treeview.js');
    }

Field Documentation

YUI_BASE

const ilYuiUtil::YUI_BASE = "./libs/bower/bower_components/yui2/build"

Definition at line 12 of file class.ilYuiUtil.php.

---

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

• Services/YUI/classes/class.ilYuiUtil.php