ilImageMapTableGUI Class Reference
TableGUI class for image map editor. More...
Inheritance diagram for ilImageMapTableGUI:
Collaboration diagram for ilImageMapTableGUI:
Public Member Functions | |
| __construct ($a_parent_obj, $a_parent_cmd, $a_media_object) | |
| Constructor. More... | |
| initColumns () | |
| Init columns. More... | |
| initActions () | |
| Init actions. More... | |
| getItems () | |
| Get items of current folder. More... | |
| Public Member Functions inherited from ilTable2GUI | |
| __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
| ilTable2GUI constructor. More... | |
| setOpenFormTag ($a_val) | |
| Set open form tag. More... | |
| getOpenFormTag () | |
| Get open form tag. More... | |
| setCloseFormTag ($a_val) | |
| Set close form tag. More... | |
| getCloseFormTag () | |
| Get close form tag. More... | |
| determineLimit () | |
| Determine the limit. More... | |
| getSelectableColumns () | |
| Get selectable columns. More... | |
| determineSelectedColumns () | |
| Determine selected columns. More... | |
| isColumnSelected ($a_col) | |
| Is given column selected? More... | |
| getSelectedColumns () | |
| Get selected columns. More... | |
| executeCommand () | |
| Execute command. More... | |
| resetOffset ($a_in_determination=false) | |
| Reset offset. More... | |
| initFilter () | |
| Init filter. More... | |
| getParentObject () | |
| Get parent object. More... | |
| getParentCmd () | |
| Get parent command. More... | |
| setTopAnchor ($a_val) | |
| Set top anchor. More... | |
| getTopAnchor () | |
| Get top anchor. More... | |
| setNoEntriesText ($a_text) | |
| Set text for an empty table. More... | |
| getNoEntriesText () | |
| Get text for an empty table. More... | |
| setIsDataTable ($a_val) | |
| Set is data table. More... | |
| getIsDataTable () | |
| Get is data table. More... | |
| setEnableTitle ($a_enabletitle) | |
| Set Enable Title. More... | |
| getEnableTitle () | |
| Get Enable Title. More... | |
| setEnableHeader ($a_enableheader) | |
| Set Enable Header. More... | |
| getEnableHeader () | |
| Get Enable Header. More... | |
| setEnableNumInfo ($a_val) | |
| Set enable num info. More... | |
| getEnableNumInfo () | |
| Get enable num info. More... | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| Set title and title icon. More... | |
| setDescription ($a_val) | |
| Set description. More... | |
| getDescription () | |
| Get description. More... | |
| setOrderField ($a_order_field) | |
| set order column More... | |
| getOrderField () | |
| setData ($a_data) | |
| set table data @access public More... | |
| 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) @access public More... | |
| getPrefix () | |
| addFilterItem ($a_input_item, $a_optional=false) | |
| Add filter item. More... | |
| addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null) | |
| Add filter by standard type. More... | |
| getFilterItems ($a_optionals=false) | |
| Get filter items. More... | |
| getFilterItemByPostVar ($a_post_var) | |
| setFilterCols ($a_val) | |
| Set filter columns. More... | |
| getFilterCols () | |
| Get filter columns. More... | |
| setDisableFilterHiding ($a_val=true) | |
| Set disable filter hiding. More... | |
| getDisableFilterHiding () | |
| Get disable filter hiding. More... | |
| isFilterSelected ($a_col) | |
| Is given filter selected? More... | |
| getSelectedFilters () | |
| Get selected filters. More... | |
| determineSelectedFilters () | |
| Determine selected filters. More... | |
| setCustomPreviousNext ($a_prev_link, $a_next_link) | |
| Set custom previous/next links. More... | |
| setFormAction ($a_form_action, $a_multipart=false) | |
| Set Form action parameter. More... | |
| getFormAction () | |
| Get Form action parameter. More... | |
| setFormName ($a_formname="") | |
| Set Form name. More... | |
| getFormName () | |
| Get Form name. More... | |
| setId ($a_val) | |
| Set id. More... | |
| getId () | |
| Get element id. More... | |
| setDisplayAsBlock ($a_val) | |
| Set display as block. More... | |
| getDisplayAsBlock () | |
| Get display as block. More... | |
| getSelectAllCheckbox () | |
| Get the name of the checkbox that should be toggled with a select all button. More... | |
| setSelectAllCheckbox ($a_select_all_checkbox) | |
| Set the name of the checkbox that should be toggled with a select all button. More... | |
| setExternalSorting ($a_val) | |
| Set external sorting. More... | |
| getExternalSorting () | |
| Get external sorting. More... | |
| setFilterCommand ($a_val, $a_caption=null) | |
| Set filter command. More... | |
| getFilterCommand () | |
| Get filter command. More... | |
| setResetCommand ($a_val, $a_caption=null) | |
| Set reset filter command. More... | |
| getResetCommand () | |
| Get reset filter command. More... | |
| setExternalSegmentation ($a_val) | |
| Set external segmentation. More... | |
| getExternalSegmentation () | |
| Get external segmentation. More... | |
| setRowTemplate ($a_template, $a_template_dir="") | |
| Set row template. More... | |
| setDefaultOrderField ($a_defaultorderfield) | |
| Set Default order field. More... | |
| getDefaultOrderField () | |
| Get Default order field. More... | |
| setDefaultOrderDirection ($a_defaultorderdirection) | |
| Set Default order direction. More... | |
| getDefaultOrderDirection () | |
| Get Default order direction. More... | |
| setDefaultFilterVisiblity ($a_status) | |
| Set default filter visiblity. More... | |
| getDefaultFilterVisibility () | |
| Get default filter visibility. More... | |
| clearCommandButtons () | |
| addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null) | |
| Add Command button. More... | |
| addCommandButtonInstance (ilButtonBase $a_button) | |
| Add Command button instance. More... | |
| addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button. More... | |
| addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='') | |
| Add Selection List + Command button for selected items. More... | |
| setCloseCommand ($a_link) | |
| Add command for closing table. More... | |
| addMultiCommand ($a_cmd, $a_text) | |
| Add Command button. More... | |
| addHiddenInput ($a_name, $a_value) | |
| Add Hidden Input field. More... | |
| addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="") | |
| Add Header Command (Link) (Image needed for now) More... | |
| setTopCommands ($a_val) | |
| Set top commands (display command buttons on top of table, too) More... | |
| getTopCommands () | |
| Get top commands (display command buttons on top of table, too) More... | |
| addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false) | |
| Add a column to the header. More... | |
| getNavParameter () | |
| setOrderLink ($sort_field, $order_dir) | |
| fillHeader () | |
| determineOffsetAndOrder ($a_omit_offset=false) | |
| Determine offset and order. More... | |
| storeNavParameter () | |
| getHTML () | |
| Get HTML. More... | |
| numericOrdering ($a_field) | |
| Should this field be sorted numeric? More... | |
| render () | |
| render table @access public More... | |
| writeFilterToSession () | |
| Write filter values to session. More... | |
| resetFilter () | |
| Reset filter. More... | |
| fillFooter () | |
| Fill footer row. More... | |
| getLinkbar ($a_num) | |
| Get previous/next linkbar. More... | |
| fillHiddenRow () | |
| fillActionRow () | |
| Fill Action Row. More... | |
| setHeaderHTML ($html) | |
| set header html More... | |
| storeProperty ($type, $value) | |
| Store table property. More... | |
| loadProperty ($type) | |
| Load table property. More... | |
| getCurrentState () | |
| get current settings for order, limit, columns and filter More... | |
| setContext ($id) | |
| Set context. More... | |
| getContext () | |
| Get context. More... | |
| setShowRowsSelector ($a_value) | |
| Toggle rows-per-page selector. More... | |
| getShowRowsSelector () | |
| Get rows-per-page selector state. More... | |
| setShowTemplates ($a_value) | |
| Toggle templates. More... | |
| getShowTemplates () | |
| Get template state. More... | |
| restoreTemplate ($a_name) | |
| Restore state from template. More... | |
| saveTemplate ($a_name) | |
| Save current state as template. More... | |
| deleteTemplate ($a_name) | |
| Delete template. More... | |
| getLimit () | |
| Get limit. More... | |
| getOffset () | |
| Get offset. More... | |
| setExportFormats (array $formats) | |
| Set available export formats. More... | |
| setPrintMode ($a_value=false) | |
| Toogle print mode. More... | |
| getPrintMode () | |
| Get print mode. More... | |
| getExportMode () | |
| Was export activated? More... | |
| exportData ($format, $send=false) | |
| Export and optionally send current table data. More... | |
| setEnableAllCommand ($a_value) | |
| Enable actions for all entries in current result. More... | |
| setRowSelectorLabel ($row_selector_label) | |
| getRowSelectorLabel () | |
| setPreventDoubleSubmission ($a_val) | |
| Set prevent double submission. More... | |
| getPreventDoubleSubmission () | |
| Get prevent double submission. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| Public Member Functions inherited from ilTableGUI | |
| __construct ($a_data=0, $a_global_tpl=true) | |
| Constructor. More... | |
| setTemplate ($a_tpl) | |
| set template @access public More... | |
| & | getTemplateObject () |
| setData ($a_data) | |
| set table data @access public More... | |
| getData () | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| set table title @access public More... | |
| setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0) | |
| set table help page @access public More... | |
| setHeaderNames ($a_header_names) | |
| set table header names @access public More... | |
| getColumnCount () | |
| Returns the column count based on the number of the header row columns @access public. More... | |
| setHeaderVars ($a_header_vars, $a_header_params=0) | |
| set table header vars @access public More... | |
| setColumnWidth ($a_column_width) | |
| set table column widths @access public More... | |
| setOneColumnWidth ($a_column_width, $a_column_number) | |
| set one table column width @access public More... | |
| setMaxCount ($a_max_count) | |
| set max. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| getLimit () | |
| Get limit. More... | |
| 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) @access public More... | |
| setOffset ($a_offset) | |
| set dataset offset @access public More... | |
| getOffset () | |
| Get offset. More... | |
| setOrderColumn ($a_order_column=0, $a_default_column=0) | |
| set order column @access public More... | |
| getOrderColumn () | |
| Get order column. More... | |
| setOrderDirection ($a_order_direction) | |
| set order direction @access public More... | |
| getOrderDirection () | |
| Get order direction. More... | |
| setFooter ($a_style, $a_previous=0, $a_next=0) | |
| set order direction @access public More... | |
| enable ($a_module_name) | |
| enables particular modules of table More... | |
| disable ($a_module_name) | |
| diesables particular modules of table More... | |
| sortData () | |
| render () | |
| render table @access public More... | |
| renderHeader () | |
| setOrderLink ($key, $order_dir) | |
| setStyle ($a_element, $a_style) | |
| getStyle ($a_element) | |
| setBase ($a_base) | |
| Set Base script name (deprecated, only use this for workarounds). More... | |
| getBase () | |
| Get Base script name (deprecated, only use this for workarounds). More... | |
| getFormName () | |
| setFormName ($a_name="cmd") | |
| getSelectAllCheckbox () | |
| setSelectAllCheckbox ($a_select_all_checkbox) | |
| clearActionButtons () | |
| addActionButton ($btn_name, $btn_value) | |
Protected Member Functions | |
| fillRow ($a_set) | |
| Standard Version of Fill Row. More... | |
| Protected Member Functions inherited from ilTable2GUI | |
| prepareOutput () | |
| Anything that must be done before HTML is generated. More... | |
| isFilterVisible () | |
| Check if filter is visible: manually shown (session, db) or default value set. More... | |
| isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element) | |
| Check if filter element is based on adv md. More... | |
| fillRow ($a_set) | |
| Standard Version of Fill Row. More... | |
| getFilterValue (ilFormPropertyGUI $a_item) | |
| Get current filter value. More... | |
| SetFilterValue (ilFormPropertyGUI $a_item, $a_value) | |
| Set current filter value. More... | |
| fillMetaExcel (ilExcel $a_excel, &$a_row) | |
| Add meta information to excel export. More... | |
| fillHeaderExcel (ilExcel $a_excel, &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel (ilExcel $a_excel, &$a_row, $a_set) | |
| Excel Version of Fill Row. More... | |
| fillMetaCSV ($a_csv) | |
| Add meta information to csv export. More... | |
| fillHeaderCSV ($a_csv) | |
| CSV Version of Fill Header. More... | |
| fillRowCSV ($a_csv, $a_set) | |
| CSV Version of Fill Row. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilTable2GUI | |
| static | getAllCommandLimit () |
| Get maximum number of entries to enable actions for all. More... | |
| 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 | FILTER_DATETIME_RANGE = 8 |
| const | FILTER_CHECKBOX = 9 |
| const | EXPORT_EXCEL = 1 |
| const | EXPORT_CSV = 2 |
| const | ACTION_ALL_LIMIT = 1000 |
| Data Fields inherited from ilTableGUI | |
| $title | |
| $icon | |
| $icon_alt | |
| $help_page | |
| $help_icon | |
| $help_icon_alt | |
| $header_names | |
| $header_vars | |
| $linkbar_vars | |
| $data | |
| $column_count | |
| $column_width | |
| $max_count | |
| $limit | |
| $max_limit = false | |
| $offset | |
| $order_column | |
| $order_direction | |
| $footer_style | |
| $footer_previous | |
| $footer_next | |
| $lang_support = true | |
| $global_tpl | |
| $form_name | |
| $select_all_checkbox | |
| $action_buttons | |
| $prefix | |
| $base = "" | |
| $enabled | |
| $styles | |
Detailed Description
TableGUI class for image map editor.
- Version
- $Id$
Definition at line 15 of file class.ilImageMapTableGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilImageMapTableGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd, | |||
| $a_media_object | |||
| ) |
Constructor.
Reimplemented from ilTable2GUI.
Definition at line 31 of file class.ilImageMapTableGUI.php.
32 {
33 global $DIC;
34
35 $this->ctrl = $DIC->ctrl();
36 $this->lng = $DIC->language();
37 $this->access = $DIC->access();
40 $ilAccess = $DIC->access();
42
43 parent::__construct($a_parent_obj, $a_parent_cmd);
44 $this->media_object = $a_media_object;
45
46 include_once("./Services/MediaObjects/classes/class.ilMapArea.php");
47 $this->highl_modes = ilMapArea::getAllHighlightModes();
48 $this->highl_classes = ilMapArea::getAllHighlightClasses();
49
50 $this->initColumns();
54 $this->getItems();
55
56 // action commands
57 $this->initActions();
58
62 }
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1108
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1119
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:919
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1139
References $DIC, $ilCtrl, ilTableGUI\$lng, ilMapArea\getAllHighlightClasses(), ilMapArea\getAllHighlightModes(), getItems(), initActions(), initColumns(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), and ilTable2GUI\setRowTemplate().
Here is the call graph for this function:
Member Function Documentation
◆ fillRow()
|
protected |
Standard Version of Fill Row.
Most likely to be overwritten by derived class.
Reimplemented from ilTable2GUI.
Reimplemented in ilPCIIMTriggerTableGUI, and ilPCImageMapTableGUI.
Definition at line 122 of file class.ilImageMapTableGUI.php.
123 {
126 $ilAccess = $this->access;
127
128 $area = $a_set["area"];
130 $this->tpl->setVariable(
131 "CHECKBOX",
133 );
136 $this->tpl->setVariable("VAL_SHAPE", $area->getShape());
137
138 $this->tpl->setVariable(
139 "VAL_HIGHL_MODE",
140 ilUtil::formSelect(
141 $area->getHighlightMode(),
143 $this->highl_modes,
144 false,
145 true
146 )
147 );
148 $this->tpl->setVariable(
149 "VAL_HIGHL_CLASS",
150 ilUtil::formSelect(
151 $area->getHighlightClass(),
153 $this->highl_classes,
154 false,
155 true
156 )
157 );
158
159 $this->tpl->setVariable(
160 "VAL_COORDS",
161 implode(explode(",", $area->getCoords()), ", ")
162 );
163 switch ($area->getLinkType()) {
164 case "ext":
165 $this->tpl->setVariable("VAL_LINK", $area->getHRef());
166 break;
167
168 case "int":
169 $link_str = $this->parent_obj->getMapAreaLinkString(
170 $area->getTarget(),
171 $area->getType(),
172 $area->getTargetFrame()
173 );
174 $this->tpl->setVariable("VAL_LINK", $link_str);
175 break;
176 }
177 }
static formSelect( $selected, $varname, $options, $multiple=false, $direct_text=false, $size="0", $style_class="", $attribs="", $disabled=false)
Builds a select form field with options and shows the selected option first.
Definition: class.ilUtil.php:328
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public
Definition: class.ilUtil.php:2855
References $access, $ctrl, $i, $ilCtrl, ilTableGUI\$lng, ilUtil\formSelect(), and ilUtil\prepareFormOutput().
Here is the call graph for this function:
◆ getItems()
| ilImageMapTableGUI::getItems | ( | ) |
Get items of current folder.
Reimplemented in ilPCIIMTriggerTableGUI, and ilPCImageMapTableGUI.
Definition at line 103 of file class.ilImageMapTableGUI.php.
104 {
105 $st_item = $this->media_object->getMediaItem("Standard");
106 $max = ilMapArea::_getMaxNr($st_item->getId());
107 $areas = array();
108
109 include_once("./Services/MediaObjects/classes/class.ilMapArea.php");
113 }
114
115 $this->setData($areas);
116 }
static _getMaxNr($a_item_id)
get maximum nr of media item (static)
Definition: class.ilMapArea.php:114
References $i, ilMapArea\_getMaxNr(), and ilTable2GUI\setData().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ initActions()
| ilImageMapTableGUI::initActions | ( | ) |
Init actions.
Reimplemented in ilPCIIMTriggerTableGUI.
Definition at line 81 of file class.ilImageMapTableGUI.php.
82 {
84
85 // action commands
92
96 }
97 }
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
Definition: class.ilTable2GUI.php:1188
References ilTableGUI\$data, ilTableGUI\$lng, ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), and ilTable2GUI\getData().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ initColumns()
| ilImageMapTableGUI::initColumns | ( | ) |
Init columns.
Reimplemented in ilPCIIMTriggerTableGUI.
Definition at line 67 of file class.ilImageMapTableGUI.php.
68 {
76 }
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1309
References ilTable2GUI\addColumn().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
Field Documentation
◆ $access
|
protected |
Definition at line 25 of file class.ilImageMapTableGUI.php.
Referenced by fillRow().
◆ $ctrl
|
protected |
Definition at line 20 of file class.ilImageMapTableGUI.php.
Referenced by fillRow().
The documentation for this class was generated from the following file:
- Services/MediaObjects/classes/class.ilImageMapTableGUI.php
