KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > displaytag > export > TextExportView


1 /**
2  * Licensed under the Artistic License; you may not use this file
3  * except in compliance with the License.
4  * You may obtain a copy of the License at
5  *
6  * http://displaytag.sourceforge.net/license.html
7  *
8  * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
9  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
10  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
11  */
12 package org.displaytag.export;
13
14 import java.io.IOException JavaDoc;
15 import java.io.Writer JavaDoc;
16
17 import javax.servlet.jsp.JspException JavaDoc;
18
19
20 /**
21  * Main interface for exportViews which need to output character data.
22  * @author Fabrizio Giustina
23  * @version $Revision: 720 $ ($Author: fgiust $)
24  */
25 public interface TextExportView extends ExportView
26 {
27
28     /**
29      * Returns the exported content as a String.
30      * @param out output writer
31      * @throws IOException for exceptions in accessing the output stream
32      * @throws JspException for other exceptions during export
33      */
34     void doExport(Writer JavaDoc out) throws IOException JavaDoc, JspException JavaDoc;
35
36     /**
37      * If <code>true</code> exported data will be included in the html page. <strong>actually not evaluated. Included
38      * for future enhancements </strong>
39      * @return <code>true</code> if exported data should be included in the html page
40      */
41     boolean outputPage();
42 }
43
Popular Tags