html
[ class tree: html ] [ index: html ] [ all elements ]
Packages:
core
communication
databases
data_structures
filesystem
forms
GilliGan
html
Services_JSON

Source for file OverInfo.class.php

Documentation is available at OverInfo.class.php

  1. <?php
  2. /**
  3.  * For including this file you have to define the constant "CLASSPATH".
  4.  * Because every include in the framework depends on the CLASSPATH definition.
  5.  * The CLASSPATH means the relative path to the folder that contains the
  6.  * framework GilliGan.
  7.  *
  8.  * @package    html
  9.  * @subpackage components
  10.  */
  11. if( !defined( "CLASSPATH" ) )
  12. {
  13.   echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
  14.   echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
  15.   exit();
  16. }
  17.  
  18. /**
  19.  *
  20.  */
  21. require_once( CLASSPATH."html/HTMLSpan.class.php" );
  22.  
  23. /**
  24.  *
  25.  */
  26. require_once( CLASSPATH."html/HTMLLayer.class.php" );
  27.  
  28. /**
  29.  * A class to generate a "<div>"-layer which makes a second layer visible
  30.  * when the user goes over it with the mousecursor.
  31.  *
  32.  * @package    html
  33.  * @subpackage components
  34.  * @version    0.1.61
  35.  * @author     Daniel Plücken <daniel@debakel.net>
  36.  * @license    http://www.gnu.org/copyleft/lesser.html
  37.  *              GNU Lesser General Public License
  38.  * @copyright  Copyright (c) 2005 Daniel Plücken <daniel@debakel.net>
  39.  *
  40.  *  This library is free software; you can redistribute it and/or
  41.  *  modify it under the terms of the GNU Lesser General Public
  42.  *  License as published by the Free Software Foundation; either
  43.  *  version 2.1 of the License.
  44.  *
  45.  *  This library is distributed in the hope that it will be useful,
  46.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  47.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  48.  *  GNU Lesser General Public License for more details.
  49.  *
  50.  *  You should have received a copy of the GNU Lesser General
  51.  *  Public License along with this library; if not, write to the
  52.  *  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  53.  *  Boston, MA 02111-1307 USA
  54.  */
  55. class OverInfo extends HTMLSpan
  56. {
  57.   /**
  58.    * @var    object 
  59.    * @access public
  60.    */
  61.   var $write_to_doc_directly = false;
  62.   /**
  63.    * @var    object 
  64.    * @access public
  65.    */
  66.   var $pop_layer;
  67.   /**
  68.    * @var    integer 
  69.    * @access public
  70.    */
  71.   var $x_margin_to_cursor = 20;
  72.   /**
  73.    * @var    integer 
  74.    * @access public
  75.    */
  76.   var $y_margin_to_cursor = 0;
  77.   /**
  78.    * @var    boolean 
  79.    * @access public
  80.    */
  81.   var $hide_selects_on_over = true;
  82.   /**
  83.    * @var    boolean 
  84.    * @access public
  85.    */
  86.   var $move_popup_with_mouse = true;
  87.  
  88.  
  89.  
  90.   /**
  91.    * Constructor.
  92.    *
  93.    * @version 1.37
  94.    * @since   0.1.0
  95.    * @author  Daniel Plücken <daniel@debakel.net>
  96.    * @access  public
  97.    * @param   $label 
  98.    * @param   $content 
  99.    * @param   $style_pop_layer 
  100.    * @param   $style_base_layer 
  101.    * @param   $x_margin_to_cursor 
  102.    * @param   $y_margin_to_cursor 
  103.    * @param   $hide_selects 
  104.    */
  105.   function OverInfo(
  106.                      $label,
  107.                      $content,
  108.                      $style_pop_layer       = "",
  109.                      $style_base_layer      = "",
  110.                      $x_margin_to_cursor    = 20,
  111.                      $y_margin_to_cursor    = 0,
  112.                      $hide_selects_on_over  = true,
  113.                      $move_popup_with_mouse = true
  114.                    )
  115.   {
  116.     $tmp = uniqid( "dp" );
  117.  
  118.     $this->pop_layer =& new HTMLLayer( $tmp );
  119.     $this->pop_layer->setBody( $content );
  120.     $this->pop_layer->setStyle( $style_pop_layer );
  121.     $this->pop_layer->setPosition( "absolute" );
  122.     $this->pop_layer->setFreeStyle( "display:none" );
  123.  
  124.  
  125.  
  126.     $this->setBody( $label );
  127.     $this->setVisible();
  128.     $this->setStyle( $style_base_layer );
  129.     $this->setNoFormat();
  130.  
  131.     $this->x_margin_to_cursor = $x_margin_to_cursor;
  132.     $this->y_margin_to_cursor = $y_margin_to_cursor;
  133.     $this->hide_selects_on_over = $hide_selects_on_over;
  134.  
  135.  
  136.     // $this->setOnMouseMove( "this.onmousemove=setCoords" );
  137.     $this->setAutoZIndex( $this->pop_layer );
  138.  
  139.     OverInfo::setGlobalJavaScript(
  140.                                     $x_margin_to_cursor,
  141.                                     $y_margin_to_cursor
  142.                                  );
  143.   }
  144.  
  145.  
  146.  
  147.   /**
  148.    * Order that the div-tag (popup layer) should be written directly to the
  149.    * body; otherwise the div-tag will be written onload-event of the body-tag.
  150.    * It is useful to keep the javascript function trough an ajax request, when
  151.    * the body is already loaded.
  152.    *
  153.    * @version 1.0
  154.    * @since   0.1.6
  155.    * @author  Daniel Plücken <daniel@debakel.net>
  156.    * @return  void 
  157.    */
  158.   function writeToDocumentDirectly()
  159.   { $this->write_to_doc_directly = true; }
  160.  
  161.  
  162.  
  163.   /**
  164.    * Stores the popup layer of this OverInfo to the next z-index.
  165.    *
  166.    * @version 1.0
  167.    * @since   0.1.2
  168.    * @author  Daniel Plücken <daniel@debakel.net>
  169.    * @return  void 
  170.    */
  171.   function setAutoZIndex( &$obj_ref )
  172.   {
  173.     static $int = 5000;
  174.  
  175.     $this->setZIndex( $int );
  176.     $obj_ref->setZIndex( $int++ );
  177.   }
  178.  
  179.  
  180.  
  181.   /**
  182.    * Stores the needed javascript to output in the head of html-document.
  183.    *
  184.    * @version 1.07
  185.    * @since   0.1.3
  186.    * @author  Daniel Plücken <daniel@debakel.net>
  187.    * @param   $x_margin_to_cursor 
  188.    * @param   $y_margin_to_cursor 
  189.    * @return  void 
  190.    */
  191.   function setGlobalJavaScript(
  192.                                 $x_margin_to_cursor = 0,
  193.                                 $y_margin_to_cursor = 0
  194.                               )
  195.   {
  196.     static $js_already_set = false;
  197.  
  198.     if ( !$js_already_set )
  199.        $GLOBALS["javascript_content"][] =
  200. <<<JSCRIPT
  201.     // over info adjustment
  202.     window.oia_x = {$x_margin_to_cursor};
  203.     window.oia_y = {$y_margin_to_cursor};
  204.  
  205.     window.setCoords = function( which2move_obj, referrer_obj, move_with_mouse, evt )
  206.     {
  207.         var pos_x = 0;
  208.         var pos_y = 0;
  209.  
  210.         if ( move_with_mouse )
  211.         {
  212.             which2move_obj = document.getElementById( which2move_obj );
  213.  
  214.             if ( !evt || evt == null )
  215.                 evt = window.event;
  216.  
  217.             if ( evt && ( evt.pageX || evt.pageY ) )
  218.             {
  219.                 pos_x = evt.pageX;
  220.                 pos_y = evt.pageY;
  221.             }
  222.             else
  223.             if ( evt && ( evt.clientX || evt.clientY ) )
  224.                 if ( document.documentElement.scrollTop )
  225.                 {
  226.                     pos_x = evt.clientX
  227.                           + document.documentElement.scrollLeft;
  228.                     pos_y = evt.clientY
  229.                           + document.documentElement.scrollTop;
  230.                 }
  231.                 else
  232.                 {
  233.                     pos_x = evt.clientX + document.body.scrollLeft;
  234.                     pos_y = evt.clientY + document.body.scrollTop;
  235.                 }
  236.         }
  237.         else
  238.         {
  239.             // Get the left position of the Element
  240.             var obj = referrer_obj;
  241.             if ( obj.offsetParent )
  242.             {
  243.                 while ( obj.offsetParent )
  244.                 {
  245.                     pos_x += obj.offsetLeft;
  246.                     obj = obj.offsetParent;
  247.                 }
  248.             }
  249.             else
  250.             if ( obj.x )
  251.                 pos_x += obj.x;
  252.  
  253.  
  254.             // Get the top position of the Element
  255.             obj = referrer_obj;
  256.             if ( obj.offsetParent )
  257.             {
  258.                 while ( obj.offsetParent )
  259.                 {
  260.                     pos_y += obj.offsetTop;
  261.                     obj = obj.offsetParent;
  262.                 }
  263.             }
  264.             else
  265.             if ( obj.y )
  266.                 pos_y += obj.y;
  267.  
  268.         }
  269.  
  270.         if ( which2move_obj )
  271.         {
  272.             which2move_obj.style.display = 'block';
  273.             which2move_obj.style.top = (pos_y+window.oia_y) + 'px';
  274.             which2move_obj.style.left = (pos_x+window.oia_x) + 'px';
  275.         }
  276.     }
  277.  
  278.  
  279.     window.startOverInfo = function( which, ref_obj, no_select_hiding, move_with_mouse )
  280.     {
  281.         if (
  282.              !no_select_hiding
  283.           && navigator.appName == "Microsoft Internet Explorer"
  284.            )
  285.         {
  286.             var aV = navigator.appVersion.replace( /^.+?MSIE ([0-9.]+).+$/, "$1" )
  287.  
  288.             if ( parseFloat( aV ) < 7.0 )
  289.             {
  290.                 var sel = document.getElementsByTagName( 'select' );
  291.                 for ( var i = 0; i < sel.length; i++ )
  292.                     sel[i].style.visibility = 'hidden';
  293.             }
  294.         }
  295.  
  296.         var tmp_obj = document.getElementById( which );
  297.  
  298.         if ( tmp_obj )
  299.             window.setCoords( tmp_obj, ref_obj, move_with_mouse, null );
  300.     }
  301.  
  302.  
  303.     window.stopOverInfo = function( which, no_select_hiding )
  304.     {
  305.         if (
  306.              !no_select_hiding
  307.           && navigator.appName == "Microsoft Internet Explorer"
  308.            )
  309.         {
  310.             var aV = navigator.appVersion.replace( /^.+?MSIE ([0-9.]+).+$/, "$1" )
  311.  
  312.             if ( parseFloat( aV ) < 7.0 )
  313.             {
  314.                 var sel = document.getElementsByTagName('select');
  315.                 for ( var i = 0; i < sel.length; i++ )
  316.                     sel[i].style.visibility = 'visible';
  317.             }
  318.         }
  319.  
  320.         var tmp_obj = document.getElementById( which );
  321.  
  322.         if ( tmp_obj )
  323.         {
  324.             tmp_obj.style.left = -17378;
  325.             tmp_obj.style.top = -17378;
  326.             tmp_obj.style.display = 'none';
  327.         }
  328.     }
  329.  
  330.  
  331.  
  332. JSCRIPT;
  333.  
  334.     $js_already_set = true;
  335.   }
  336.  
  337.  
  338.  
  339.   /**
  340. /**
  341.    * Returns a generated string based on the attributes of this HTML-Object.
  342.    *
  343.    * @version 1.22
  344.    * @since   0.1.0
  345.    * @author  Daniel Plücken <daniel@debakel.net>
  346.    * @access  public
  347.    * @return  string 
  348.    */
  349.   function get()
  350.   {
  351.     static $firsttime = true;
  352.  
  353.     // Two time escaping
  354.     $prepared_content_str = str_replace(
  355.                                 "\r", "\\r",
  356.                                 str_replace(
  357.                                     "\n", "\\n",
  358.                                     addslashes( $this->pop_layer->get() )
  359.                                            )
  360.                                        );
  361.  
  362.     $tmp_str = $this->pop_layer->getId();
  363.  
  364.     if ( $this->hide_selects_on_over )
  365.     {
  366.         $this->setOnMouseOut( "window.stopOverInfo( '{$tmp_str}', false )" );
  367.         $this->setOnMouseOver(
  368.              "window.oia_x=".$this->x_margin_to_cursor.";"
  369.             ."window.oia_y=".$this->y_margin_to_cursor.";"
  370.             ."window.startOverInfo( '{$tmp_str}', this, false, "
  371.                       .( ( $this->move_popup_with_mouse ) ? "true" : "false" )
  372.                                ." )"
  373.                              );
  374.  
  375.         if ( $this->move_popup_with_mouse )
  376.            $this->setOnMouseMove(
  377.                        "this.onmousemove=function(evt){window.setCoords( '{$tmp_str}', this, true, evt );}"
  378.                                 );
  379.     }
  380.     else
  381.     {
  382.         $this->setOnMouseOut( "window.stopOverInfo( '{$tmp_str}', true )" );
  383.         $this->setOnMouseOver(
  384.              "window.oia_x=".$this->x_margin_to_cursor.";"
  385.             ."window.oia_y=".$this->y_margin_to_cursor.";"
  386.             ."window.startOverInfo( '{$tmp_str}', this, true, "
  387.                       .( ( $this->move_popup_with_mouse ) ? "true" : "false" )
  388.                                ." )"
  389.                              );
  390.  
  391.         if ( $this->move_popup_with_mouse )
  392.            $this->setOnMouseMove(
  393.                        "this.onmousemove=function(evt){window.setCoords( '{$tmp_str}', this, true, evt );}"
  394.                                 );
  395.  
  396.     }
  397.  
  398.     $tmp_str = $firsttime ? "" : "";
  399.  
  400.     if ( $this->write_to_doc_directly )
  401.     {
  402.         $tmp_js = <<<JSCRIPT
  403.  
  404.         document.getElementsByTagName('body')[0].innerHTML += tmp_str;
  405. JSCRIPT;
  406.     }
  407.     else
  408.     {
  409.         $prepared_content_str = addslashes( $prepared_content_str );
  410.         $tmp_js = <<<JSCRIPT
  411.  
  412.         if ( window.addEventListener )
  413.             window.addEventListener( "load", new Function( "document.getElementsByTagName('body')[0].innerHTML += '" + tmp_str + "';"), false );
  414.         else
  415.         if ( window.attachEvent )
  416.             window.attachEvent( 'onload', new Function( "document.getElementsByTagName('body')[0].innerHTML += '" + tmp_str + "';") );
  417. JSCRIPT;
  418.     }
  419.  
  420.     // write the popuplayer, with the help of javascript, at the end of the document.
  421.     $poplayer_write_str = <<<JSCRIPT
  422. <div style="position:absolute;top:-17318;left:-17318;z-index:-17378;display:hidden">
  423.     <script language="javascript" type="text/javascript">
  424.     <!--
  425.         var tmp_str = '{$prepared_content_str}';
  426.  
  427.         {$tmp_js}
  428.     // -->
  429.     </script>
  430. </div>
  431. JSCRIPT;
  432.  
  433.     $firsttime = false;
  434.  
  435.     return $poplayer_write_str.parent::get();
  436.   }
  437. } // END of class OverInfo
  438. ?>
Documentation generated on Thu, 05 Jun 2008 19:14:41 +0200 by phpDocumentor 1.4.1