DataItemTabBar Class Reference

The DataItemTabBar class is a user-interface control that manages a line of tabs for multi-page dialogs. More...

Public Member Functions
	DataItemTabBar ($id, $items, $format=null, $uri="")
	appendQueryString ($url, $qs)
	Appends a query string to the supplied URL. More...
	writeScript ()
	writeHTML ()
	Writes the HTML for this control to standard output. More...

Public Attributes
	$id
	The DOM ID of the DataItemTabBar container element. More...
	$items
	$format
	$uri
	$primary_key
	$spacer

Detailed Description

The DataItemTabBar class is a user-interface control that manages a line of tabs for multi-page dialogs.

Unlike the regular TabBar control, a DataItemTabBar is bound to a collection of DataItem objects.

Definition at line 41 of file data_tabs.inc.

Member Function Documentation

appendQueryString()

DataItemTabBar::appendQueryString	(		$url,
			$qs
	)

Appends a query string to the supplied URL.

Parameters

string	$url
string	$qs

Returns

string

Definition at line 73 of file data_tabs.inc.

     {
          if ($url[0] == "&") 
          {
               $url = $qs.$url;
          }
          else
          {
               $url .= (strstr($url, "?") !== false) ? "&$qs" : "?$qs";
          }
          return $url;
     }

DataItemTabBar()

DataItemTabBar::DataItemTabBar	(		$id,
			$items,
			$format = null,
			$uri = ""
	)

Definition at line 52 of file data_tabs.inc.

     {
          $this->id = $id;
          $this->items = $items;
          $this->format = $format;
          if (count($this->items))
          {
               $this->primary_key = $this->items[0]->getPrimaryKey();
          }
          
          $this->uri = $uri;
     }

writeHTML()

DataItemTabBar::writeHTML

(

)

Writes the HTML for this control to standard output.

Definition at line 103 of file data_tabs.inc.

     {
          if (array_key_exists($this->primary_key, $_GET))
          {
               $key = $_GET[$this->primary_key];
          }
          else
          {
               $key = $this->items[0]->get($this->primary_key);
          }
     
         $first   = true;
         $future  = false;
    
         if ($this->anchor) echo "<a name='<?echo $this->anchor?>'></a>";
         
         echo "<div id='{$this->id}'";
         
         if ($this->cssClass) echo " class='{$this->cssClass}'";
         
         echo "><ul>";
         
         $count = 0;
         
         foreach ($this->items as $item)
     {
          ++$count;
          $active = "";
          $style = "";
 
          $pk = $item->get($this->primary_key);
 
          $url = $this->uri . "?" . $this->primary_key . "=" . urlencode($pk);
 
          $text = $item->format($this->format);
          
             if (!$first)
          {
               echo $this->spacer;
          }
          else
          {
               $first = false;
          }
         
               if ($pk == $key)
             {
               $style = " class='current'";
             }
        
          if ($this->showNumber) $text = "$count.&nbsp;$text";
 
          $dest = ($this->queryString!="") ? $this->appendQueryString($url, $this->queryString) : $url;
        
          if ($this->anchor)
          {
               $dest = ($dest != "#") ? "$dest#{$this->anchor}" : "#{$this->anchor}";
          }
          
          if ($this->showStates)
          {
               if (array_key_exists($url, $this->flags))
               {
                    $text = "<img src='{$this->states[$this->flags[$pk]]}' style='border: none; display: inline-block;vertical-align: middle'/>&nbsp;$text";              
               }
               else if ($this->defaultStateImage)
               {
                    $text = "<img src='{$this->defaultStateImage}' style='border: none; display: inline-block;vertical-align: middle'/>&nbsp;$text";
               }
          }
             echo "<li$style><a href=\"$dest\"$active>$text</a></li>";
     }
          
          echo "</ul></div>\n";
     }

writeScript()

DataItemTabBar::writeScript

(

)

Definition at line 86 of file data_tabs.inc.

     {
          $script = <<<ENDSCRIPT
<script type='text/javascript'>
window.addEvent('load', function()
{
     new ScrollingTabs('{$this->id}');
});
</script>
ENDSCRIPT;
 
          return $script;
     }

Member Data Documentation

$format

DataItemTabBar::$format

Definition at line 46 of file data_tabs.inc.

$id

DataItemTabBar::$id

The DOM ID of the DataItemTabBar container element.

Definition at line 43 of file data_tabs.inc.

$items

DataItemTabBar::$items

Definition at line 45 of file data_tabs.inc.

$primary_key

DataItemTabBar::$primary_key

Definition at line 49 of file data_tabs.inc.

$spacer

DataItemTabBar::$spacer

Definition at line 50 of file data_tabs.inc.

$uri

DataItemTabBar::$uri

Definition at line 48 of file data_tabs.inc.

---

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

• C:/code/cms.sonjara.com/framework/data_tabs.inc