Class: NewsTicker

Source Location: /html/components/NewsTicker.class.php

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --HTMLLayer
         |
         --NewsTicker

A class to generate "<div>"-Layer-News-Ticker.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

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

Variables

Methods

Inherited Variables

Class: HTMLLayer

HTMLLayer::$bgcolor
HTMLLayer::$body
HTMLLayer::$height
HTMLLayer::$left
HTMLLayer::$noformat
HTMLLayer::$position
HTMLLayer::$top
HTMLLayer::$visible
HTMLLayer::$width
HTMLLayer::$z_index

Class: ABSTHTMLTag

ABSTHTMLTag::$blur
ABSTHTMLTag::$click
ABSTHTMLTag::$focus
ABSTHTMLTag::$freestyle
ABSTHTMLTag::$id
ABSTHTMLTag::$mousemove
ABSTHTMLTag::$mouseout
ABSTHTMLTag::$mouseover
ABSTHTMLTag::$mouseup
ABSTHTMLTag::$name
ABSTHTMLTag::$no_format
ABSTHTMLTag::$other_attributes
ABSTHTMLTag::$style_class

Inherited Methods

Class: HTMLLayer

HTMLLayer::HTMLLayer(): Constructor.
HTMLLayer::get(): Returns a generated string based on the attributes of this HTML-Object.
HTMLLayer::setBGColor(): Sets the background color of this layer.
HTMLLayer::setBody(): Sets the content of this layer.
HTMLLayer::setHeight(): Sets the height of this layer.
HTMLLayer::setInvisible(): Sets the visibility of this layer to visible.
HTMLLayer::setLeft(): Sets the left-position of this layer.
HTMLLayer::setPosition(): Sets the behaviour of the position of this layer.
HTMLLayer::setTop(): Sets the top-position of this layer.
HTMLLayer::setVisible(): Sets the visibility of this layer to visible.
HTMLLayer::setWidth(): Sets the width of this layer.
HTMLLayer::setZIndex(): Sets the depth of this layer.

Class: ABSTHTMLTag

ABSTHTMLTag::getId(): Returns the value of this tag's "id"-attribute.
ABSTHTMLTag::getName(): Returns the value of this tag's "name"-attribute.
ABSTHTMLTag::HTMLTag(): The Constructor let the script die, cause this is an abstract class!
ABSTHTMLTag::idExists(): Stores all used ids and makes sure that every id in the document is unique. It should called in every get method of classes in the packages forms and html.
ABSTHTMLTag::setAttributes(): This method allows to set the attributes of the tag that are not handled by other methods.
ABSTHTMLTag::setFreeStyle(): Set the value of style definitions that are not handled by implemented methods.
ABSTHTMLTag::setId(): Stores the value of this item's "id"-attribute.
ABSTHTMLTag::setName(): Stores the value of this tag's "name"-attribute.
ABSTHTMLTag::setNoFormat(): Stores that the HTML-elements should not format by "\r\n" in the source.
ABSTHTMLTag::setOnBlur(): Sets the value of the blur-attribute of this html-tag.
ABSTHTMLTag::setOnClick(): Sets the value of the click-attribute of this html-tag.
ABSTHTMLTag::setOnFocus(): Sets the value of the focus-attribute of this html-tag.
ABSTHTMLTag::setOnMouseMove(): Sets the value of the mousemove-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOut(): Sets the value of the mouseout-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOver(): Sets the value of the mouseover-attribute of this html-tag.
ABSTHTMLTag::setOnMouseUp(): Sets the value of the mouseup-attribute of this html-tag.
ABSTHTMLTag::setStyle(): Set the value of the class-attribute of this tag.

Class: ABSTObject

ABSTObject::printComplexData(): Prints out the more complex data by the given array.
ABSTObject::printPrimitiveData(): Prints out the primitive data by the given arrays.
ABSTObject::printStructure(): Prints out the Structure of this Object.
ABSTObject::same(): Checks whether the passed object reference points to this object.
ABSTObject::sameReferences(): Compares two references whether they points to the same object

Class Details

[line 53]
A class to generate "<div>"-Layer-News-Ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
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
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$clip_height = 15

[line 67]

Type:

integer

[ Top ]

$clip_width = 200

[line 63]

Type:

integer

[ Top ]

$gap = 20

[line 71]

Type:

integer

[ Top ]

$name_suffix = ""

[line 83]

Type:

string

[ Top ]

$refresh_rate = 25

[line 79]

Type:

integer

[ Top ]

$step_width = 1

[line 75]

Type:

integer

[ Top ]

$ticker_text =
"This is the standard ticker text! Please give an custom text."

[line 58]

Type:

string

[ Top ]

$use_marquee = true

[line 87]

Type:

boolean

[ Top ]

Class Methods

constructor NewsTicker [line 101]

void NewsTicker(
$ticker_text
$ticker_text, [$style_class
$name = "DPTicker"], $name
2)

Constructor.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

$name	2	The value of the name- and id-attribute of the layer.
$ticker_text	$ticker_text
$style_class	$name

[ Top ]

method get [line 273]

string get(
)

Returns a generated string based on the attributes of this HTML-Object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Overrides HTMLLayer::get() (Returns a generated string based on the attributes of this HTML-Object.)

[ Top ]

method setGap [line 256]

void setGap(
integer
$int)

Stores the gap between the two text-<div> of the ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

integer

$int

[ Top ]

method setGapBetweenText [line 241]

void setGapBetweenText(
integer
$int)

Stores the gap between the two text-<div> of the ticker. This function is an alias for the function setGap().

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

integer

$int

[ Top ]

method setHeight [line 222]

void setHeight(
integer
$int)

Stores the height of the ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Overrides HTMLLayer::setHeight() (Sets the height of this layer.)

Parameters:

integer

$int

[ Top ]

method setId [line 153]

void setId(
string
$string)

Stores the value of this item's "id"-attribute with the suffix "tickerlayout_".

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Overrides ABSTHTMLTag::setId() (Stores the value of this item's "id"-attribute.)

Parameters:

string

$string

[ Top ]

method setName [line 122]

void setName(
string
$string)

Stores the value of this tag's "name"-attribute with the suffix "tickerlayout_".

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Overrides ABSTHTMLTag::setName() (Stores the value of this tag's "name"-attribute.)

Parameters:

string

$string

[ Top ]

method setRefreshRate [line 186]

void setRefreshRate(
integer
$int)

Stores the period in milliseconds between the refreshes of the ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

integer

$int

[ Top ]

method setStepWidth [line 168]

void setStepWidth(
integer
$int)

Stores the step width in pixel per each refresh of the ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

integer

$int

[ Top ]

method setText [line 137]

void setText(
string
$string)

Stores the text of this ticker text.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Parameters:

string

$string

[ Top ]

method setWidth [line 204]

void setWidth(
integer
$int)

Stores the width of the ticker.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	1.0
access:	public

Overrides HTMLLayer::setWidth() (Sets the width of this layer.)

Parameters:

integer

$int

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:14:32 +0200 by phpDocumentor 1.4.1

Class: NewsTicker

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: HTMLLayer

Class: ABSTHTMLTag

Inherited Methods

Class: HTMLLayer

Class: ABSTHTMLTag

Class: ABSTObject

Class Details

Tags:

Class Variables

$clip_height = 15

$clip_width = 200

$gap = 20

$name_suffix = ""

$refresh_rate = 25

$step_width = 1

$ticker_text = "This is the standard ticker text! Please give an custom text."

$use_marquee = true

Class Methods

constructor NewsTicker [line 101]

Tags:

Parameters:

method get [line 273]

Tags:

method setGap [line 256]

Tags:

Parameters:

method setGapBetweenText [line 241]

Tags:

Parameters:

method setHeight [line 222]

Tags:

Parameters:

method setId [line 153]

Tags:

Parameters:

method setName [line 122]

Tags:

Parameters:

method setRefreshRate [line 186]

Tags:

Parameters:

method setStepWidth [line 168]

Tags:

Parameters:

method setText [line 137]

Tags:

Parameters:

method setWidth [line 204]

Tags:

Parameters:

$ticker_text =
"This is the standard ticker text! Please give an custom text."