KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > teamkonzept > lib > TemplateBasic


1 package com.teamkonzept.lib;
2
3 import java.io.*;
4
5 import com.teamkonzept.lib.TKException;
6 import com.teamkonzept.lib.templates.*;
7 import javax.servlet.http.HttpServletRequest JavaDoc;
8 /**
9  * Definition der Grundmethoden eines Templates
10  * @author $Author: alex $
11  * @version $Revision: 1.4 $
12  */
13 public interface TemplateBasic
14 {
15     /**
16         setzt Daten in die Root
17     */
18      void set( TKHashtable aSubst );
19     
20      void set( String JavaDoc key, Object JavaDoc val );
21         
22      void setOriginalRequest(HttpServletRequest JavaDoc request);
23      
24      String JavaDoc getType();
25     /**
26      * Das substituierte Template wird als String zuueckgegeben.
27      * Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
28      * zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
29      * substituiert werden.
30      *
31      * Bsp. Reihenfolge der Aufrufe:
32      * TKTemplateObject.doTagSubstitution();
33      * TKTemplateObject.doCleanup();
34      * TKTemplateObject.getText();
35      *
36      * @return einen String des substituierten Templates
37      */
38
39      String JavaDoc getText();
40     
41     /**
42      * Das Template wird in den PrintStream geschrieben.
43      * Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
44      * zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
45      * substituiert werden.
46      *
47      * Bsp. Reihenfolge der Aufrufe:
48      * TKTemplateObject.doTagSubstitution();
49      * TKTemplateObject.doCleanup();
50      * TKTemplateObject.printTemplate();
51      */
52      void printTemplate( PrintStream out );
53     
54     /**
55      * Das Template wird in den Writer geschrieben.
56      * Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
57      * zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
58      * substituiert werden.
59      *
60      * Bsp. Reihenfolge der Aufrufe:
61      * TKTemplateObject.doTagSubstitution();
62      * TKTemplateObject.doCleanup();
63      * TKTemplateObject.printTemplate();
64      */
65      void printTemplate( Writer writer ) throws IOException;
66     
67     /**
68      * Das Template wird auf stdout geschrieben.
69      * Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
70      * zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
71      * substituiert werden.
72      *
73      * Bsp. Reihenfolge der Aufrufe:
74      * TKTemplateObject.doTagSubstitution();
75      * TKTemplateObject.doCleanup();
76      * TKTemplateObject.printTemplate();
77      */
78      void printTemplate();
79     
80     /**
81      * Das substituierte Template wird in ein File geschrieben werden.
82      * Hierfuer muss die Instanzvariable "text" mit dem Text eines Templates
83      * zuvor gefuellt werden. Dies geschieht, indem die Tags im Template zuerst
84      * substituiert werden.
85      *
86      * Bsp. Reihenfolge der Aufrufe:
87      * TKTemplateObject.doTagSubstitution();
88      * TKTemplateObject.doCleanup();
89      * TKTemplateObject.printTemplate(String file)
90      *
91      * @param String file, der Filename des zu speichernden templates
92      */
93      void printTemplate(String JavaDoc file) throws IOException;
94     
95     /**
96      * Durch den Aufruf der Methode doMainSubstitution enthaelt die
97      * Instanzvariable "text" das Template mit den substituierten TKTags.
98      * Die nicht vollstaendigen Pfade werden ersetzt.
99      *
100      * Die URL-Base ist gestzt, wenn Images ausserhalb des CGI-Verzeichnisses
101      * abgelegt sind. Fuer diese Bilder muss der vollstaendige Pfad im
102      * Template gesetzt werden.
103      */
104      void doTagSubstitution() throws TKTemplateSyntaxException;
105
106     /**
107      * Die Instanzvariable "text" enthaelt das Template mit den
108      * substituierten TKTags
109      *
110      * 1. TKTemplateData-Objekt.prepareApply() => Bearbeitung der Hashes
111      * fuer folgende Tags: if,check,select, case
112      * 2. Die Variable text enthaelt das generierte Template
113      */
114      void doMainSubstitutions() throws TKTemplateSyntaxException;
115      
116     DOMTemplateData getDOMData();
117      
118 }
119
120
121
Popular Tags