Location: PHPKode > scripts > PSpecialNavi > pspecialnavi/documentation/documentation.xml
<?xml version="1.0" encoding="utf-8" ?>
<?xml-stylesheet href="documentation.xsl" type="text/xsl" ?>
<documentation name="PSpecialNavi" version="1.1" lastchange="12. September 2002">
	<sample>&lt;?</sample>
	<sample>&#160;&#160;include("PSpecialNavi.php");</sample>
	<sample></sample>
	<sample>&#160;&#160;$navi = new PSpecialNavi();</sample>
	<sample></sample>
	<sample>&#160;&#160;$navi-&gt;addItem("PHP Homepage", "http://www.php-homepage.de");</sample>
	<sample>&#160;&#160;$navi-&gt;addItem("PHP.net", "http://www.php.net", "_blank");</sample>
	<sample></sample>
	<sample>&#160;&#160;$navi-&gt;setWidth("150");</sample>
	<sample>&#160;&#160;$navi-&gt;setSpecialHyperlinkClass();</sample>
	<sample></sample>
	<sample>&#160;&#160;$navi-&gt;drawHTML();</sample>
	<sample>?&gt;</sample>
	<methode version="1.0" name="PSpecialNavi" beschreibung="Konstruktor der Funktion. Initialisiert die Default - Werte" typ="void">
		<beispiel>  $navi = new PSpecialNavi();</beispiel>
		<beispiel></beispiel>
		<beispiel kommentar="ja">  // Einträge einfügen</beispiel>
		<beispiel>  $navi-&gt;addItem("PHP", "www.php.net");</beispiel>
		<beispiel>  $navi-&gt;addItem("PHP - Homepage", "www.php-homepage.de");</beispiel>
		<beispiel></beispiel>
		<beispiel kommentar="ja">  // HTML - Text auf der Seite ausgeben</beispiel>
		<beispiel>  $navi-&gt;drawHTML();</beispiel>
	</methode>
	<methode version="1.0" name="addItem" beschreibung="Fügt ein Item zu der Navigation hinzu." typ="void">
		<param typ="string" beschreibung="Beschriftung des Items">szCaption</param>
		<param typ="string" beschreibung="URL des Items. Standardwert ist #">[szUrl]</param>
		<param typ="string" beschreibung="Ziel der URL. Standardwert ist &quot;&quot;, welcher beim Rendern in den Standardwert geändert wird (wird nicht geändert, wenn etwas für szTarget eingegeben wird). Der Standardwert kann mit setDefaultTarget geändert werden.">[szTarget]</param>
		<param typ="string" beschreibung="QuickInfo auf die Zelle. Standardwert ist &quot;&quot;">[szQuickInfo]</param>
		<beispiel>&#160;&#160;$navi-&gt;addItem("PHP Homepage", "http://www.php-homepage.de");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;addItem("PHP.net", "http://www.php.net", "_blank", "Zur PHP - Homepage");</beispiel>
	</methode>
	<methode version="1.0" name="addSeparator" beschreibung="Fügt eine leere Zelle hinzu" typ="void">
		<beispiel>&#160;&#160;$navi-&gt;addSeparator();</beispiel>
	</methode>
	<methode version="1.0, 1.1" name="setColors" beschreibung="Setzt die Farben für den Farbverlauf, beginnend mit der 1. Farbe bei onmouseover. Die letzte Farbe ist gleichzeitig die Zellenhintergrundfarbe eines Elementes." typ="void">
		<param typ="array" beschreibung="Die Farben des Farbverlaufes. Es muss ein Array mit 6 Farben sein. Ab Version 1.1 können auch mehrere Farben in den Array geschrieben werden.">aColors</param>
		<beispiel>  $navi-&gt;setColors(array("#0000ff", "#0000cc", #000099", #000066", #000033", "#000000"));</beispiel>
	</methode>
	<methode version="1.1" name="setColorsGradient" beschreibung="Berechnet aus Start- und Endfarbwert einen Farbverlauf." typ="void">
		<param typ="string" beschreibung="Der Startfarbwert, der als erstes bei onmouseover erscheint. Die Farbe muss in hexadezimaler Form angegeben werden: z. B. #ff0000">szStartColor</param>
		<param typ="string" beschreibung="Der Endfarbwert, der gleichzeitig Hintergrundfarbe der Tabelle ist. Die Farbe muss in hexadezimaler Form angegeben werden: z. B. #0000ff">szStartColor</param>
		<param typ="int" beschreibung="Die Anzahl der Farben, die berechnet werden sollen. Je größer die Zahl gewählt wird, desto feiner wird der Verlauf. Jedoch verlängert sich so auch die Zeit bis der Effekt abgeschlossen ist. Korrigieren Sie dies mit setSpeed oder setAutoSpeed. Standardwert ist 6.">[$nLength]</param>
		<beispiel>&#160;&#160;$navi-&gt;setColorsGradient("#ff0000", "#0000ff");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setColorsGradient("#123456", "#fedcba", 10);</beispiel>
	</methode>
	<methode version="1.0" name="setWidth" beschreibung="Passt die Größe der Tabelle an.">
		<param typ="string" beschreibung="Die Größe in Pixel. Wenn der Wert auto ist, wird die Tabelle den Inhalten angepasst">szSize</param>
		<beispiel>  $navi-&gt;setWidth("120");</beispiel>
		<beispiel kommentar="ja">  // oder...</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setWidth("100%");</beispiel>
		<beispiel kommentar="ja">&#160;&#160;// oder...</beispiel>
		<beispiel>  $navi-&gt;setWidth("auto");</beispiel>
	</methode>
	<methode version="1.0" name="setHyperlinkClass" beschreibung="Kann dem Hyperlink in der Zelle eine CSS - Klasse zuweisen." typ="void">
		<param typ="string" beschreibung="Die Klasse für den &lt;a&gt; Tag in der Tabelle. Muss vorher mit CSS definiert werden">szClass</param>
		<beispiel>?&gt;</beispiel>
		<beispiel></beispiel>
		<beispiel>&#160;&#160;&lt;style type="text/css"&gt;</beispiel>
		<beispiel>&#160;&#160;&#160;&#160;a.mynavi { color:blue; text-decoration:none }</beispiel>
		<beispiel>&#160;&#160;&#160;&#160;a.mynavi:Hover { color:red; text-decoration:underline }</beispiel>
		<beispiel>&#160;&#160;&lt;/style&gt;</beispiel>
		<beispiel></beispiel>
		<beispiel>&lt;?</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setHyperlinkClass("mynavi");</beispiel>
	</methode>
	<methode version="1.0" name="setSpecialHyperlinkClass" beschreibung="Fügt eine CSS Klasse ein, die gut zu den Standardeinstellungen der Navigation passt. Diese Klasse ruft setHyperlinkClass() automatisch auf." typ="void">
		<beispiel>&#160;&#160;$navi-&gt;setSpecialHyperlinkClass();</beispiel>
	</methode>
	<methode version="1.0" name="setCellSpacing" beschreibung="Editiert das cellspacing - Attribut des Tabellen Objektes in der Navigation" typ="void">
		<param typ="string" beschreibung="Kann eine Nummer sein oder auto, wenn der Zellenzwischenraum automatisch angepasst werden soll. 0 ist ein Ideal - Wert">szSpacing</param>
		<beispiel>&#160;&#160;$navi-&gt;setCellSpacing("0");</beispiel>
		<beispiel>&#160;&#160;// oder...</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setCellSpacing("auto");</beispiel>
	</methode>
	<methode version="1.0" name="setPaddingLeft" beschreibung="Der linke Abstand zum Rand des Textes innerhalb einer Zelle wird mit dieser Funktion modifiziert." typ="void">
		<param typ="string" name="Der Abstand in Pixel. Die Einheit px wird von der Klasse geschrieben.">szPadding</param>
		<beispiel>&#160;&#160;$navi-&gt;setPaddingLeft("15");</beispiel>
	</methode>
	<methode version="1.0" name="setPaddingTopBottom" beschreibung="Der obere und untere Abstand zum Rand des Textes innerhalb einer Zelle wird mit dieser Funktion modifiziert." typ="void">
		<param typ="string" name="Der Abstand in Pixel. Die Einheit px wird von der Klasse geschrieben.">szPadding</param>
		<beispiel>&#160;&#160;$navi-&gt;setPaddingTopBottom("4");</beispiel>
	</methode>
	<methode version="1.0" name="setSpeed" beschreibung="Ändert die Zeit, in der bei onmouseout von einer Farbe zur anderen Farbe gewechselt werden soll." typ="void">
		<param typ="string" beschreibung="Die Zeit in Millisekunden. Standardwert ist 80">szSpeed</param>
		<beispiel>&#160;&#160;$navi-&gt;setSpeed("200");</beispiel>
	</methode>
	<methode version="1.1" name="setAutoSpeed" beschreibung="Berechnet die Zeit in Bezug auf die Anzahl der Farben und der Standardzeit von 80ms" typ="void">
		<beispiel>&#160;&#160;$navi-&gt;setAutoSpeed();</beispiel>
	</methode>
	<methode version="1.0" name="setDefaultTarget" beschreibung="Ändert den $szTarget Parameter für die addItem - Methode. Sie gilt nur für die nachfolgenden Aufrufe der addItem - Methode" typ="void">
		<param typ="string" beschreibung="Der neue Target - Wert">szTarget</param>
		<beispiel>&#160;&#160;$navi-&gt;setDefaultTarget("main");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;addItem("Seite 1", "seite1.htm");</beispiel>
		<beispiel kommentar="ja">&#160;&#160;// Ist bei &quot;&quot; immer noch &quot;main&quot;</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;addItem("Seite 2", "seite2.htm", "", "Hier geht es zur Seite 2");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setDefaultTarget("_blank");</beispiel>
		<beispiel>&#160;&#160;// Beim nächsten Eintrag ist das Ziel &quot;_blank&quot;</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;addItem("PHP - Homepage", "http://www.php-homepage.de");</beispiel>
	</methode>
	<methode version="1.1" name="setAoverTD" beschreibung="Einstellung, URL bei Klick auf Zelle ausgeführt werden soll" typ="void">
		<param typ="bool" beschreibung="0 = Hyperlink über den Text, 1 = Hyperlink über die Zelle. Standardwert ist 0">[bAoverTD]</param>
		<beispiel>&#160;&#160;$navi-&gt;setAoverTD(1);</beispiel>
	</methode>
	<methode version="1.1" name="setBorderColor" beschreibung="Setzt die Farbe um die Tabelle und um die Zelle" typ="void">
		<param typ="string" beschreibung="Ein HTML Farbcode für die Tabellenrand- und Zellenrandfarbe. Der Wert kann auch &quot;auto&quot; betragen. Dann wird die Hintergrundfarbe der Tabelle verwendet.">szColor</param>
		<beispiel>&#160;&#160;$navi-&gt;setBorderColor("#ff0000");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setBorderColor("Black");</beispiel>
		<beispiel>&#160;&#160;$navi-&gt;setBorderColor("auto");</beispiel>
	</methode>
	<methode version="1.1" name="setBorderWidth" beschreibung="Ändert die Weite der Rahmen für die Tabelle oder die Zelle" typ="void">
		<param typ="string" beschreibung="Ein CSS Wert (evtl. mit Einheit) für den äußeren Rahmen">szOut</param>
		<param typ="string" beschreibung="Ein CSS Wert (evtl. mit Einheit) für den inneren Rahmen">szIn</param>
		<beispiel>&#160;&#160;$navi-&gt;setBorderWidth("2px", "0px");</beispiel>
	</methode>
	<methode version="1.1" name="setAlign" beschreibung="Gibt die Ausrichtung des Textes in den Zellen an" typ="void">
		<param typ="string" beschreibung="left = linksbündinge Aurichtung, center = zentrierte Ausrichtung, right = rechtsbündige Ausrichtung">szAlign</param>
		<beispiel>&#160;&#160;$navi-&gt;setAlign("center");</beispiel>
	</methode>
	<methode version="1.1" name="setType" beschreibung="Gibt an, wie die Zellen angeordnet werden sollen" typ="void">
		<param typ="string" beschreibung="vertical = Zellen werden untereinander angeordnet, horizontal = Zellen werden nebeneinander angeordnet">szType</param>
		<beispiel>&#160;&#160;$navi-&gt;setType("horizontal");</beispiel>
	</methode>
	<methode version="1.1" name="setNoBr" beschreibung="Gibt an, ob der Text in der Zelle umbrochen werden soll" typ="void">
		<param typ="string" beschreibung="0 = Text wird umbrochen, 1 = Text wird nicht umbrochen (sinnvoll, wenn type horizontal ist)">bNoBr</param>
		<beispiel>&#160;&#160;$navi-&gt;setNoBr(1);</beispiel>
	</methode>
	<methode version="1.1" name="noEffect" beschreibung="Entfernt den Verblassungseffekt bei onmouseout" typ="void">
		<beispiel>&#160;&#160;$navi-&gt;noEffect();</beispiel>
	</methode>
	<methode version="1.0" name="drawHTML" beschreibung="Rendert den HTML und JavaScript - Text auf die Seite. Diese Methode muss zuletzt aufgerufen werden. Vorher wird die Klasse initialisiert." typ="void">
		<beispiel>&#160;&#160;$navi-&gt;drawHTML();</beispiel>
	</methode>
</documentation>
Return current item: PSpecialNavi