| java.lang.Object
 com.teamkonzept.lib.TKTemplate
All known Subclasses: com.teamkonzept.web.TKHTMLTemplate,
| TKTemplate | | public class TKTemplate implements TemplateBasic,TemplateTypes(Code) | | Die Klasse TKTemplate stellt Methoden fuer die Generierung eines Templates
zur Verfuegung
author:
$Author: sebastian $
version:
$Revision: 1.24 $ |
| Constructor Summary | |
| public | TKTemplate(String location)
| | public | TKTemplate(TKTemplateSyntax ts)
Konstruktor3
Durch den Aufruf der statischen Methode init() werden Pattern fuer die
spaetere Patternsuche/ersetzung definiert und global zur Verfuegung gestellt. |
| Method Summary | |
| public void | add(TKHashtable aSubst)
An einem Hash der Klasse TKTemplateData fuer die Ersetzung in einem
bestimmten Template wird ein weiterer Hash angehaengt. | | public void | add(String key, Object val)
An einem Hash fuer die Ersetzung in einem bestimmten Template wird ein
weitereres Element angehaengt. | | public void | doCleanup()
Nachdem alle Tags ersetzt worden sind, wird das Template gsaeubert,
so dass nur noch regulaere Tags im Template existieren. | | public void | doMainSubstitutions()
Die Instanzvariable "text" enthaelt das Template mit den
substituierten TKTags
1. | | public void | doTagSubstitution()
Durch den Aufruf der Methode doMainSubstitution enthaelt die
Instanzvariable "text" das Template mit den substituierten TKTags. | | public DOMTemplateData | getDOMData()
| | public Object | getEnumerationContext(Object key)
| | public TKListIterator | getListIterator()
Ein TKListIterator-Objekt, welches in der Klasse TKTemplateData existiert,
wird zurueckgegeben. | | public String | getText()
Das substituierte Template wird als String zuueckgegeben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. | | public String | getType()
| | protected void | init(TKTemplateSyntax ts)
| | protected void | init(String location)
| | static void | initStatic()
Pattern werden fuer die spaetere Patternsuche/ersetzung definiert und
global zur Verfuegung gestellt. | | public TKTemplateSyntax | newSyntax()
Returns a new syntax instance associated to the template. | | public TKTemplateSyntax | newSyntax(Pattern patTKTag)
Returns a new syntax instance associated to the template. | | public void | printTemplate(PrintStream out)
Das Template wird in den PrintStream geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. | | public void | printTemplate(Writer writer)
Das Template wird in den Writer geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. | | public void | printTemplate()
Das Template wird auf stdout geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. | | public void | printTemplate(String file)
Das substituierte Template wird in ein File geschrieben werden.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. | | public void | set(TKHashtable aSubst)
Ein Hash fuer die Ersetzung wird der Variable subst der Klasse
TKTemplateData uebergeben. | | public void | set(String key, Object val)
Ein Hash fuer die Ersetzung wird fuer die Klasse TKTemplateData
erzeugt und in diesen eingefuegt. | | public String | setAppName(String appName)
| | public void | setEnumerationContext(Object key, Object value)
in nested lists, there is sometimes the neccessarity to pass some data from
the implementation of the outer iterator to the implementation of the inner
iterator. | | public void | setListIterator(TKListIterator aIterator)
Ein TKListIterator wird gesetzt. | | public void | setOriginalRequest(HttpServletRequest request)
|
| initialized | | static boolean initialized(Code) | | |
| patBaseURL | | static Pattern patBaseURL(Code) | | |
| patCleanEmpty | | static Pattern patCleanEmpty(Code) | | |
| patCopyRight | | static Pattern patCopyRight(Code) | | |
| patTKTag | | public static Pattern patTKTag(Code) | | |
| TKTemplate | | public TKTemplate(TKTemplateSyntax ts)(Code) | | Konstruktor3
Durch den Aufruf der statischen Methode init() werden Pattern fuer die
spaetere Patternsuche/ersetzung definiert und global zur Verfuegung gestellt.
ts, Ein TKTemplateSyntax-Objekt filename, das template als File-Objekt |
| add | | public void add(TKHashtable aSubst)(Code) | | An einem Hash der Klasse TKTemplateData fuer die Ersetzung in einem
bestimmten Template wird ein weiterer Hash angehaengt.
Die TKTags werden im Template durch die Values ersetzt.
Aufruf: templateObject.addSubst(TKHashtableObject)
Parameters:
TKHashtable - aSubst, der zu konkatinierende Hash |
| add | | public void add(String key, Object val)(Code) | | An einem Hash fuer die Ersetzung in einem bestimmten Template wird ein
weitereres Element angehaengt. Die TKTags werden im Template durch die
Values ersetzt.
Aufruf: templateObject.addSubst("Schluessel",Object)
Parameters:
String - key, ein Schluessel, z.B. der zu ersetzende TKTag
Parameters:
Object - val, der Wert zu dem Schuessel, durch den der TKTag ersetzt werden soll |
| doCleanup | | public void doCleanup()(Code) | | Nachdem alle Tags ersetzt worden sind, wird das Template gsaeubert,
so dass nur noch regulaere Tags im Template existieren. Danach kann das
Template ausgegeben werden.
1.Template-Objekt.doTagSubstitution()
2.Template-Objekt.doCleanup()
3.Template-Objekt.printTemplate()
|
| doMainSubstitutions | | public void doMainSubstitutions() throws TKTemplateSyntaxException(Code) | | Die Instanzvariable "text" enthaelt das Template mit den
substituierten TKTags
1. TKTemplateData-Objekt.prepareApply() => Bearbeitung der Hashes
fuer folgende Tags: if,check,select, case
2. Die Variable text enthaelt das generierte Template
|
| doTagSubstitution | | public void doTagSubstitution() throws TKTemplateSyntaxException(Code) | | Durch den Aufruf der Methode doMainSubstitution enthaelt die
Instanzvariable "text" das Template mit den substituierten TKTags.
Die nicht vollstaendigen Pfade werden ersetzt.
Die URL-Base ist gestzt, wenn Images ausserhalb des CGI-Verzeichnisses
abgelegt sind. Fuer diese Bilder muss der vollstaendige Pfad im
Template gesetzt werden.
|
| getEnumerationContext | | public Object getEnumerationContext(Object key)(Code) | |
See Also: setEnumerationContext |
| getListIterator | | public TKListIterator getListIterator()(Code) | | Ein TKListIterator-Objekt, welches in der Klasse TKTemplateData existiert,
wird zurueckgegeben.
Aufruf dieser Methode: TemlateObjekt.getListIterator();
ein Objekt vom Typ TKListIterator |
| getText | | public String getText()(Code) | | Das substituierte Template wird als String zuueckgegeben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
substituiert werden.
Bsp. Reihenfolge der Aufrufe:
TKTemplateObject.doTagSubstitution();
TKTemplateObject.doCleanup();
TKTemplateObject.getText();
einen String des substituierten Templates |
| initStatic | | static void initStatic()(Code) | | Pattern werden fuer die spaetere Patternsuche/ersetzung definiert und
global zur Verfuegung gestellt.
|
| newSyntax | | public TKTemplateSyntax newSyntax()(Code) | | Returns a new syntax instance associated to the template.
Overwritten by TLKHTMLTemplate.
|
| newSyntax | | public TKTemplateSyntax newSyntax(Pattern patTKTag)(Code) | | Returns a new syntax instance associated to the template.
Overwritten by TLKHTMLTemplate.
|
| printTemplate | | public void printTemplate(PrintStream out)(Code) | | Das Template wird in den PrintStream geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
substituiert werden.
Bsp. Reihenfolge der Aufrufe:
TKTemplateObject.doTagSubstitution();
TKTemplateObject.doCleanup();
TKTemplateObject.printTemplate();
|
| printTemplate | | public void printTemplate(Writer writer) throws IOException(Code) | | Das Template wird in den Writer geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
substituiert werden.
Bsp. Reihenfolge der Aufrufe:
TKTemplateObject.doTagSubstitution();
TKTemplateObject.doCleanup();
TKTemplateObject.printTemplate();
|
| printTemplate | | public void printTemplate()(Code) | | Das Template wird auf stdout geschrieben.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
substituiert werden.
Bsp. Reihenfolge der Aufrufe:
TKTemplateObject.doTagSubstitution();
TKTemplateObject.doCleanup();
TKTemplateObject.printTemplate();
|
| printTemplate | | public void printTemplate(String file) throws IOException(Code) | | Das substituierte Template wird in ein File geschrieben werden.
Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
substituiert werden.
Bsp. Reihenfolge der Aufrufe:
TKTemplateObject.doTagSubstitution();
TKTemplateObject.doCleanup();
TKTemplateObject.printTemplate(String file)
Parameters:
String - file, der Filename des zu speichernden templates |
| set | | public void set(TKHashtable aSubst)(Code) | | Ein Hash fuer die Ersetzung wird der Variable subst der Klasse
TKTemplateData uebergeben.
Parameters:
ein - Objekt vom Typ TKHashtable, der die zu ersetzenden Informationen enthaelt |
| set | | public void set(String key, Object val)(Code) | | Ein Hash fuer die Ersetzung wird fuer die Klasse TKTemplateData
erzeugt und in diesen eingefuegt.
Parameters:
String - key, ein Schluessel
Parameters:
Object - val, die Information zum Schluessel |
| setAppName | | public String setAppName(String appName)(Code) | | Die Instanzvariable ist mit "TKTemplate" initialisiert
einen String der Applikation. |
| setEnumerationContext | | public void setEnumerationContext(Object key, Object value)(Code) | | in nested lists, there is sometimes the neccessarity to pass some data from
the implementation of the outer iterator to the implementation of the inner
iterator. this can be done by the enumeration context. the implementation
of the list-tags ensures, that the enumerationContext of a call of the
apply-method of the outer iterator gets passed to all calls of the
corresponding calls of the inner iterator.
|
| setListIterator | | public void setListIterator(TKListIterator aIterator)(Code) | | Ein TKListIterator wird gesetzt. Das TKListIterator-Objekt wird der
Variablen listIterator der Klasse TKTemplateData zugewiesen.
Aufruf dieser Methode: TemlateObjekt.setListIterator(TKListIteratorObject);
aIterator, Objekt vom typ TKLIstIterator |
|
|