The ExpandingList class provides a simple User Interface control to allow the display of list items by heading. More...

Public Member Functions
	ExpandingList ($items, $id="expanding_list", $titleFormat=null, $bodyFormat=null, $dynamicLoad=false)
	Creates a new ExpandingList control. More...

	writeScript ()
	Writes the supporting Javascript for an expanding list control. More...

	drawList ()
	Generates the HTML for the expanding list. More...

	drawGroupedList ()
	Draws a set of grouped expanding lists. More...

Public Attributes
	$items
	The items to be displayed in the list. More...

	$id
	The HTML id of the list. More...

	$titleFormat
	The formatter used to display the list item titles (either a format string or a callback function or method) More...

	$bodyFormat
	The formatter used to display the list item bodies (either a format string or a callback function or method) More...

	$CSSclass = "expanding_list"
	CSS class(es) to be applied to the list. More...

	$styles = null
	Specific CSS styles to be applied to the list. More...

	$emptyMessage = "No items in the list"
	Message to display when the list is empty. More...

	$groupTag = "h4"
	Grouping tag type. More...

	$grouped = false
	Flag indicating whether list should be grouped. More...

	$dynamicLoad = false
	Flag indicating whether list should load content on demand. If set to true, bodyFormat should provide the URL for each item. More...

	$titleIDFormat = null
	Format template for title ID field. More...

	$bodyIDFormat = null
	Format template for body ID field. More...

	$scrollOnExpand = false
	Flag indicating whether to scroll the expanding item to the top of the screen. More...

	$scrollOffset = 0
	Offset from top of element when scrolling (to take into account fixed navigation bars, etc) More...

	$isItemExpanded = null
	Callback hook to determine if an item should be shown expanded by default. Callback is passed the item and current index. Return true for expanded, false for collapsed. More...

	$onItemStart = null
	Callback hook called when starting to display each item. Return false to skip the item. More...

	$mode = "accordion"
	The expansion mode for the list - set to "accordion" to have only one item open at a time. More...

Detailed Description

The ExpandingList class provides a simple User Interface control to allow the display of list items by heading.

Clicking on a heading expands the body for that list item..

Author: andy

Definition at line 43 of file expanding_list.inc.

Member Function Documentation

◆ drawGroupedList()

ExpandingList::drawGroupedList ( )

Draws a set of grouped expanding lists.

Definition at line 247 of file expanding_list.inc.

      {
           $attrs = "";
           if ($this->CSSclass) $attrs .= " class='{$this->CSSclass}'";
           if ($this->styles) $attrs .= " style='{$this->styles}'";
           
           $groupIdx = 0;
           
           foreach($this->items as $group => $items)
           {
 ?>
           <<?echo $this->groupTag?> class='expanding_list_group'><?echo $group?></<?echo $this->groupTag?>>        
                <dl id="<?echo $this->id?>_<?echo codify($group)?>"<?echo $attrs?>>
 <?
                $idx = 0;
                
                foreach($items as $item)
                {
                     if (is_callable($this->onItemStart))
                     {
                          if (call_user_func($this->onItemStart, $item) === false) continue;
                     }
                     
                     $titleID = ($this->titleIDFormat) ? $item->format(" id='{$this->titleIDFormat}'") : "";
                     $bodyID =  ($this->bodyIDFormat) ? $item->format(" id='{$this->bodyIDFormat}'") : "";
           
                     $expanded = false;
                     if (is_callable($this->isItemExpanded))
                     {
                          $expanded = call_user_func($this->isItemExpanded, $item, $idx, $groupIdx);
                     }
                     
                     if ($expanded)
                     {
                          $dtState = "class='expanded'";
                          $ddState = "style=''";
                     }
                     else
                     {
                          $dtState = "";
                          $ddState = "style='display: none'";
                     }
                     
                     echo "<dt{$titleID} {$dtState} onclick='return {$this->id}_toggleDD(this);'>";
                     
                     if (is_callable($this->titleFormat))
                     {
                          echo call_user_func($this->titleFormat, $item);
                     }
                     else echo $item->format($this->titleFormat);
                     
                     echo "</dt>\n";
                     
                     if (is_callable($this->bodyFormat))
                     {
                          $body = call_user_func($this->bodyFormat, $item);
                     }
                     else $body = $item->format($this->bodyFormat);
                     
                     if ($this->dynamicLoad)
                     {
                          echo "<dd{$bodyID} {$dtState} {$ddState} data-url='{$body}'></dd>";
                     }
                     else
                     {
                          echo "<dd{$bodyID} {$ddState}>{$body}</dd>";                
                     }
                     
                     ++$idx;
                }
                echo "</dl>\n";
                ++$groupIdx;
           }
      }

◆ drawList()

ExpandingList::drawList ( )

Generates the HTML for the expanding list.

Definition at line 164 of file expanding_list.inc.

      {
           if (!count($this->items))
           {
                echo "<p>{$this->emptyMessage}</p>";
                return;
           }
           
           if ($this->grouped)
           {
                $this->drawGroupedList();
                return;
           }    
           
           $attrs = "";
           if ($this->CSSclass) $attrs .= " class='{$this->CSSclass}'";
           if ($this->styles) $attrs .= " style='{$this->styles}'";
 ?>
                <dl id="<?echo $this->id?>"<?echo $attrs?>>
 <?
           $idx = 0;
           
           foreach($this->items as $item)
           {
                if (is_callable($this->onItemStart))
                {
                     $ret = call_user_func($this->onItemStart, $item);
                     if ($ret === false) continue;
                }
                
                $titleID = ($this->titleIDFormat) ? $item->format(" id='{$this->titleIDFormat}'") : "";
                $bodyID =  ($this->bodyIDFormat) ? $item->format(" id='{$this->bodyIDFormat}'") : "";
           
                $expanded = false;
                if (is_callable($this->isItemExpanded))
                {
                     $expanded = call_user_func($this->isItemExpanded, $item, $idx);
                }
                
                if ($expanded)
                {
                     $dtState = "class='expanded {$ret}'";
                     $ddState = "style='' class='{$ret}'";
                }
                else
                {
                     $dtState = "class='{$ret}'";
                     $ddState = "style='display: none' class='{$ret}'";
                }
                
                echo "<dt{$titleID} {$dtState} onclick='return {$this->id}_toggleDD(this);'>";
                
                if (is_callable($this->titleFormat))
                {
                     echo call_user_func($this->titleFormat, $item);
                }
                else echo $item->format($this->titleFormat);
                
                echo "</dt>\n";
                
                if (is_callable($this->bodyFormat))
                {
                     $body = call_user_func($this->bodyFormat, $item);
                }
                else $body = $item->format($this->bodyFormat);
                
                if ($this->dynamicLoad)
                {
                     echo "<dd{$bodyID} {$dtState} {$ddState} data-url='{$body}'></dd>";
                }
                else
                {
                     echo "<dd{$bodyID} {$ddState}>{$body}</dd>";                
                }    
                
                ++$idx;
           }
           echo "</dl>\n";
      }

◆ ExpandingList()

ExpandingList::ExpandingList	(	$items,
		$id = `"expanding_list"`,
		$titleFormat = `null`,
		$bodyFormat = `null`,
		$dynamicLoad = `false`
	)

Creates a new ExpandingList control.

Parameters

array	$items	the array of DataItems to be displayed in the list
string	$id	the HTML id of the list
mixed	$titleFormat	The formatter used to display the list item titles (either a format string or a callback function or method)
mixes	$bodyFormat	The formatter used to display the list item bodies (either a format string or a callback function or method)
boolean	$dynamicLoad	Specifies whether to load the contents of each list element on demand. If set to true, the $bodyFormat parameter should provide the URL for each item

Definition at line 71 of file expanding_list.inc.

      {
           $this->items = $items;
           $this->id = $id;
           $this->titleFormat = $titleFormat;
           $this->bodyFormat  = $bodyFormat;
           $this->dynamicLoad = $dynamicLoad;
      }

◆ writeScript()

ExpandingList::writeScript ( )

Writes the supporting Javascript for an expanding list control.

Returns: string

Definition at line 84 of file expanding_list.inc.

      {
           ob_start();
 ?>
      <script type="text/javascript">
      function <?echo $this->id?>_toggleDD(elt)
      {
           elt = document.id(elt);
           var body = elt.getNext("dd");
           
           if (elt.hasClass("expanded"))
           {
                body.dissolve();
                elt.removeClass("expanded");
           }
           else
           {
 <?php 
                if ($this->mode == "accordion")
                {
 ?>
                elt.getParent().getChildren("dt.expanded").each(function(e) { var b = e.getNext("dd"); b.dissolve(); e.removeClass("expanded"); });
 <?php
                }
 ?>
                if (body.get('data-url') && body.get('html') == '')
                {
                     var cursor = elt.getStyle('cursor');
  
                     elt.setStyle('cursor', 'progress');
                     
                     body.reload(function() 
                     { 
                          body.reveal();
                          elt.addClass("expanded");
                          elt.setStyle('cursor', cursor);
 <?php 
                if ($this->scrollOnExpand)
                {
 ?>
                          window.scrollToElement(elt, <?php echo $this->scrollOffset?>);
 <?php 
                }
 ?>
                     });
                }
                else
                {
                     body.reveal();
                     elt.addClass("expanded");
                <?php 
                if ($this->scrollOnExpand)
                {
                ?>
                     window.scrollToElement(elt, <?php echo $this->scrollOffset?>);
                <?php 
                }
                ?>
                }
           }    
      }
  
      window.addEvent('domready', function()
      {
           document.getElements("dl.expanding_list dd.expanded[data-url!='']").each(function(panel)
           {
                panel.reload();
                panel.removeClass('expanded');
           });
      });  
      </script>
 <?
           $script = ob_get_contents();
           ob_end_clean();
           return $script;
      }

Member Data Documentation

◆ $bodyFormat

ExpandingList::$bodyFormat

The formatter used to display the list item bodies (either a format string or a callback function or method)

Definition at line 48 of file expanding_list.inc.

◆ $bodyIDFormat

ExpandingList::$bodyIDFormat = null

Format template for body ID field.

Definition at line 56 of file expanding_list.inc.

◆ $CSSclass

ExpandingList::$CSSclass = "expanding_list"

CSS class(es) to be applied to the list.

Definition at line 49 of file expanding_list.inc.

◆ $dynamicLoad

ExpandingList::$dynamicLoad = false

Flag indicating whether list should load content on demand. If set to true, bodyFormat should provide the URL for each item.

Definition at line 54 of file expanding_list.inc.

◆ $emptyMessage

ExpandingList::$emptyMessage = "No items in the list"

Message to display when the list is empty.

Definition at line 51 of file expanding_list.inc.

◆ $grouped

ExpandingList::$grouped = false

Flag indicating whether list should be grouped.

Definition at line 53 of file expanding_list.inc.

◆ $groupTag

ExpandingList::$groupTag = "h4"

Grouping tag type.

Definition at line 52 of file expanding_list.inc.

◆ $id

ExpandingList::$id

The HTML id of the list.

Definition at line 46 of file expanding_list.inc.

◆ $isItemExpanded

ExpandingList::$isItemExpanded = null

Callback hook to determine if an item should be shown expanded by default. Callback is passed the item and current index. Return true for expanded, false for collapsed.

Definition at line 59 of file expanding_list.inc.

◆ $items

ExpandingList::$items

The items to be displayed in the list.

Definition at line 45 of file expanding_list.inc.

◆ $mode

ExpandingList::$mode = "accordion"

The expansion mode for the list - set to "accordion" to have only one item open at a time.

Definition at line 61 of file expanding_list.inc.

◆ $onItemStart

ExpandingList::$onItemStart = null

Callback hook called when starting to display each item. Return false to skip the item.

Definition at line 60 of file expanding_list.inc.

◆ $scrollOffset

ExpandingList::$scrollOffset = 0

Offset from top of element when scrolling (to take into account fixed navigation bars, etc)

Definition at line 58 of file expanding_list.inc.

◆ $scrollOnExpand

ExpandingList::$scrollOnExpand = false

Flag indicating whether to scroll the expanding item to the top of the screen.

Definition at line 57 of file expanding_list.inc.

◆ $styles

ExpandingList::$styles = null

Specific CSS styles to be applied to the list.

Definition at line 50 of file expanding_list.inc.

◆ $titleFormat

ExpandingList::$titleFormat

The formatter used to display the list item titles (either a format string or a callback function or method)

Definition at line 47 of file expanding_list.inc.

◆ $titleIDFormat

ExpandingList::$titleIDFormat = null

Format template for title ID field.

Definition at line 55 of file expanding_list.inc.

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

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

Public Member Functions

Public Attributes