Output_Html_Tab Class Reference

Display the tabs. More...

Collaboration diagram for Output_Html_Tab:

Public Member Functions
	__construct ()
	add (Html_Tab $p_html_tab)
	Add Html_Tab.
	build_js ($p_not_hidden)
	Build the javascript to change the class name of the selected tab, hide other div and show the selected one.
	get_class_anchor ()
	CSS class for the A tag (anchor)
	get_class_comment ()
	CSS class for the comment default "tabs".
	get_class_content_div ()
	CSS class for the DIV with content (default empty)
	get_class_div ()
	CSS class for the DIV containing the UL.
	get_class_tab ()
	get the CSS class of tabs
	get_class_tab_main ()
	get the CSS class for the UL element
	get_class_tab_selected ()
	get the CSS class of tabs_selected
	get_mode ()
	get the mode , possible value are row or tabs , with mode = row , the class_content_div is set to row
	output ()
	print the html + javascript code of the tabs and the div
	set_class_anchor ($anchor_class)
	CSS class for the A tag (anchor)
	set_class_comment ($class_comment)
	CSS class for the comment default "tabs".
	set_class_content_div ($class_content_div)
	CSS class for the DIV with content (default empty)
	set_class_div ($class_div)
	CSS class for the DIV containing the UL.
	set_class_tab ($class_tab)
	set the CSS class of tabs, default is tabs
	set_class_tab_main ($class_tab_main)
	set the CSS class for the UL element
	set_class_tab_selected ($class_tab_selected)
	set the CSS class of tabs, default is tabs_selected
	set_mode ($mode)
	set the mode , possible values : row , tabs or accordeon

Protected Member Functions
	print_comment ($p_index)
	When printing row , a comment is written if not empty,.

Private Member Functions
	print_div ($p_index)

Private Attributes
	$a_tabs
	array of html tabs
	$class_anchor
	CSS class for the UL tag.
	$class_comment
	CSS class for the DIV with content, default empty.
	$class_content_div
	CSS class for the DIV containing the UL default empty.
	$class_div
	CSS class for the A tag (anchor) default empty.
	$class_tab
	for normal tab
	$class_tab_main
	$class_tab_selected
	for class_tab_selected
	$mode
	mode default tabs

Detailed Description

Display the tabs.

See also

Html_Tab

Examples

html_tab.test.php.

Definition at line 89 of file output_html_tab.class.php.

Constructor & Destructor Documentation

__construct()

Output_Html_Tab::__construct

(

)

Definition at line 105 of file output_html_tab.class.php.

    {
        $this->a_tabs=[];
        $this->class_tab="tabs";
        $this->class_tab_main="tabs";
        $this->class_tab_selected="tabs_selected";
        $this->set_mode("tab");
        $this->class_anchor="";
        $this->class_div="";
        $this->class_content_div="";
        $this->class_comment="tabs";
    }

References set_mode().

Here is the call graph for this function:

Member Function Documentation

add()

Output_Html_Tab::add

(

Html_Tab

$p_html_tab

)

Add Html_Tab.

Parameters

Html_Tab

$p_html_tab

Definition at line 253 of file output_html_tab.class.php.

    {
        $this->a_tabs[]=clone $p_html_tab;
 
    }

build_js()

Output_Html_Tab::build_js

(

$p_not_hidden

)

Build the javascript to change the class name of the selected tab, hide other div and show the selected one.

Parameters

string

$p_not_hidden

id of the showed tab

Returns

javascript string

Definition at line 302 of file output_html_tab.class.php.

    {
        $r="";
        $nb=count($this->a_tabs);
        $mode=$this->get_mode();
        if ($mode=="accordeon") {
            $r .= \Icon_Action::toggle_hide(uniqid(), sprintf("div%s", $p_not_hidden));
 
            return $r;
        }
        for ($i =0 ; $i < $nb;$i++)
        {
            if ($mode=="tab") {
 
                if ( $this->a_tabs[$i]->get_id() != $p_not_hidden) {
                    $r .= sprintf("$('div%s').hide();",$this->a_tabs[$i]->get_id() );
                    $r .= sprintf("$('tab%s').className='%s';",$this->a_tabs[$i]->get_id(),$this->class_tab );
                } else {
                    $r .= sprintf("$('div%s').show();",$p_not_hidden );
                    $r .= sprintf("$('tab%s').className='%s';",$p_not_hidden ,$this->class_tab_selected);
 
                }
            } elseif ($mode=="row") {
                if ( $this->a_tabs[$i]->get_id() != $p_not_hidden) {
                    $r .= sprintf("Effect.BlindUp('div%s',{duration : 0.7});",$this->a_tabs[$i]->get_id() );
                    $r .= sprintf("$('tab%s').className='%s';",$this->a_tabs[$i]->get_id(),$this->class_tab );
                } else {
                    $r .= sprintf("Effect.SlideDown('div%s',{duration : 0.7});",$p_not_hidden );
                    $r .= sprintf("$('tab%s').className='%s';",$p_not_hidden ,$this->class_tab_selected);
 
                }
            }   else {
                throw new \Exception("OH283.unknow mode [$mode]");
            }
        }
        return $r;
    }

References $i, $mode, $nb, $r, elseif, get_mode(), and Icon_Action\toggle_hide().

Referenced by output().

Here is the call graph for this function:

get_class_anchor()

Output_Html_Tab::get_class_anchor

(

)

CSS class for the A tag (anchor)

Returns

type

Definition at line 178 of file output_html_tab.class.php.

    {
        return $this->class_anchor;
    }

References $class_anchor.

get_class_comment()

Output_Html_Tab::get_class_comment

(

)

CSS class for the comment default "tabs".

Returns

type

Definition at line 121 of file output_html_tab.class.php.

    {
        return $this->class_comment;
    }

References $class_comment.

Referenced by print_comment().

get_class_content_div()

Output_Html_Tab::get_class_content_div

(

)

CSS class for the DIV with content (default empty)

Definition at line 139 of file output_html_tab.class.php.

    {
        return $this->class_content_div;
    }

References $class_content_div.

get_class_div()

Output_Html_Tab::get_class_div

(

)

CSS class for the DIV containing the UL.

Returns

string

Definition at line 158 of file output_html_tab.class.php.

    {
        return $this->class_div;
    }

References $class_div.

get_class_tab()

Output_Html_Tab::get_class_tab

(

)

get the CSS class of tabs

Returns

mixed

Definition at line 263 of file output_html_tab.class.php.

    {
        return $this->class_tab;
    }

References $class_tab.

Referenced by output().

get_class_tab_main()

Output_Html_Tab::get_class_tab_main

(

)

get the CSS class for the UL element

Returns

type

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

    {
        return $this->class_tab_main;
    }

References $class_tab_main.

get_class_tab_selected()

Output_Html_Tab::get_class_tab_selected

(

)

get the CSS class of tabs_selected

Returns

mixed

Definition at line 282 of file output_html_tab.class.php.

    {
        return $this->class_tab_selected;
    }

References $class_tab_selected.

get_mode()

Output_Html_Tab::get_mode

(

)

get the mode , possible value are row or tabs , with mode = row , the class_content_div is set to row

Returns

mixed

Definition at line 217 of file output_html_tab.class.php.

    {
        return $this->mode;
    }

References $mode.

Referenced by build_js(), output(), and print_div().

output()

Output_Html_Tab::output

(

)

print the html + javascript code of the tabs and the div

Definition at line 355 of file output_html_tab.class.php.

    {
        $nb=count($this->a_tabs);
        if ($nb==0)
        {
            return;
        }
        printf('<div class="%s">',$this->class_div);
        printf ( '<ul class="%s">',$this->class_tab_main);
        $mode=$this->get_mode();
        for ($i=0; $i<$nb; $i++)
        {
            printf ('<li id="tab%s" class="%s">',
                    $this->a_tabs[$i]->get_id(),$this->class_tab);
            switch ($this->a_tabs[$i]->get_mode())
            {
                case 'link':
                    printf ('<a class="%s" id="%s" href="%s">',
                            $this->class_anchor,
                            $this->a_tabs[$i]->get_id(),
                            $this->a_tabs[$i]->get_link());
                    printf ('<span class="title_%s"> %s </span>',
                        $this->get_class_tab(),
                        $this->a_tabs[$i]->get_title()
                        );
                    echo '</a>';
 
                    break;
                case 'ajax':
                    printf('<a class="%s" id="%s" onclick="%s">', 
                            $this->class_anchor,
                            $this->a_tabs[$i]->get_id(),
                            $this->a_tabs[$i]->get_link());
                    printf ('<span class="title_%s"> %s </span>',
                        $this->get_class_tab(),
                        $this->a_tabs[$i]->get_title()
                        );
 
                    echo $this->a_tabs[$i]->get_title();
                    echo '</a>';
                    break;
                case 'static':
                    // show one , hide other except for accordeon
                    $script=$this->build_js($this->a_tabs[$i]->get_id());
                    if  ($mode != 'accordeon')  {
                        printf('<a class="%s" onclick="%s">', $this->class_anchor,$script);
                    } else {
                        print $script;
                    }
 
                    printf ('<span class="title_%s"> %s </span>',
                        $this->get_class_tab(),
                        $this->a_tabs[$i]->get_title()
                        );
 
                    echo '</a>';
                    $script=$this->build_js($this->a_tabs[$i]->get_id());
 
                    break;
                default:
                    throw new Exception('OUTPUTHTMLTAB01');
                    break;
            }
            if ( $mode =="row" || $mode == "accordeon") {
                $this->print_comment($i);
            }
            echo '</li>';
            if ( $mode =="row" || $mode == "accordeon") {
                $this->print_div($i);
            }
        }
        echo '</ul>';
        echo '</div>';
        
        if ( $mode=="tab" ) {
            for ($i=0;$i<$nb;$i++)
            {
                $this->print_div($i);
            }
 
        }
    }

References $i, $mode, $nb, $script, build_js(), get_class_tab(), get_mode(), print, print_comment(), and print_div().

Here is the call graph for this function:

print_comment()

Output_Html_Tab::print_comment ( $p_index )

protected

When printing row , a comment is written if not empty,.

Parameters

$p_index

Definition at line 344 of file output_html_tab.class.php.

                                               {
        printf ('<span class="%s"> %s </span>',
            $this->get_class_comment(),
            $this->a_tabs[$p_index]->get_comment()
        );
 
    }

References get_class_comment().

Referenced by output().

Here is the call graph for this function:

print_div()

Output_Html_Tab::print_div ( $p_index )

private

Definition at line 437 of file output_html_tab.class.php.

    {
        $class="";
        if ( $this->get_mode() == "row" ) {
            $class="tab_row";
        } elseif ( $this->get_mode() == 'accordeon') {
            $class="";
        }
 
 
        printf('<div id="div%s" style="display:none;clear:both" class="%s">',
                            $this->a_tabs[$p_index]->get_id(),
                            $class);
        echo $this->a_tabs[$p_index]->get_content();
        echo '</div>';
 
    }

References $class, elseif, and get_mode().

Referenced by output().

Here is the call graph for this function:

set_class_anchor()

Output_Html_Tab::set_class_anchor

(

$anchor_class

)

CSS class for the A tag (anchor)

Parameters

type

$anchor_class

Definition at line 186 of file output_html_tab.class.php.

    {
        $this->class_anchor=$anchor_class;
        $this;
    }

set_class_comment()

Output_Html_Tab::set_class_comment

(

$class_comment

)

CSS class for the comment default "tabs".

Returns

type

Definition at line 130 of file output_html_tab.class.php.

    {
        $this->class_comment=$class_comment;
        return $this;
    }

References $class_comment.

set_class_content_div()

Output_Html_Tab::set_class_content_div

(

$class_content_div

)

CSS class for the DIV with content (default empty)

Parameters

string

$class_content_div

Definition at line 148 of file output_html_tab.class.php.

    {
        $this->class_content_div=$class_content_div;
        return $this;
    }

References $class_content_div.

set_class_div()

Output_Html_Tab::set_class_div

(

$class_div

)

CSS class for the DIV containing the UL.

Returns

string

Definition at line 168 of file output_html_tab.class.php.

    {
        $this->class_div=$class_div;
        return $this;
    }

References $class_div.

set_class_tab()

Output_Html_Tab::set_class_tab

(

$class_tab

)

set the CSS class of tabs, default is tabs

Parameters

mixed

$class_tab

Definition at line 272 of file output_html_tab.class.php.

    {
        $this->class_tab = $class_tab;
        return $this;
    }

References $class_tab.

Referenced by set_mode().

set_class_tab_main()

Output_Html_Tab::set_class_tab_main

(

$class_tab_main

)

set the CSS class for the UL element

Returns

this

Definition at line 206 of file output_html_tab.class.php.

    {
        $this->class_tab_main=$class_tab_main;
        return $this;
    }

References $class_tab_main.

set_class_tab_selected()

Output_Html_Tab::set_class_tab_selected

(

$class_tab_selected

)

set the CSS class of tabs, default is tabs_selected

Parameters

mixed

$class_tab_selected

Definition at line 291 of file output_html_tab.class.php.

    {
        $this->class_tab_selected = $class_tab_selected;
        return $this;
    }

References $class_tab_selected.

Referenced by set_mode().

set_mode()

Output_Html_Tab::set_mode

(

$mode

)

set the mode , possible values : row , tabs or accordeon

Parameters

string

$mode

possible values : row , tabs or accordeon

Definition at line 226 of file output_html_tab.class.php.

    {
        if (! in_array($mode,['tab','row','accordeon'] )) {
            throw new Exception(_("OUTPUTHTML070 Mode invalide"));
        }
        $this->mode = $mode;
        if ($mode == "row") {
            $this->set_class_tab_selected("tab_row_selected");
            $this->set_class_tab("tab_row");
 
        }elseif  ( $mode == "tab") {
            $this->set_class_tab_selected("tabs_selected");
            $this->set_class_tab("tabs");
 
        }elseif ($mode == "accordeon") {
            $this->set_class_tab_selected("");
            $this->set_class_tab("tab_row");
        } else {
            throw new \Exception("OH186.unknow mode [$mode]");
        }
        return $this;
    }

References $mode, _, elseif, set_class_tab(), and set_class_tab_selected().

Referenced by __construct().

Here is the call graph for this function:

Field Documentation

$a_tabs

Output_Html_Tab::$a_tabs

private

array of html tabs

Definition at line 92 of file output_html_tab.class.php.

$class_anchor

Output_Html_Tab::$class_anchor

private

CSS class for the UL tag.

Definition at line 97 of file output_html_tab.class.php.

Referenced by get_class_anchor().

$class_comment

Output_Html_Tab::$class_comment

private

CSS class for the DIV with content, default empty.

Definition at line 100 of file output_html_tab.class.php.

Referenced by get_class_comment(), and set_class_comment().

$class_content_div

Output_Html_Tab::$class_content_div

private

CSS class for the DIV containing the UL default empty.

Definition at line 99 of file output_html_tab.class.php.

Referenced by get_class_content_div(), and set_class_content_div().

$class_div

Output_Html_Tab::$class_div

private

CSS class for the A tag (anchor) default empty.

Definition at line 98 of file output_html_tab.class.php.

Referenced by get_class_div(), and set_class_div().

$class_tab

Output_Html_Tab::$class_tab

private

for normal tab

Definition at line 93 of file output_html_tab.class.php.

Referenced by get_class_tab(), and set_class_tab().

$class_tab_main

Output_Html_Tab::$class_tab_main

private

Definition at line 96 of file output_html_tab.class.php.

Referenced by get_class_tab_main(), and set_class_tab_main().

$class_tab_selected

Output_Html_Tab::$class_tab_selected

private

for class_tab_selected

Definition at line 94 of file output_html_tab.class.php.

Referenced by get_class_tab_selected(), and set_class_tab_selected().

$mode

Output_Html_Tab::$mode

private

mode default tabs

Definition at line 95 of file output_html_tab.class.php.

Referenced by build_js(), get_mode(), output(), and set_mode().

---

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

• include/lib/output_html_tab.class.php