01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2007
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.faces.components;
34:
35: import javax.faces.component.UIOutput;
36: import javax.faces.component.UIComponent;
37: import javax.faces.context.ResponseWriter;
38: import javax.faces.context.FacesContext;
39: import java.io.IOException;
40:
41: /**
42: * <p>
43: * A "deferred writer" tag. Takes a single-method object that writes custom output using the
44: * output writer, and invokes it in the JSF component's encodeBegin phase. This is
45: * useful for writing custom HTML code that cannot be produced directly using JSF components,
46: * or rendering javascript, while keeping the right output ordering in relation to "real"
47: * JSF components. This component is only meaningful for programmatic view creation,
48: * so it isn't registered in the faces-config.xml or .taglib.xml.
49: * </p>
50: * @author Daniel Lichtenberger, UCS
51: * @version $Rev$
52: */
53: public class DeferredWriterTag extends UIOutput {
54: /**
55: * A custom writer to be embedded in the JSF component tree.
56: */
57: public static interface DeferredWriter {
58: /**
59: * Render the output to the given response writer.
60: *
61: * @param out the response writer
62: * @throws java.io.IOException on I/O errors
63: */
64: void render(ResponseWriter out) throws IOException;
65: }
66:
67: private DeferredWriter deferredWriter;
68:
69: public DeferredWriterTag() {
70: setRendererType(null);
71: }
72:
73: public DeferredWriterTag(UIComponent parent,
74: DeferredWriter deferredWriter) {
75: this .deferredWriter = deferredWriter;
76: parent.getChildren().add(this ); // small hack, just like the whole component
77: }
78:
79: @Override
80: public void encodeBegin(FacesContext facesContext)
81: throws IOException {
82: if (deferredWriter != null) {
83: deferredWriter.render(facesContext.getResponseWriter());
84: }
85: }
86: }
|