The TabBar class is a user-interface control that manages 2 lines of tabs for multi-page dialogs. More...

Inheritance diagram for TwoLevelTabBar:

Collaboration diagram for TwoLevelTabBar:

Public Member Functions
	TwoLevelTabBar ($tabs, $qs)

	setFlags ($flags)

	setStates ($states)

	getNextPage ()
	Get the next page in the tab list after the current page. More...

	findPage ($page)
	Finds the tab containing the specified URL. More...

	drawHorizontalCheckList ()

	setColor ($color)

Public Member Functions inherited from TabBar
	TabBar ($id, $tabs, $queryString="", $useQueryString=true, $showNumber=false)
	Construct a new TabBar control. More...

	preserveQueryString ()
	Preserve the current query string in tab links. More...

	dynamicLoad ($container)

	writeScript ()

	writeHTML ()
	Writes the HTML for this control to standard output. More...

	appendQueryString ($url, $qs)
	Appends a query string to the supplied URL. More...

	getPage ($idx, $appendQueryString=true)
	Return the URL for the page at the specified tab index. More...

	next ()
	Move to the next page in the tab list. More...

	drawCheckList ()

	drawCheckListEntry ($title, $form)

	setDefaultStateImage ($img)

Additional Inherited Members
Public Attributes inherited from TabBar
	$id
	The DOM ID of the TabBar container element. More...

	$tabs = array()
	The tab records in this tab bar. More...

	$queryString = null
	The query string parameters to append to the navigation links. More...

	$useQueryString = true
	Whether a query string is being used as the navigation key. More...

	$page = ""
	The current page (for display purposes). This can be set explicitly to force the correct tab display when in a sub-page, for instance. More...

	$showNumber
	True to display the step number, false if not. More...

	$states = array()
	Array of display states to apply, indexed by tab. More...

	$flags = array()
	Array of flags to apply, indexed by tab. More...

	$anchor = ""
	Anchor name to generate (leave empty for no anchor tag) More...

	$cssClass = ""
	CSS class to apply to the top level container for the tabs. More...

	$defaultStateImage
	Image to show in the default tab state. More...

	$showStates = true
	true to show tab states, false to ignore them More...

	$dynamic = false
	true to indicate dynamic (AJAX-based) loading More...

	$container = ""
	The DOM ID of the container that will contain dynamically loaded content. More...

	$dynamicLoadHandler = null
	Javascript function to call to handle dynamic content load (optional) More...

	$dynamicLoadFirstTab = true
	By default, dynamically loaded tab bars will do a request for the content of the first tab on page load. Set to false to disable this. More...

	$disabled = false
	Set to true to generate disabled tab navigation. More...

Detailed Description

The TabBar class is a user-interface control that manages 2 lines of tabs for multi-page dialogs.

Example code the include file calling script: $tabs = getTabs(); $qs = ($key) ? "{primary key}=$key" : ""; $tabBar = new TwoLevelTabBar($tabs, $qs); $tabBar->setStates(array("submitted" => "{icon path}")); $tabBar->setDefaultStateImage("{icon_path}");

return $tabBar;

function getTabs() {

$tabs = array( "First Top Level Tab"    =>
                    array(    "First Lower Tab"             =>   "{identifier}",
                              "Second Lower Tab"       =>   "{identifier"),


                    "2nd Top Level Tab" =>
                    array(    "Lower tab"              =>   "{identifier",
                              "Lower tab"              =>   "{identifier") 

);

return $tabs;

}

Definition at line 547 of file tab_bar.inc.

Member Function Documentation

◆ drawHorizontalCheckList()

TwoLevelTabBar::drawHorizontalCheckList ( )

Definition at line 643 of file tab_bar.inc.

      {
 ?>
      <table class="checklist">
      <tr>
 <?
           foreach($this->tabs as $title => $steps)
           {
 ?>
   <td colspan="2" class="title"><b><?echo $title?></b></td> 
 <?
           }
 ?>
      </tr>
 <?        
           $idx = 0;
           
           do
           {
                $found = false;
                $row = "";
  
                foreach($this->tabs as $title => $tabBar)
                {
                     $steps = $tabBar->tabs;
                     $keys = array_keys($steps);
                     $title = $keys[$idx];
                     if (isset($steps[$title]))
                     {
                          $form = $steps[$title];
                          $found = true;
                          $status = $tabBar->flags[$form];
                           
                          if ($status && $this->states[$status])
                          {
                               $img = "<img src='{$this->states[$status]}' alt='$status'/>";
                          }
                          else if ($this->defaultStateImage)
                          {
                               $img = "<img src='{$this->defaultStateImage}' alt=''/>";
                          }
                          
                          $row .= "<td class=\"status\">$img</td>";
                          $row .= "<td class=\"link\"><a href=\"$form?{$this->queryString}\">$title</a></td>";
                     }
                     else
                     {
                          $row .= "<td class=\"status\"></td>";
                          $row .= "<td class=\"link\"></td>"; 
  
                     }
                }
  
                if ($found)
                {              
 ?>
      <tr>
       <?echo $row?>
      </tr>
 <?
                }
                
                $idx++;
           }
           while($found);
 ?>
      </table>
 <?             
      }

◆ findPage()

TwoLevelTabBar::findPage ( $page )

Finds the tab containing the specified URL.

Parameters

$page The page to find

Returns: mixed returns the name of the tab if found, false otherwise

Reimplemented from TabBar.

Definition at line 622 of file tab_bar.inc.

      {
           // remove query string if given;
           $page = preg_replace('/\?.*/', '', $page);
  
           foreach($this->tabs as $text => $entry)
           {
                if (get_class($entry) == "TabBar")
                {
                     $found = $entry->findPage($page);  
                     if($found)
                     {
                          return $found;
                     }
                }
           }
           
           return false;
      }

◆ getNextPage()

TwoLevelTabBar::getNextPage ( )

Get the next page in the tab list after the current page.

Returns: string

Reimplemented from TabBar.

Definition at line 590 of file tab_bar.inc.

      {
           $jump = false;
           
           foreach($this->tabs as $text => $entry)
           {
                if (get_class($entry) == "TabBar")
                {
                     $entry->queryString = $this->queryString;
                     
                     if ($jump) return $entry->getPage(0);
  
                     $next = $entry->getNextPage();
           
                     if ($next === false) continue;
                     if ($next === "")
                     {
                          $jump = true;
                          continue;
                     }
                     
                     return $next;
                }
           }
                
      }

◆ setColor()

TwoLevelTabBar::setColor ( $color )

Definition at line 713 of file tab_bar.inc.

      {
           foreach($this->tabs as $text => $entry)
           {
                if (get_class($entry) == "TabBar")
                {
                     $entry->cssClass = "{$color}_subtabs";
                }
           }
           
           $this->cssClass = "{$color}_tabs";
      }

◆ setFlags()

TwoLevelTabBar::setFlags ( $flags )

Definition at line 563 of file tab_bar.inc.

      {
           foreach($this->tabs as $text => $entry)
           {
                if (get_class($entry) == "TabBar")
                {
                     $entry->flags = $flags;
                }
           }
           
           $this->flags = $flags;
      }

◆ setStates()

TwoLevelTabBar::setStates ( $states )

Definition at line 576 of file tab_bar.inc.

      {         
           foreach($this->tabs as $text => $entry)
           {
                if (get_class($entry) == "TabBar")
                {
                     $entry->states = $states;
                }
           }
           
           $this->states = $states;
      }

◆ TwoLevelTabBar()

TwoLevelTabBar::TwoLevelTabBar	(	$tabs,
		$qs
	)

Definition at line 549 of file tab_bar.inc.

      {
           foreach($tabs as $text => $entry)
           {
                if (is_array($entry))
                {
                     $tabs[$text] = new TabBar("subtabs", $entry, $qs);
                }
           }
           
           $this->TabBar("tabs", $tabs, $qs);
           $this->showStates = false;
      }

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

C:/code/cms.sonjara.com/framework/tab_bar.inc

Public Member Functions

Additional Inherited Members