View Javadoc
1 package org.apache.turbine.util.template; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import org.apache.ecs.ConcreteElement; 58 59 import org.apache.turbine.modules.ScreenLoader; 60 61 import org.apache.turbine.util.Log; 62 import org.apache.turbine.util.RunData; 63 64 /*** 65 * Returns output of a Screen module. An instance of this is 66 * placed in the Velocity context by the VelcityDirectLayout. This 67 * allows the screen to be executed only at rendering. 68 * Here's how it's used in a template: 69 * 70 * <p> 71 * <code> 72 * $screen_placeholder 73 * </code> 74 * <p> 75 * <code> 76 * $screen_placeholder.setScreen("Test") 77 * </code> 78 * </p> 79 * 80 * @author <a href="raphael@apache.org">Raphaël Luta</a> 81 * @version $Id: TemplateScreen.java,v 1.1 2001/08/19 17:59:18 mpoeschl Exp $ 82 */ 83 public class TemplateScreen 84 { 85 /* The RunData object. */ 86 private RunData data; 87 88 /* The name of the screen template. */ 89 private String screen; 90 91 92 /*** 93 * Constructor 94 * 95 * @param data A Turbine RunData object. 96 */ 97 public TemplateScreen(RunData data) 98 { 99 this.data = data; 100 this.screen = data.getScreen(); 101 } 102 103 /*** 104 * Set the screen. 105 * 106 * @param screen A String with the name of the screen module 107 * @return A TemplateScreen (self). 108 */ 109 public TemplateScreen setScreen(String screen) 110 { 111 this.screen=screen; 112 return this; 113 } 114 115 /*** 116 * Builds the output of the navigation template. 117 * 118 * @return A String. 119 */ 120 public String toString() 121 { 122 String returnValue=""; 123 124 try 125 { 126 ConcreteElement results = ScreenLoader.getInstance() 127 .eval(data, this.screen); 128 129 if (results != null) 130 returnValue = results.toString(); 131 } 132 catch (Exception e) 133 { 134 Log.error(e); 135 } 136 137 return returnValue; 138 } 139 }

This page was automatically generated by Maven