ilPCIIMTriggerEditorGUI Class Reference

User interface class for page content map editor. More...

Inheritance diagram for ilPCIIMTriggerEditorGUI:

Collaboration diagram for ilPCIIMTriggerEditorGUI:

Public Member Functions
	__construct (ilPCInteractiveImage $a_content_obj, ilPageObject $a_page, EditGUIRequest $request)
	getParentNodeName ()
	getEditorTitle ()
	getImageMapTableHTML ()
	Get trigger table. More...
	getToolbar ()
	addNewArea ()
	initAreaEditingForm (string $a_edit_property)
	Init area editing form. More...
	saveArea ()
	Save new or updated map area. More...
	updateTrigger ()
	Update trigger. More...
	confirmDeleteTrigger ()
	Confirm trigger deletion. More...
	deleteTrigger ()
	Delete trigger. More...
	getAdditionalPageXML ()
	Get additional page xml (to be overwritten) More...
	outputPostProcessing (string $a_output)
Public Member Functions inherited from ilPCImageMapEditorGUI
	__construct ( $a_content_obj, ilPageObject $a_page, EditGUIRequest $request)
	getParentNodeName ()
	getImageMapTableHTML ()
	saveArea ()
	Save new or updated map area. More...
	deleteAreas ()
	Delete map areas. More...
	getLinkTypeOfArea (int $a_nr)
	Get Link Type of Area. More...
	getTypeOfArea (int $a_nr)
	Get Type of Area (only internal link) More...
	getTargetOfArea (int $a_nr)
	Get Target of Area (only internal link) More...
	getTargetFrameOfArea (int $a_nr)
	Get TargetFrame of Area (only internal link) More...
	getHrefOfArea (int $a_nr)
	Get Href of Area (only external link) More...
	updateAreas ()
	Update map areas. More...
	makeMapWorkCopy (string $a_edit_property="", int $a_area_nr=0, bool $a_output_new_area=false, string $a_area_type="", string $a_coords="")
	Make work file for editing. More...
	getAliasXML ()
Public Member Functions inherited from ilImageMapEditorGUI
	__construct (ilObjMediaObject $a_media_object)
	executeCommand ()
	editMapAreas ()
	getToolbar ()
	getEditorTitle ()
	getImageMapTableHTML ()
	handleMapParameters ()
	showImageMap ()
	updateAreas ()
	addNewArea ()
	linkWholePicture ()
	addRectangle ()
	addCircle ()
	addPolygon ()
	clearSessionVars ()
	addArea (bool $a_handle=true)
	editMapArea (bool $a_get_next_coordinate=false, bool $a_output_new_area=false, bool $a_save_form=false, string $a_edit_property="", int $a_area_nr=0)
	Edit a single map area. More...
	initAreaEditingForm (string $a_edit_property)
	makeMapWorkCopy (string $a_edit_property="", int $a_area_nr=0, bool $a_output_new_area=false, string $a_area_type="", string $a_coords="")
	Make work file for editing. More...
	getImageMapOutput (string $a_map_edit_mode="")
	Render the image map. More...
	getAdditionalPageXML ()
	Get additional page xml (to be overwritten) More...
	outputPostProcessing (string $a_output)
	getAliasXML ()
	getMapAreaLinkString (string $a_target, string $a_type, string $a_frame)
	Get text name of internal link. More...
	editImagemapForward ()
	Get image map coordinates. More...
	saveArea ()
	Save new or updated map area. More...
	setInternalLink ()
	setLink (bool $a_handle=true)
	getLinkTypeOfArea (int $a_nr)
	getTypeOfArea (int $a_nr)
	Get Type of Area (only internal link) More...
	getTargetOfArea (int $a_nr)
	Get Target of Area (only internal link) More...
	getTargetFrameOfArea (int $a_nr)
	Get TargetFrame of Area (only internal link) More...
	getHrefOfArea (int $a_nr)
	Get Href of Area (only external link) More...
	deleteAreas ()
	Delete map areas. More...
	editLink ()
	Edit existing link. More...
	editShapeWholePicture ()
	Edit an existing shape (make it a whole picture link) More...
	editShapeRectangle ()
	Edit an existing shape (make it a rectangle) More...
	editShapeCircle ()
	Edit an existing shape (make it a circle) More...
	editShapePolygon ()
	Edit an existing shape (make it a polygon) More...
	setShape (bool $a_handle=true)
	edit shape of existing map area More...
	setHighlight ()
	Set highlight settings. More...

Additional Inherited Members
Static Public Member Functions inherited from ilImageMapEditorGUI
static	_recoverParameters ()
	Recover parameters from session variables (static) More...
Protected Attributes inherited from ilPCImageMapEditorGUI
MapEditorSessionRepository	$map_repo
ilMediaAliasItem	$std_alias_item
ilPageObject	$page
	$content_obj
EditGUIRequest	$edit_request
Protected Attributes inherited from ilImageMapEditorGUI
ilObjMediaObject	$media_object
ImageMapGUIRequest	$request
ImageMapManager	$map
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilCtrl	$ctrl
ilLanguage	$lng
ilToolbarGUI	$toolbar

Detailed Description

User interface class for page content map editor.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPCIIMTriggerEditorGUI: ilInternalLinkGUI

Definition at line 27 of file class.ilPCIIMTriggerEditorGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCIIMTriggerEditorGUI::__construct	(	ilPCInteractiveImage	$a_content_obj,
		ilPageObject	$a_page,
		EditGUIRequest	$request
	)

Definition at line 29 of file class.ilPCIIMTriggerEditorGUI.php.

      {
        iljQueryUtil::initjQueryUI();
        parent::__construct($a_content_obj, $a_page, $request);
 
        $this->main_tpl->addJavaScript("./Services/COPage/js/ilCOPagePres.js");
        $this->main_tpl->addJavaScript("./Services/COPage/js/ilCOPagePCInteractiveImage.js");
 
        ilAccordionGUI::addJavaScript();
        ilAccordionGUI::addCss();
    }

References ilImageMapEditorGUI\$request, ILIAS\GlobalScreen\Provider\__construct(), ilAccordionGUI\addCss(), ilAccordionGUI\addJavaScript(), and iljQueryUtil\initjQueryUI().

Here is the call graph for this function:

Member Function Documentation

addNewArea()

ilPCIIMTriggerEditorGUI::addNewArea

(

)

Reimplemented from ilImageMapEditorGUI.

Definition at line 107 of file class.ilPCIIMTriggerEditorGUI.php.

                                : string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if ($this->edit_request->getString("shape") == "Marker") {
            $this->content_obj->addTriggerMarker();
            $this->page->update();
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_data"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        } else {
            return parent::addNewArea();
        }
        return "";
    }

References ilImageMapEditorGUI\$ctrl, ilImageMapEditorGUI\$lng, and ilLanguage\txt().

Here is the call graph for this function:

confirmDeleteTrigger()

ilPCIIMTriggerEditorGUI::confirmDeleteTrigger

(

)

Confirm trigger deletion.

Definition at line 230 of file class.ilPCIIMTriggerEditorGUI.php.

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $main_tpl = $this->main_tpl;
        $lng = $this->lng;
 
        $trigger = $this->edit_request->getStringArray("tr");
        $titles = $this->edit_request->getStringArray("title");
 
        if (count($trigger) == 0) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editMapAreas");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_really_delete_triggers"));
            $cgui->setCancel($lng->txt("cancel"), "editMapAreas");
            $cgui->setConfirm($lng->txt("delete"), "deleteTrigger");
 
            foreach ($trigger as $i) {
                $cgui->addItem("tr[]", $i, $titles[$i]);
            }
            $main_tpl->setContent($cgui->getHTML());
        }
    }

References $i, and $lng.

deleteTrigger()

ilPCIIMTriggerEditorGUI::deleteTrigger

(

)

Delete trigger.

Exceptions

ilDateTimeException

Definition at line 260 of file class.ilPCIIMTriggerEditorGUI.php.

                                   : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $trigger = $this->edit_request->getStringArray("tr");
 
        if (count($trigger) > 0) {
            foreach ($trigger as $tr_nr) {
                $this->content_obj->deleteTrigger($this->std_alias_item, $tr_nr);
            }
            $this->page->update();
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_areas_deleted"), true);
        }
 
        $ilCtrl->redirect($this, "editMapAreas");
    }

References $lng.

getAdditionalPageXML()

ilPCIIMTriggerEditorGUI::getAdditionalPageXML

(

)

Get additional page xml (to be overwritten)

Reimplemented from ilImageMapEditorGUI.

Definition at line 281 of file class.ilPCIIMTriggerEditorGUI.php.

                                          : string
    {
        return $this->page->getMultimediaXML();
    }

getEditorTitle()

ilPCIIMTriggerEditorGUI::getEditorTitle

(

)

Reimplemented from ilImageMapEditorGUI.

Definition at line 49 of file class.ilPCIIMTriggerEditorGUI.php.

                                    : string
    {
        $lng = $this->lng;
 
        return $lng->txt("cont_pc_iim");
    }

References ilImageMapEditorGUI\$lng, and ilLanguage\txt().

Here is the call graph for this function:

getImageMapTableHTML()

ilPCIIMTriggerEditorGUI::getImageMapTableHTML

(

)

Get trigger table.

Reimplemented from ilPCImageMapEditorGUI.

Definition at line 59 of file class.ilPCIIMTriggerEditorGUI.php.

                                          : string
    {
        $ilToolbar = $this->toolbar;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
 
        $ilToolbar->addText($lng->txt("cont_drag_element_click_save"));
        $ilToolbar->setId("drag_toolbar");
        $ilToolbar->setHidden(true);
        $ilToolbar->addButton($lng->txt("save"), "#", "", null, "", "save_pos_button");
 
        $ilToolbar->addButton(
            $lng->txt("cancel"),
            $ilCtrl->getLinkTarget($this, "editMapAreas")
        );
 
        $image_map_table = new ilPCIIMTriggerTableGUI(
            $this,
            "editMapAreas",
            $this->content_obj,
            $this->getParentNodeName()
        );
        return $image_map_table->getHTML();
    }

References ilImageMapEditorGUI\$ctrl, ilImageMapEditorGUI\$lng, ilImageMapEditorGUI\$toolbar, getParentNodeName(), and ilLanguage\txt().

Here is the call graph for this function:

getParentNodeName()

ilPCIIMTriggerEditorGUI::getParentNodeName

(

)

Reimplemented from ilPCImageMapEditorGUI.

Definition at line 44 of file class.ilPCIIMTriggerEditorGUI.php.

                                       : string
    {
        return "InteractiveImage";
    }

Referenced by getImageMapTableHTML().

Here is the caller graph for this function:

getToolbar()

ilPCIIMTriggerEditorGUI::getToolbar

(

)

Reimplemented from ilImageMapEditorGUI.

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

                                : ilToolbarGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        // toolbar
        $tb = new ilToolbarGUI();
        $tb->setFormAction($ilCtrl->getFormAction($this));
        $options = array(
            "Rect" => $lng->txt("cont_Rect"),
            "Circle" => $lng->txt("cont_Circle"),
            "Poly" => $lng->txt("cont_Poly"),
            "Marker" => $lng->txt("cont_marker")
            );
        $si = new ilSelectInputGUI($lng->txt("cont_trigger_area"), "shape");
        $si->setOptions($options);
        $tb->addInputItem($si, true);
        $tb->addFormButton($lng->txt("add"), "addNewArea");
 
        return $tb;
    }

References ilImageMapEditorGUI\$ctrl, ilImageMapEditorGUI\$lng, and ilLanguage\txt().

Here is the call graph for this function:

initAreaEditingForm()

ilPCIIMTriggerEditorGUI::initAreaEditingForm

(

string

$a_edit_property

)

Init area editing form.

Reimplemented from ilImageMapEditorGUI.

Definition at line 126 of file class.ilPCIIMTriggerEditorGUI.php.

     : ilPropertyFormGUI {
        $lng = $this->lng;
        $form = new ilPropertyFormGUI();
        $form->setOpenTag(false);
        $form->setCloseTag(false);
 
        // name
        if ($a_edit_property != "link" && $a_edit_property != "shape") {
            $ti = new ilTextInputGUI($lng->txt("cont_name"), "area_name");
            $ti->setMaxLength(200);
            $ti->setSize(20);
            //$ti->setRequired(true);
            $form->addItem($ti);
        }
 
        // save and cancel commands
        if ($a_edit_property == "") {
            $form->setTitle($lng->txt("cont_new_trigger_area"));
        } else {
            $form->setTitle($lng->txt("cont_new_area"));
        }
        $form->addCommandButton("saveArea", $lng->txt("save"));
 
        return $form;
    }

outputPostProcessing()

ilPCIIMTriggerEditorGUI::outputPostProcessing

(

string

$a_output

)

Reimplemented from ilImageMapEditorGUI.

Definition at line 286 of file class.ilPCIIMTriggerEditorGUI.php.

                                                          : string
    {
 
        // for question html get the page gui object
        $pg_gui = new ilPageObjectGUI($this->page->getParentType(), $this->page->getId());
        $pg_gui->setOutputMode(ilPageObjectGUI::PREVIEW);
        $pg_gui->getPageConfig()->setEnableSelfAssessment(true);
        //              $pg_gui->initSelfAssessmentRendering(true);             // todo: solve in other way
        $qhtml = $pg_gui->getQuestionHTML();
        if (is_array($qhtml)) {
            foreach ($qhtml as $k => $h) {
                $a_output = str_replace($pg_gui->pl_start . "Question;il__qst_$k" . $pg_gui->pl_end, " " . $h, $a_output);
            }
        }
 
        return $a_output;
    }

References ilPageObjectGUI\PREVIEW.

saveArea()

ilPCIIMTriggerEditorGUI::saveArea

(

)

Save new or updated map area.

Reimplemented from ilPCImageMapEditorGUI.

Definition at line 157 of file class.ilPCIIMTriggerEditorGUI.php.

                              : string
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        switch ($this->map_repo->getMode()) {
            // save edited shape
            case "edit_shape":
                $this->std_alias_item->setShape(
                    $this->map->getAreaNr(),
                    $this->map->getAreaType(),
                    $this->map->getCoords()
                );
                $this->page->update();
                break;
 
            // save new area
            default:
                $area_type = $this->map->getAreaType();
                $coords = $this->map->getCoords();
                $this->content_obj->addTriggerArea(
                    $this->std_alias_item,
                    $area_type,
                    $coords,
                    $this->edit_request->getString("area_name")
                );
                $this->page->update();
                break;
        }
 
        //$this->initMapParameters();
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("cont_saved_map_area"), true);
        $ilCtrl->redirect($this, "editMapAreas");
        return "";
    }

References $lng.

updateTrigger()

ilPCIIMTriggerEditorGUI::updateTrigger

(

)

Update trigger.

Definition at line 196 of file class.ilPCIIMTriggerEditorGUI.php.

                                   : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->content_obj->setTriggerOverlays(
            $this->edit_request->getStringArray("ov")
        );
        $this->content_obj->setTriggerPopups(
            $this->edit_request->getStringArray("pop")
        );
        $this->content_obj->setTriggerOverlayPositions(
            $this->edit_request->getStringArray("ovpos")
        );
        $this->content_obj->setTriggerMarkerPositions(
            $this->edit_request->getStringArray("markpos")
        );
        $this->content_obj->setTriggerPopupPositions(
            $this->edit_request->getStringArray("poppos")
        );
        $this->content_obj->setTriggerPopupSize(
            $this->edit_request->getStringArray("popsize")
        );
        $this->content_obj->setTriggerTitles(
            $this->edit_request->getStringArray("title")
        );
        $this->page->update();
        $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "editMapAreas");
    }

References $lng.

---

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

• Services/COPage/classes/class.ilPCIIMTriggerEditorGUI.php