ilPCIIMTriggerTableGUI Class Reference

TableGUI class for pc image map editor. More...

Inheritance diagram for ilPCIIMTriggerTableGUI:

Collaboration diagram for ilPCIIMTriggerTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_pc_media_object, $a_parent_node_name)
	Constructor.
	initColumns ()
	Init columns.
	initActions ()
	Init actions.
	getItems ()
	Get items of current folder.
Public Member Functions inherited from ilImageMapTableGUI
	__construct ($a_parent_obj, $a_parent_cmd, $a_media_object)
	Constructor.
Public Member Functions inherited from ilTable2GUI
	setOpenFormTag ($a_val)
	Set open form tag.
	getOpenFormTag ()
	Get open form tag.
	setCloseFormTag ($a_val)
	Set close form tag.
	getCloseFormTag ()
	Get close form tag.
	determineLimit ()
	Determine the limit.
	getSelectableColumns ()
	Get selectable columns.
	determineSelectedColumns ()
	Determine selected columns.
	isColumnSelected ($a_col)
	Is given column selected?
	getSelectedColumns ()
	Get selected columns.
&	executeCommand ()
	Execute command.
	resetOffset ($a_in_determination=false)
	Reset offset.
	initFilter ()
	Init filter.
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setTopAnchor ($a_val)
	Set top anchor.
	getTopAnchor ()
	Get top anchor.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setIsDataTable ($a_val)
	Set is data table.
	getIsDataTable ()
	Get is data table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setEnableNumInfo ($a_val)
	Set enable num info.
	getEnableNumInfo ()
	Get enable num info.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon.
	setDescription ($a_val)
	Set description.
	getDescription ()
	Get description.
	setOrderField ($a_order_field)
	set order column
	getOrderField ()
	setData ($a_data)
	set table data public
	getData ()
	dataExists ()
	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public
	getPrefix ()
	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item.
	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
	Add filter by standard type.
	getFilterItems ($a_optionals=false)
	Get filter items.
	getFilterItemByPostVar ($a_post_var)
	setFilterCols ($a_val)
	Set filter columns.
	getFilterCols ()
	Get filter columns.
	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding.
	getDisableFilterHiding ()
	Get disable filter hiding.
	isFilterSelected ($a_col)
	Is given filter selected?
	getSelectedFilters ()
	Get selected filters.
	determineSelectedFilters ()
	Determine selected filters.
	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links.
	setFormAction ($a_form_action)
	Set Form action parameter.
	getFormAction ()
	Get Form action parameter.
	setFormName ($a_formname)
	Set Form name.
	getFormName ()
	Get Form name.
	setId ($a_val)
	Set id.
	getId ()
	Get element id.
	setDisplayAsBlock ($a_val)
	Set display as block.
	getDisplayAsBlock ()
	Get display as block.
	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button.
	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button.
	setExternalSorting ($a_val)
	Set external sorting.
	getExternalSorting ()
	Get external sorting.
	setFilterCommand ($a_val)
	Set filter command.
	getFilterCommand ()
	Get filter command.
	setResetCommand ($a_val)
	Set reset filter command.
	getResetCommand ()
	Get reset filter command.
	setExternalSegmentation ($a_val)
	Set external segmentation.
	getExternalSegmentation ()
	Get external segmentation.
	setRowTemplate ($a_template, $a_template_dir="")
	Set row template.
	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field.
	getDefaultOrderField ()
	Get Default order field.
	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction.
	getDefaultOrderDirection ()
	Get Default order direction.
	clearCommandButtons ()
	addCommandButton ($a_cmd, $a_text, $a_onclick= '', $a_id="")
	Add Command button.
	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button.
	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button for selected items.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too)
	getTopCommands ()
	Get top commands (display command buttons on top of table, too)
	addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order.
	storeNavParameter ()
	getHTML ()
	Get HTML.
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	writeFilterToSession ()
	Write filter values to session.
	resetFilter ()
	Reset filter.
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	fillHiddenRow ()
	fillActionRow ()
	Fill Action Row.
	setHeaderHTML ($html)
	set header html
	storeProperty ($type, $value)
	Store table property.
	loadProperty ($type)
	Load table property.
	getCurrentState ()
	get current settings for order, limit, columns and filter
	setContext ($id)
	Set context.
	getContext ()
	Get context.
	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector.
	getShowRowsSelector ()
	Get rows-per-page selector state.
	setShowTemplates ($a_value)
	Toggle templates.
	getShowTemplates ()
	Get template state.
	restoreTemplate ($a_name)
	Restore state from template.
	saveTemplate ($a_name)
	Save current state as template.
	deleteTemplate ($a_name)
	Delete template.
	getLimit ()
	Get limit.
	getOffset ()
	Get offset.
	setExportFormats (array $formats)
	Set available export formats.
	setPrintMode ($a_value=false)
	Toogle print mode.
	getPrintMode ()
	Get print mode.
	getExportMode ()
	Was export activated?
	exportData ($format, $send=false)
	Export and optionally send current table data.
Public Member Functions inherited from ilTableGUI
	ilTableGUI ($a_data=0, $a_global_tpl=true)
	Constructor.
	setTemplate (&$a_tpl)
	set template public
&	getTemplateObject ()
	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public
	setHeaderNames ($a_header_names)
	set table header names public
	getColumnCount ()
	Returns the column count based on the number of the header row columns public.
	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public
	setColumnWidth ($a_column_width)
	set table column widths public
	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public
	setMaxCount ($a_max_count)
	set max.
	setLimit ($a_limit=0, $a_default_limit=0)
	set max.
	setOffset ($a_offset)
	set dataset offset public
	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public
	getOrderColumn ()
	Get order column.
	setOrderDirection ($a_order_direction)
	set order direction public
	getOrderDirection ()
	Get order direction.
	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public
	enable ($a_module_name)
	enables particular modules of table
	disable ($a_module_name)
	diesables particular modules of table
	sortData ()
	renderHeader ()
	setStyle ($a_element, $a_style)
	getStyle ($a_element)
	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds).
	getBase ()
	Get Base script name (deprecated, only use this for workarounds).
	clearActionButtons ()
	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	fillRow ($a_set)
	Standard Version of Fill Row.

Additional Inherited Members
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
Protected Attributes inherited from ilTable2GUI
	$close_command = ""
	$top_anchor = "il_table_top"
	$filters = array()
	$optional_filters = array()
	$filter_cmd = 'applyFilter'
	$reset_cmd = 'resetFilter'
	$filter_cols = 4
	$ext_sort = false
	$ext_seg = false
	$context = ""
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$selected_filter = false
	$top_commands = true
	$selectable_columns = array()
	$selected_column = array()
	$show_templates = false
	$show_rows_selector = false
	$nav_determined = false
	$limit_determined = false
	$filters_determined = false
	$columns_determined = false
	$open_form_tag = true
	$close_form_tag = true
	$export_formats
	$export_mode
	$print_mode

Detailed Description

TableGUI class for pc image map editor.

Author

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

Version

$Id$

Definition at line 16 of file class.ilPCIIMTriggerTableGUI.php.

Constructor & Destructor Documentation

ilPCIIMTriggerTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_pc_media_object,
			$a_parent_node_name
	)

Constructor.

Definition at line 22 of file class.ilPCIIMTriggerTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\setId(), and ilTable2GUI\setRowTemplate().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;
                
                $this->setId("cont_iim_tr");

                $this->parent_node_name = $a_parent_node_name;
                $this->pc_media_object = $a_pc_media_object;
                $this->mob = $this->pc_media_object->getMediaObject();
                
                $this->areas = array();
                foreach ($this->pc_media_object->getStandardAliasItem()->getMapAreas() as $a)
                {
                        $this->area[$a["Id"]] = $a;
                }

                $this->ov_files = $this->mob->getFilesOfDirectory("overlays");
                $this->ov_options = array("" => $lng->txt("please_select"));
                foreach ($this->ov_files as $of)
                {
                        $this->ov_options[$of] = $of;
                }
                $this->popups = $this->pc_media_object->getPopups();
                $this->pop_options = array("" => $lng->txt("please_select"));
                foreach ($this->popups as $k => $p)
                {
                        $this->pop_options[$p["nr"]] = $p["title"];
                }
                parent::__construct($a_parent_obj, $a_parent_cmd, $a_pc_media_object->getMediaObject());
                $this->setRowTemplate("tpl.iim_trigger_row.html", "Services/COPage");
        }

Here is the call graph for this function:

Member Function Documentation

ilPCIIMTriggerTableGUI::fillRow (   $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilImageMapTableGUI.

Definition at line 102 of file class.ilPCIIMTriggerTableGUI.php.

References $ilCtrl, $lng, ilPCInteractiveImage\AREA, and ilUtil\formSelect().

        {
                global $lng, $ilCtrl, $ilAccess;
//var_dump($a_set);

                $i = $a_set["Nr"];

                // command: edit marker position
                if ($a_set["Overlay"] != "")
                {
                        $this->tpl->setCurrentBlock("cmd");
                        $this->tpl->setVariable("CMD_ID", "ov_".$i);
                        $this->tpl->setVariable("HREF_CMD", "#");
                        $this->tpl->setVariable("CMD_CLASS", "ov_cmd");
                        $this->tpl->setVariable("TXT_CMD", $lng->txt("cont_edit_overlay_position"));
                        $this->tpl->parseCurrentBlock();
                }
                
                // command: edit marker position
                if ($a_set["PopupNr"] != "")
                {
                        $this->tpl->setCurrentBlock("cmd");
                        $this->tpl->setVariable("CMD_ID", "pop_".$i);
                        $this->tpl->setVariable("HREF_CMD", "#");
                        $this->tpl->setVariable("CMD_CLASS", "pop_cmd");
                        $this->tpl->setVariable("TXT_CMD", $lng->txt("cont_edit_popup_position"));
                        $this->tpl->parseCurrentBlock();
                }
                
                if ($a_set["Type"] == ilPCInteractiveImage::AREA)
                {
                        $this->tpl->setCurrentBlock("coords");
                        $this->tpl->setVariable("VAL_COORDS",
                                implode(explode(",", $this->area[$a_set["Nr"]]["Coords"]), ", "));
                        $this->tpl->parseCurrentBlock();
                        
                        $this->tpl->setVariable("TYPE",
                                $lng->txt("cont_".$this->area[$a_set["Nr"]]["Shape"]));
                }
                else
                {
                        // command: edit marker position
                        $this->tpl->setCurrentBlock("cmd");
                        $this->tpl->setVariable("CMD_ID", "mark_".$i);
                        $this->tpl->setVariable("HREF_CMD", "#");
                        $this->tpl->setVariable("CMD_CLASS", "mark_cmd");
                        $this->tpl->setVariable("TXT_CMD", $lng->txt("cont_edit_marker_position"));
                        $this->tpl->parseCurrentBlock();
                        
                        // marker position
                        $this->tpl->setCurrentBlock("marker_pos");
                        $this->tpl->setVariable("VAR_MARK_POS", "markpos[".$i."]");
                        $this->tpl->setVariable("ID_MARK_POS", "markpos_".$i);
                        $this->tpl->setVariable("VAL_MARK_POS", $a_set["MarkerX"].",".$a_set["MarkerY"]);
                        $this->tpl->setVariable("TXT_MLEFT", $lng->txt("cont_left"));
                        $this->tpl->setVariable("TXT_MTOP", $lng->txt("cont_top"));
                        $this->tpl->parseCurrentBlock();
                        
                        $this->tpl->setVariable("TYPE", $lng->txt("cont_marker"));
                }

                $this->tpl->setVariable("CHECKBOX",
                        ilUtil::formCheckBox("", "tr[]", $i));
                $this->tpl->setVariable("VAR_NAME", "title[".$i."]");
                $this->tpl->setVariable("VAL_NAME", $a_set["Title"]);
                
                
                $this->tpl->setVariable("VAR_POS", "ovpos[".$i."]");
                $this->tpl->setVariable("ID_OV_POS", "ovpos_".$i);
                $this->tpl->setVariable("ID_POP_POS", "poppos_".$i);
                $this->tpl->setVariable("VAR_POP_POS", "poppos[".$i."]");
                $this->tpl->setVariable("VAR_POP_SIZE", "popsize[".$i."]");
                $this->tpl->setVariable("VAL_POS", $a_set["OverlayX"].",".$a_set["OverlayY"]);
                $this->tpl->setVariable("VAL_POP_POS", $a_set["PopupX"].",".$a_set["PopupY"]);
                $this->tpl->setVariable("VAL_POP_SIZE", $a_set["PopupWidth"].",".$a_set["PopupHeight"]);
                $this->tpl->setVariable("TXT_IMG", $lng->txt("image"));
                $this->tpl->setVariable("TXT_TITLE", $lng->txt("title"));
                $this->tpl->setVariable("TXT_LEFT", $lng->txt("cont_left"));
                $this->tpl->setVariable("TXT_TOP", $lng->txt("cont_top"));
                $this->tpl->setVariable("TXT_WIDTH", $lng->txt("cont_width"));
                $this->tpl->setVariable("TXT_HEIGHT", $lng->txt("cont_height"));
                $this->tpl->setVariable("OVERLAY_IMAGE",
                        ilUtil::formSelect($a_set["Overlay"], "ov[".$i."]", $this->ov_options, false, true));
                $this->tpl->setVariable("CONTENT_POPUP",
                        ilUtil::formSelect($a_set["PopupNr"], "pop[".$i."]", $this->pop_options, false, true));
        }

Here is the call graph for this function:

ilPCIIMTriggerTableGUI::getItems

(

)

Get items of current folder.

Reimplemented from ilImageMapTableGUI.

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

References ilTable2GUI\setData(), and ilUtil\sortArray().

        {
                $triggers = $this->pc_media_object->getTriggers();
                
                $triggers = ilUtil::sortArray($triggers, "Title", "asc", false, true);
                $this->setData($triggers);
        }

Here is the call graph for this function:

ilPCIIMTriggerTableGUI::initActions

(

)

Init actions.

Reimplemented from ilImageMapTableGUI.

Definition at line 72 of file class.ilPCIIMTriggerTableGUI.php.

References ilTableGUI\$data, $lng, ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), and ilTable2GUI\getData().

        {
                global $lng;
                
                // action commands
                $this->addMultiCommand("confirmDeleteTrigger", $lng->txt("delete"));
                
                $data = $this->getData();
                if (count($data) > 0)
                {
                        $this->addCommandButton("updateTrigger", $lng->txt("save"), "", "update_tr_button");
                }
        }

Here is the call graph for this function:

ilPCIIMTriggerTableGUI::initColumns

(

)

Init columns.

Reimplemented from ilImageMapTableGUI.

Definition at line 58 of file class.ilPCIIMTriggerTableGUI.php.

References ilTable2GUI\addColumn().

        {
                $this->addColumn("", "", "1");  // checkbox
                $this->addColumn($this->lng->txt("title"), "Title", "");
                $this->addColumn($this->lng->txt("type"), "", "");
                $this->addColumn($this->lng->txt("cont_coords"), "", "");
                $this->addColumn($this->lng->txt("cont_overlay_image"), "", "");
                $this->addColumn($this->lng->txt("cont_content_popup"), "", "");
                $this->addColumn($this->lng->txt("actions"), "", "");
        }

Here is the call graph for this function:

---

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

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