File Source for NewsTicker.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package html
* @subpackage components
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
* A pool of regular expressions.
*/
require_once( CLASSPATH."html/HTMLLayer.class.php" );
/**
*
*/
require_once( CLASSPATH."html/JavaScript.class.php" );
/**
* A class to generate "<div>"-Layer-News-Ticker.
*
* @package html
* @version 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2005 Daniel PlÃ¼cken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class NewsTicker extends HTMLLayer
{
/**
* @var string $ticker_text
*/
var $ticker_text =
"This is the standard ticker text! Please give an custom text.";
/**
* @var integer $clip_width
*/
var $clip_width = 200;
/**
* @var integer $clip_height
*/
var $clip_height = 15;
/**
* @var integer $gap
*/
var $gap = 20;
/**
* @var integer $step_width
*/
var $step_width = 1;
/**
* @var integer $refresh_rate
*/
var $refresh_rate = 25;
/**
* @var string $name_suffix
*/
var $name_suffix = "";
/**
* @var boolean $use_marquee
*/
var $use_marquee = true;
/**
* Constructor.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param $ticker_text
* @param $style_class
* @param $name The value of the name- and id-attribute of the layer.
* @return void
*/
function NewsTicker( $ticker_text, $name = "DPTicker" )
{
$this->id = "tickerlayout".$name;
$this->name = "tickerlayout".$name;
$this->name_suffix = $name;
$this->ticker_text = $ticker_text;
}
/**
* Stores the value of this tag's "name"-attribute with the suffix
* "tickerlayout_".
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setName( $string )
{ $this->name = "tickerlayout".$string; }
/**
* Stores the text of this ticker text.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setText( $string )
{ $this->ticker_text = $string; }
/**
* Stores the value of this item's "id"-attribute with the suffix
* "tickerlayout_".
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setId( $string )
{ $this->id = "tickerlayout".$string; }
/**
* Stores the step width in pixel per each refresh of the ticker.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setStepWidth( $int )
{
if ( preg_match( "!^".INTEGER."$!", $int ) )
$this->step_width = $int;
}
/**
* Stores the period in milliseconds between the refreshes of the ticker.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setRefreshRate( $int )
{
if ( preg_match( "!^".INTEGER."$!", $int ) )
$this->refresh_rate = $int;
}
/**
* Stores the width of the ticker.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setWidth( $int )
{
if ( preg_match( "!^".INTEGER."$!", $int ) )
$this->clip_width = $int;
}
/**
* Stores the height of the ticker.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setHeight( $int )
{
if ( preg_match( "!^".INTEGER."$!", $int ) )
$this->clip_height = $int;
}
/**
* Stores the gap between the two text-<div> of the ticker. This function is
* an alias for the function setGap().
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setGapBetweenText( $int )
{ $this->setGap( $int ); }
/**
* Stores the gap between the two text-<div> of the ticker.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @param integer $int
* @return void
*/
function setGap( $int )
{
if ( preg_match( "!^".INTEGER."$!", $int ) )
$this->gap = $int;
}
/**
* Returns a generated string based on the attributes of this HTML-Object.
*
* @version 1.0
* @since 1.0
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
if( $this->use_marquee )
{
return " <style type=\"text/css\">\r\n"
." #ticker_".$this->name_suffix."\r\n"
." {\r\n"
." width: ".(
empty( $this->clip_width )
? "100%"
: $this->clip_width."px"
).";\r\n"
." }\r\n"
." </style>\r\n"
." <marquee id=\"ticker_".$this->name_suffix."\" "
."scrollamount=\"".$this->step_width."\" "
."scrolldelay=\"".$this->refresh_rate."\">\r\n"
.$this->ticker_text."\r\n"
." </marquee>\r\n";
}
else
{
$js = new JavaScript();
$js->add(
"ticker_text_".$this->name_suffix." = '".$this->ticker_text."';\r\n"
."ticker_width_".$this->name_suffix." = ".$this->clip_width.";\r\n"
."ticker_height_".$this->name_suffix." = ".$this->clip_height.";\r\n"
."ticker_gap2next_".$this->name_suffix." = ".$this->gap.";\r\n"
."ticker_step_width_".$this->name_suffix." = ".$this->step_width.";\r\n"
."ticker_refresh_rate_".$this->name_suffix." = ".$this->refresh_rate
.";\r\n\r\n"
."document.getElementById('tickerlayout".$this->name_suffix."')"
.".style.clip =\r\n"
." 'rect( 0, ' + ticker_width_".$this->name_suffix." + 'px, ' "
."+ ticker_height_".$this->name_suffix." "
."+ 'px, 0 )';\r\n\r\n"
."// Ticker initialization\r\n"
."document.getElementById( 'ticker1".$this->name_suffix."' )"
.".innerHTML = ticker_text_".$this->name_suffix.";\r\n"
."document.getElementById( 'ticker2".$this->name_suffix."' )"
.".innerHTML = ticker_text_".$this->name_suffix.";"
."\r\n\r\n"
."ticker_text_width_".$this->name_suffix." = document.getElementById( "
."'ticker1".$this->name_suffix."' ).offsetWidth;"
."\r\n\r\n"
."document.getElementById('ticker1".$this->name_suffix."')"
.".style.position = 'relative';\r\n"
."document.getElementById('ticker2".$this->name_suffix."')"
.".style.position = 'relative';\r\n"
."document.getElementById('ticker1".$this->name_suffix."')"
.".style.display = 'inline';\r\n"
."document.getElementById('ticker2".$this->name_suffix."')"
.".style.display = 'inline';\r\n"
."document.getElementById('ticker1".$this->name_suffix."')"
.".style.left = '0';\r\n"
."document.getElementById('ticker2".$this->name_suffix."')"
.".style.left = ticker_gap2next_".$this->name_suffix
." + 'px';\r\n\r\n"
."function tick".$this->name_suffix."()\r\n"
."{\r\n"
." pos_x_1_".$this->name_suffix." = parseInt( document.getElementById"
."('ticker1".$this->name_suffix."').style.left );\r\n"
." pos_x_2_".$this->name_suffix." = parseInt( document.getElementById"
."('ticker2".$this->name_suffix."').style.left );\r\n"
." if ( ticker_text_width_".$this->name_suffix." < "
."pos_x_1_".$this->name_suffix." * -1 )\r\n"
." pos_x_1_".$this->name_suffix." = pos_x_2_".$this->name_suffix." "
."+ ticker_text_width_".$this->name_suffix."*2 "
."+ ticker_gap2next_".$this->name_suffix." + 6;"
."\r\n\r\n"
." if ( ticker_text_width_".$this->name_suffix."*2 < "
."pos_x_2_".$this->name_suffix." * -1 )\r\n"
." pos_x_2_".$this->name_suffix." = pos_x_2_".$this->name_suffix." "
."+ (ticker_text_width_".$this->name_suffix." "
."+ ticker_gap2next_".$this->name_suffix.")*2 + 6;"
."\r\n\r\n"
." document.getElementById( 'ticker1".$this->name_suffix."' )"
.".style.left = "
."pos_x_1_".$this->name_suffix." - ticker_step_width_"
.$this->name_suffix.";\r\n"
." document.getElementById( 'ticker2".$this->name_suffix."' )"
.".style.left = "
."pos_x_2_".$this->name_suffix." - ticker_step_width_"
.$this->name_suffix.";"
."\r\n\r\n"
."}\r\n\r\n"
."inv_".$this->name_suffix." = "
."window.setInterval( 'tick".$this->name_suffix."()', "
."ticker_refresh_rate_".$this->name_suffix." );"
."\r\n"
);
$this->setBody(
" <div id=\"ticker1".$this->name_suffix."\">[init]</div>\r\n"
." <div id=\"ticker2".$this->name_suffix."\">[init]</div>\r\n"
);
$this->setVisible();
$this->setPosition( "absolute" );
$out = parent::get();
$out .= $js->get();
return $out;
}
}
} // END of class NewsTicker
?>

Source for file NewsTicker.class.php