ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilStyleTableGUI Class Reference

TableGUI class for style editor. More...

+ Inheritance diagram for ilStyleTableGUI:
+ Collaboration diagram for ilStyleTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_chars, $a_super_type, $a_style)
 Constructor.
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="")
 Constructor.
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.
 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 disable filter hiding.
 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= '')
 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="")
 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
- 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.
 getLimit ()
 Get limit.
 setOffset ($a_offset)
 set dataset offset public
 getOffset ()
 Get offset.
 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.
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated.

Additional Inherited Members

- 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
- 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
 $mi_sel_buttons = null
 $disable_filter_hiding = false
 $top_commands = false

Detailed Description

TableGUI class for style editor.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 34 of file class.ilStyleTableGUI.php.

Constructor & Destructor Documentation

ilStyleTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_chars,
  $a_super_type,
  $a_style 
)

Constructor.

Definition at line 40 of file class.ilStyleTableGUI.php.

References $ilCtrl, $lng, $t, ilObjStyleSheet\_getCoreStyles(), ilObjStyleSheet\_getStyleSuperTypes(), ilObjStyleSheet\_isExpandable(), ilObjStyleSheet\_isHideable(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ilTable2GUI\setData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng, $ilAccess, $lng;
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->media_object = $a_media_object;
$this->super_type = $a_super_type;
$this->style = $a_style;
$this->types = $all_super_types[$this->super_type];
$this->core_styles = ilObjStyleSheet::_getCoreStyles();
$this->setData($a_chars);
$this->setTitle($lng->txt("sty_".$a_super_type."_char"));
$this->setLimit(9999);
// check, whether any of the types is expandable
$this->expandable = false;
$this->hideable = false;
foreach ($this->types as $t)
{
{
$this->expandable = true;
}
{
$this->hideable = true;
}
}
if ($this->expandable)
{
$this->addColumn("", "", "1"); // checkbox
}
$this->addColumn($this->lng->txt("sty_name"), "", "1");
$this->addColumn($this->lng->txt("sty_type"), "", "");
$this->addColumn($this->lng->txt("sty_example"), "", "");
if ($this->hideable)
{
$this->addColumn($this->lng->txt("sty_hide"), "", ""); // hide checkbox
}
$this->addColumn($this->lng->txt("sty_commands"), "", "1");
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->setRowTemplate("tpl.style_row.html", "Services/Style");
$this->disable("footer");
// action commands
if ($this->hideable)
{
$this->addCommandButton("saveHideStatus", $lng->txt("sty_save_hide_status"));
}
// action commands
if ($this->expandable)
{
$this->addMultiCommand("deleteCharacteristicConfirmation", $lng->txt("delete"));
$this->addCommandButton("addCharacteristicForm", $lng->txt("sty_add_characteristic"));
}
$this->setEnableTitle(true);
}

+ Here is the call graph for this function:

Member Function Documentation

ilStyleTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, ilObjStyleSheet\_determineTag(), ilObjStyleSheet\_getStyleSuperTypes(), ilObjStyleSheet\_isHideable(), and ilObjStyleSheetGUI\getStyleExampleHTML().

{
global $lng, $ilCtrl, $ilAccess;
$types = $stypes[$this->super_type];
if (!in_array($a_set["type"], $types))
{
return;
}
//var_dump($a_set);
// checkbox row
if ($this->expandable)
{
if (!empty($this->core_styles[$a_set["type"].".".
".".$a_set["class"]]))
{
$this->tpl->touchBlock("no_checkbox");
}
else
{
$this->tpl->setCurrentBlock("checkbox");
$this->tpl->setVariable("CHAR", $a_set["type"].".".
".".$a_set["class"]);
$this->tpl->parseCurrentBlock();
}
}
if ($this->hideable)
{
if (!ilObjStyleSheet::_isHideable($a_set["type"]) ||
(!empty($this->core_styles[$a_set["type"].".".
".".$a_set["class"]])))
{
$this->tpl->touchBlock("no_hide_checkbox");
}
else
{
$this->tpl->setCurrentBlock("hide_checkbox");
$this->tpl->setVariable("CHAR", $a_set["type"].".".
".".$a_set["class"]);
if ($this->style->getHideStatus($a_set["type"], $a_set["class"]))
{
$this->tpl->setVariable("CHECKED", "checked='checked'");
}
$this->tpl->parseCurrentBlock();
}
}
// example
$this->tpl->setVariable("EXAMPLE",
ilObjStyleSheetGUI::getStyleExampleHTML($a_set["type"], $a_set["class"]));
$tag_str = ilObjStyleSheet::_determineTag($a_set["type"]).".".$a_set["class"];
$this->tpl->setVariable("TXT_TAG", $a_set["class"]);
$this->tpl->setVariable("TXT_TYPE", $lng->txt("sty_type_".$a_set["type"]));
$this->tpl->setVariable("TXT_EDIT", $this->lng->txt("edit"));
$ilCtrl->setParameter($this->parent_obj, "tag", $tag_str);
$ilCtrl->setParameter($this->parent_obj, "style_type", $a_set["type"]);
$this->tpl->setVariable("LINK_EDIT_TAG_STYLE",
$ilCtrl->getLinkTarget($this->parent_obj, "editTagStyle"));
}

+ Here is the call graph for this function:


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