$K(Tag Libraries)



$KK(Deklaration einer TagLib in JSP)



$R(Objective)

For a custom tag library or a library of Tag Files, create the 'taglib' directive for a JSP page.

$R\





TagLib Direktiven wurden im Kapitel über Direktiven ausführlich behandelt.



Hier die Syntax zur Deklaration einer TagLib Direktive



$S()

<%@ taglib prefix="prefix" [uri="taglibURI" | tagdir="contextRelativePath"]%>

$S\



$T(caption,ll,30.70)

Attribut | Beschreibung ||

prefix |  Der Prefix mappt eine Aktion zu einer TagLib Library ||

uri | Entweder ein eindeutiges Symbol das eine TLD spezifiziert oder ein relativer

Pfad zu einer TLD Datei bzw Jar File ||

tagdir | Kontextrelativer Pfad zu einem Ordner mit Tag-Dateien. Der Pfad startet mit 

/WEBINF/tags ||

$T\



Beispiele:



$S()

<%@ taglib prefix="ora" uri="orataglib" %>

<%@ taglib prefix="c" uri="http://java.sun.com/jstl/core" %>

<%@ taglib prefix="mylib" tagdir="/WEB-INF/tags/mylib" %>

$S\



$KK(Finden der richtigen TagStruktur)



$R(Objective)    

Given a design goal, create the custom tag structure in a JSP page to support that goal.

$R\



Für diese Objective kann man sich nur schwer vorbereiten. Hilfreich ist sicherlich das

Studium der existierenden Library, wie die Core Standard Library.



So zeigt die Aktion <i><c:choose> <c:when> <c:otherwise></i> wie man durch Verschachtelungen

von Tags komplexe Strukturen aufbauen kann.



Einem Tag kann man Attribute mitgeben, deren Werte je nach TLD Datei

fest sind oder durch Auswertung eines Ausdrucks ausgewertet werden. 

(siehe z.B. die Aktion <i><c:if></i>).



Das Ergebnis der Auswertung des Body eines Tags wird zur Ausgabe verwendet. Je nachdem 

wie man den Tag Handler schliesslich programmiert, wird die Auswertung des Bodys unterdrückt,

(siehe Aktion <i><c:if></i>) oder mehrfach ausgewertet (siehe Aktion <i><c:forEach></i>)).



Beachte dass Ergebnis der Auswertung des Bodys, für die nächste Iteration wieder verwendet

werden kann. Mehr dazu im Kapitel über die Programmierung der Tag Libraries.



$KK(Die Core Standard Tag Library)





$R(Objective)

Given a design goal, use an appropriate JSP Standard Tag Library (JSTL v1.1) tag from the "core" tag library. 

$R\



$KKK(Überblick)



Die Core Library teil sich in 3 Bereiche auf:





# Allgemeinen Aktionen

# Bedingungen und Schleifen

# URL-bezogene Aktionen





<b>Allgemeine Aktionen</b>



$T(caption,ll,30.70)

Core-Tags  | Bedeutung ||

<c:out> | Ausgabe von Daten in die Antwort ||

<c:set> | Setzt Variable in einen Scope ||

<c:remove> | löscht Daten aus einem Scope ||

<c:catch> | Abfangen von Fehlern ||

$T\



<b>Bedingungen und Schleifen</b>



$T(caption,ll,30.70)

Core-Tags | Bedeutung ||

<c:if> | Bedingungen ||

<c:choose> | Auswahl ||

<c:when> | Alternativen in Auswahl ||

<c:otherwise> | Letzte Alternative in einer Auswahl ||

<c:forEach> | Iterationen über eine Sammlung von Elementen ||

<c:forTokens> | Iterationen über Token, die durch Delimiter getrennt sind ||

$T\



<b>URL-bezogene Aktionen</b>



$T(caption,ll,30.70)

Core-Tags | Bedeutung ||

<c:import> | Inklusion von Texten || 

<c:url> | Umschreiben von URLs ||

<c:redirect> | Umleitung zu anderen Seiten ||

<c:param> | Übergabe von Parametern ||

$T\



$KKK(Allgemeine Aktionen)



<b>Die Aktion <c:out></b>



Die <c:out> Aktion wertet einen Ausdruck aus und übergibt das Ergebnis an das

aktuelle JspWriter-Objekt. 



Da EL-Ausdrücke direkt innerhalb von Template-Daten eingefügt werden dürfen, wird diese 

Funktion selten verwendet, und ist vor allem mit den Attributen interessant.





$T(caption,lllll,15.10.12.15.48)

Attribut | Java Typ | Dynamik | default-Wert | Beschreibung ||

value | Object | Ja | siehe Attribut default | Ausdruck der ausgewertet wird ||

escapeXml | boolean | Ja |  true | Bei true werden xml Sonderzeichen in die 

XML Entity Codes übersetzt ||

default | Object | Ja | -- | Ausdruck der ausgegeben wird falls die Auswertung von value

null ergibt ||

$T\



Die Beispiele zeigen, dass der default Wert als Attribut, oder als Body angegeben werden

kann.



$S()

<c:out value="${param.phone}" default="No Phone" />



<c:out value="${user.imageURL}">

    <c:url value="/defaultUserImage.jpg" />

</c:out>

$S\



<b>Die Aktion <c:set></b>



Diese Aktion setzt Variablen in einem bestimmten Scope, oder setzt eine Property einer

Bean.



$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

value | String | Ja | Ausdruck der ausgewertetund als Wert genommen wird ||

var | String | Nein | Name der Variablen die die neue URL enthält ||

scope | String | Nein | Scope in der var abgelegt wird, Standard ist page ||

target | Object | Ja | Zielobjekt dem eine Property zugewiesen wird. Eine Bean oder Map ||

property | String | Ja | Property von target ||

$T\





$S()

<%-- Beispiel: Setzen einer Variable ohne Body --%>



<c:set value="${user.name}" var="Name" />



<%-- Beispiel: Setzen einer Variable mit Body --%>



<c:set  var="Name" scope="session" >

    ${user.name}

</c:set>



<%-- Beispiel: Property einer Bean setzen --%>



<c:set value="${user.name}" target="${userBeanId}" property="Name" />



<%-- Beispiel: Property einer Bean setzen --%>



<c:set target="${userBeanId}" property="Name" 

     ${user.name}

</c:set>

$S\



<b>Die Aktion <c:remove></b>



Diese Aktion entfernt eine Variable aus einem Gültigkeitsbereich



$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

var| String | Nein | Name der Variable, die entfernt werden soll ||

scope | String | Nein | Scope in der var abgelegt wird, Standard ist page ||

$T\



Beispiel:



$S()

<c:remove var="loggedOut" scope="session" />

$S\





<b>Die Aktion <c:catch></b>



Diese Aktion fängt Fehler ab, es ist möglich die ausgelöste Exception an eine

Variable im PageScope zuzuordnen.



$S()

<c:catch var="importException">

  <c:if test="${importException != null}">

      <jsp:forward page="input.jsp">

          <jsp:param name="msg" value="Invalidate date format" />

      </jsp:forward>

  </c:if>

</c:catch>

$S\



Die Aktion <c:catch> hat nur ein einziges optionales Attribut <i>var</i>.

Diese Variable liegt automatisch im pageScope.





$KKK(Bedingungen und Schleifen)



<b>Die Aktion <c:if></b>



Die Auswertung des Bodys eine Aktion <i><c:if></i> erfolgt nur dann, falls die

der im Attribut <i>test</i> angegebene Ausdruck <i>true</i> ergibt.



$S()

<c:if test="booleanExpression">

   JSPElements

</c:if>

$S\



$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

test | boolean | Ja | Ausdruck der ausgewertet wird ||

var | String | Nein | Variablenname ||

scope | String | Nein | Scope von var ||

$T\



Statt Auswertung eines Bodys kann man auch das Ergebnis der Auswertung in einer

Variablen abspeichern.



$S()

<c:if test="booleanExpression" var="var" scope="page|request|session|application" /> 

$S\



<b>Die Aktionen <c:choose> <c:when> <c:otherwise></b>



Diese Aktionen entspricht dem Java <i>switch()</i> Statement.

Die Aktionen <i><c:when></i> und <i><c:otherwise></i> sind Kindelemente

der Aktion<i><c:choose></i>. Das Vorhandensein einer Aktion <i><c:otherwise></i>

ist optional.



$S()

<c:choose>

   <c:when test="${product.onSale}">

       ${product.salesPrice} On sale !

   </c:when>

   <c:otherwise>

       ${product.price}

   </c:otherwise>

</c:choose>

$S\



Die Aktion <i><c:when></i> ist die einzigste die ein Attribut besitzt. Ergibt die

Auswertung des Ausdruck vom <i>test</i> den Wert <i>true</i> so wird der Body ausgewertet.

Innerhalb der Aktion <i>cc:choose></i> können mehrere <i><c:when></i> Ausdrücke 

sein. Es wird der Body der ersten <i><c:when></i> Aktion ausgeführt, die true ergibt.

Ansonsten wird der Body der <i><c:otherwise></i> Aktion ausgeführt.





<b>Die Aktion <c:forEach></b>



Es gibt 2 Arten diese Aktion zu verwenden. 



# Iteration über eine feste Anzahl von Iterationen

# Iteration über eine Collection



<u>Iteration über eine feste Anzahl von Iterationen</u>



Beispiel:



$S()

<%-- Iterate five times, writing 0,2,4,6 --%>

<c:forEach begin="0" end="6" step="2" var="current">

   ${current}

</c:forEach>

$S\



Das Attribut <i>begin</i> und <i>end</i> sind wenn man über eine feste Anzahl

von Iterationen iteriert Pflichtattribute.



<u>Iteration über eine Collection</u>



Beispiel:



$S()

<%-- Iterate over all request parameters --%>



<c:forEach items="${param}" var="current">

   Name: ${current.key}

   Vorname: ${current.value}

</c:forEach>

$S\





$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

begin | int | Ja | Index für Anfang der Iteration ||

end | int | Ja | Index für das Ende der Iteration ||

items | Collection, Iterator, Enumeration , Map oder ein Array | Ja | Darüber wird iteriert ||

step | int | Ja | Schrittweite der Schleife, Standard ist 1. ||

var | String | Nein | Variable das das aktuelle Element der Iteration hält ||  

varStatus | String | Nein | Variable enthält interne Informationen über die Schleifenduchlauf

Ist vom Interface LoopTagStatus ||

$T\



<i>varStatus</i> kann man nur innerhalb einer forEach bzw forToken Aktion verwenden.

Das Objekt das varStatus hält ist vom Interface <i>LoopTagStatus</i> und hat folgende 

Methoden:



$S()

public Integer getBegin()  // begin Wert oder null

public Integer getCount()  // Aktuelle Iteration beginnend bei 1

public Object  getCurrent() // Aktuelle Variable der Iteration

public int     getIndex()  // Index aktueller Variable beginned bei 0

public Integer getStart()  // start Wert oder null

public Integer getStep()   // step Wert oder null

public boolean isFirst()   // Gibt true für den ersten Durchlauf

public boolean isLast()    // Gibt true für den letzten Durchlauf

$S\



<b>Die Aktion <c:forTokens></b>



Diese Aktion iteriert für jeden Token innerhalb eines String. Die Token werden über

sogenannte Trennzeichen (delimiters) getrennt. 



Beispiel:



$S()

<%-- Iteriert über Tokens die durch Vertikalstrich getrennt sind --%>



<c:forTokens items="${tokens}" delims="|" var="current">

    <c:out value="${current }" />

</c:forTokens>

$S\



$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

begin | int | Ja | Index für Anfang der Iteration ||

end | int | Ja | Index für das Ende der Iteration ||

items | Collection, Iterator, Enumeration , Map oder ein Array | Ja | Darüber wird iteriert ||

delims | String | Ja | Liste aller Trennzeichen ||

step | int | Ja | Schrittweite der Schleife, Standard ist 1. ||

var | String | Nein | Variable das das aktuelle Element der Iteration hält ||  

varStatus | String | Nein | Variable enthält interne Informationen über die Schleifenduchlauf

Ist vom Interface LoopTagStatus ||

$T\







$KKK(URL-bezogene Aktionen)



<b>Die Aktion <c:url></b>



Diese Aktion wird für URL-Rewriting genommen. Ist der Aufruf Teil einer Sitzung, so wird

die Session-ID der URL hinzugefügt. 



$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

value | String | Ja | Pflichattribut - Eine absolute oder relative URL ||

context | String | Ja | Optional - Falls die Umleitung zu einer anderen Applikation 

gehört, brauchen wir den Context Pfad der Zielapplikation ||

var | String | Nein | Optional - Name der Variablen die die neue URL enthält ||

scope | String | Nein | Optional -  Scope in der var abgelegt wird, Standard ist page ||

$T\



Werden in der URL-Parameter mitgegeben, so können diese als Unterelemente mit der Aktion

<c:param> mitgegeben werden.



$S()

<c:url value="product.jsp">

    <c:param name="id" value="${product.id}" />

    <c:param name="customer" value="$Rudi Ratlos" />

</c:url>

$S\



<b>Die Aktion <c:import></b>



Im Gegensatz zur <i>include</i>-Direktive und die <i><jsp:include></i> Standardaktion,

kann man mit der Aktion <i><c:import></i> auch Ressourcen aus einer anderen 

Webanwendung einbinden. Es können auch Parameter mitgegeben werden.



$S()

<c:import var="xmldaten"

     url="http://www.einstiegjsp.de/testdaten.xml">

  <c:param name="sprache" value="${header['accept-language']}" /> 

</c:import>

$S\



Es ist auch möglich Ressourcen über ftp einzubinden.



Die eingelesene Ressource muss nicht sofort eingebunden werden, sondern kann mit dem Attribut 

<i>var</i> und <i>scope</i> einer Variablen zugewiesen werden.



Eine andere Möglichkeit ist es, sich über das Attribut <i>varReader</i> eine

Instanz von <i>java.io.Reader</i> geben zu lassen. Diese Instanz gibt Methoden wie 

<i>read()</i>,<i>skip</i> usw. zur Verfügung. Ist ein <i>varReader</i> definiert,

so wird im Body der <i><c:import></i> Aktion darauf zugegriffen.



$T(caption,llll,17.13.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

url | String  | Ja | Pflicht - Die URL der Ressource die importiert wird || 

context | String  | Ja | Optional - Context-Path für eine Webanwendung im selben Container.

Startet mit einem Slash ||

var | String | Nein | Optional - Variable die den Inhalt der Ressource hält ||

scope | String | Nein | Optional - Scope der Variable. Standard ist page ||

varReader | String | Nein | Optional - Variable die einen java.io.Reader hält ||

charEncoding | String | Ja | Optional - Zeichensatz der Ressource ||

$T\





Beispiel:



$S()

<c:import url="navigation.jsp" />



<c:import url="http://wwww.blabla.de"

    varReader="xmlSource">

    <x:parse var="doc" xml="${xmlSource}" scope="application" />

</c:import>

$S\



<b>Die Aktion <c:redirect></b>



Diese Aktion dient zur Umleitung der aktuellen URL. Es gibt dem Browser die Antwort, er

solle die Anfrage mit der neuen URL betätigen.





$T(caption,llll,15.15.15.55)

Attribut | Java Typ | Dynamik | Beschreibung ||

url| String  | Ja | Pflicht - Ein relativer Pfad, oder eine absolute URL || 

context | String  | Ja | Optional - Context-Path für eine Webanwendung im selben Container.

Startet mit einem Slash ||

$T\



Beispiel:



$S()

<c:redirect url="navigation.jsp" />



<c:redirect url="navigation.jsp" >

    <c:param name="user" value="Apahachi" />

</c:redirect>

$S\





<b>Die Aktion <c:param></b>



Dient der Paramterübergabe in den Aktionen  <i><c:redirect></i>, <i><c:import></i> und

 <i><c:url></i>. 

 

Es gibt 2 syntaktische Schreibweisen. Einmal wird der Wert des Paramters als Attribut value

mitgegeben. Das andereMal wird er über den Body mitgegeben.



$S()

<c:param name="parameterName" value="parameterWert">



<c:param name="parameterName">

   "paramterWert"

</c:param>

$S\



Die Aktion <i><c:param></i> hat nur als Kindelement einen Sinn.