Class: AlphabetFilter

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

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --HTMLList
         |
         --WebsiteNavigation
            |
            --AlphabetFilter

A class to generate a albabethical list to use as Filter for several data.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.1

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

Inherited Methods

Class: WebsiteNavigation

WebsiteNavigation::WebsiteNavigation(): Constructor.
WebsiteNavigation::addElement(): Adds a navigation point to the list.
WebsiteNavigation::deleteElementAt(): Removes the element at $int-index. All elements behind the deleted element moving up by one position.
WebsiteNavigation::get(): Returns a generated string based on the attributes of this HTML-Object.
WebsiteNavigation::setMarkedValue(): Sets the style of the a list item identified by his given value.
WebsiteNavigation::setSelectedValue(): Sets the style of the a list item identified by his given value. This function is an alias for the function setMarkedValue.
WebsiteNavigation::setStyleOnMouseOver(): Sets the style that should be used on mouseover for each element.
WebsiteNavigation::setStyleOnMouseUp(): Sets the style that should be used on mouseup for each element.

Class: HTMLList

HTMLList::HTMLList(): Constructor.
HTMLList::addElement(): Adds an element to the list.
HTMLList::deleteElementAt(): Removes the element at $int-index. All elements behind the deleted element moving up by one position.
HTMLList::get(): Returns a generated string based on the attributes of this HTML-Object.
HTMLList::setKind(): Sets the the kind of this list ("ul" or "ol").

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 50]
A class to generate a albabethical list to use as Filter for several data.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.1
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

$str_alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"

[line 56]

Tags:

access:

public

Type:

string

[ Top ]

$str_before_each_Label = ""

[line 66]

Tags:

access:

public

Type:

string

[ Top ]

$str_behind_each_Label = ""

[line 71]

Tags:

access:

public

Type:

string

[ Top ]

$str_href = ""

[line 61]

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor AlphabetFilter [line 86]

AlphabetFilter AlphabetFilter(
$str_href
$str_href, $str_alphabet
$str_selected_value, [
$str_alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"])

Constructor.

Tags:

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

Parameters:

$str_href	$str_href	The hyper reference that should use on click on the list item. Place the string "[value]" where you want that the alphabetical char from the label of the list item should appear.
$str_alphabet	$str_selected_value
	$str_alphabet

[ Top ]

method build [line 172]

void build(
string
$str_before)

Builds the alphabetic list.

Tags:

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

Parameters:

string

$str_before

[ Top ]

method get [line 210]

string get(
)

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

Tags:

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

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

[ Top ]

method setMarkedValue [line 142]

void setMarkedValue(
string
$str_value, [string
$str_style_class = ""], [string
$str_link_style_class = ""], [string
$str_freestyle = ""], [string
$str_link_freestyle = ""])

Sets the style of the a list item identified by his given value.

Tags:

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

Overrides WebsiteNavigation::setMarkedValue() (Sets the style of the a list item identified by his given value.)

Parameters:

string	$str_value
string	$str_style_class
string	$str_link_style_class
string	$str_freestyle
string	$str_link_freestyle

[ Top ]

method setStringBeforeLabel [line 108]

void setStringBeforeLabel(
string
$str_before)

Sets the string that should concate in front of the label string.

Tags:

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

Parameters:

string

$str_before

[ Top ]

method setStringBehindLabel [line 123]

void setStringBehindLabel(

$str_behind, string
$str_before)

Sets the string that should concate behind the label string.

Tags:

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

Parameters:

string	$str_before
	$str_behind

[ Top ]

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