Die Common-Controls Tag Bibliothek

<template:insert>

Das Tag fügt eine Template Schablone in die JSP-Seite ein. Bei der Schablone handelt es sich um eine JSP-Seite, welche Platzhalter für JSP-Fragmente enthält. Die JSP-Fragmente werden über einen logischen Namen angesprochen.

Die Zuordnung zu physischen Dateinamen erfolgt über <template:put>-Tags, welche innerhalb des <template:insert>-Tags angegeben werden. Für jeden Platzhalter in der Schablone kann ein entsprechendes <template:put>-Tag angegeben werden.


Body content: JSP
Tag class: InsertTag
Tei class: InsertTei
 

[ Syntax ]

Standard Syntax
<template:insert
template = "String"
[ base = "String" ]
[ id = "String" ]
[ locale = "String" ]
>
...Body Content...

</template:insert>
 

[ Attribute ]

AttributTypBeschreibungPflichtRTExp
baseString Mit dem Base-Attribut wird das Basisverzeichnis für die JSP-Seiten festgelegt. Dies wirkt sich auch auf die eingeschlossenen <template:put>-Tags aus.

Das Basisverzeichnis kann für jeden Painter individuell gesetzt werden, wie das folgende Beispiel zeigt:

myPainter:/jspCustom;/jspDef

Das Beispiel verwendet das Basisverzeichnis /jspCustom für den Fall dass der Painter myPainter verwendet wird. In allen anderen Fällen wird das Basisverzeichnis /jspDef gesetzt.

ACHTUNG: Das Basisverzeichnis wird nur bei JSP-Dateien welche mit $ beginnen berücksichtigt

 
idString Wird eine Id angegeben, so werden die folgenden beiden Java Objekte im Tag Body (Page Context) verfügbar gemacht:
  • id - die seitendefinition (com.cc.framework.taglib.template.PageDef)
  • id_locale - das aktuelle Locale (java.util.Locale) für diese Sitzung
(id ist durch den im Attribut id angegebenen Namen zu ersetzen)

Mit Hilfe der id_locale Variablen können die JSP Seiten des Templates auf einfache Weise lokalisiert werden (siehe Beispiel).

 
localeString Weist das Template an alle direkt angegebenen Zeichenketten Literale als Schlüssel für Struts Textressourcen zu interpretieren. Die schlüssel werden über den von Struts bereitgestellten Mechanismus anhand der Datei Application.properties aufgelösst.

Anmerkung: Es kann ein boolescher Wert true oder false oder der Name eines Locales angegeben werden. Bei true wird automatisch die Ländereinstellung des angemeldenten Benutzers verwendet. Bei false werden alle Zeichenkettenliterale wie angegeben übernommen.

 
templateString Gibt den Physischen Dateinamen der JSP-Schablonen Datei an. Der Dateiname wird um das Basisverzeichnis ergänzt, wenn er mit $ beginnt.

[ Beispiel ]

Die Anordnung der Bilschirmelemte der Tools-Seite wird durch die Schablone MainLayout.jsp festgelegt.


<%@ taglib uri="http://www.common-controls.com/cc/tags-template" prefix="template" %>

<template:insert id="tm" base="/jsp"  template="$/template/MainLayout.jsp">
    <%--  use resource key translation to localize the title  --%>
    <template:put  name="title"     content="app.resources.company.title" direct="true" locale="true"/>

    <%--  use a string literal  --%>
    <template:put  name="copyright" content="(c) my company" direct="true"/>

    <template:put  name="mainmenu"  content="$/include/ToolsMenu.jsp"/>
    <template:put  name="sidebar"   content="$/include/ToolsSidebar.jsp"/>
    <template:put  name="content"   content="$/include/ToolsRootContent.jsp"/>

    <%--  use a localized "about" page with the help of EL  --%>
    <template:put  name="about"     content="$/include/${pageScope['tm_locale']}/About.jsp"/>
</template:insert>