View Javadoc
1 package org.apache.turbine.modules.layouts; 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 // ECS Classes 58 import org.apache.ecs.ConcreteElement; 59 60 // Turbine Classes 61 import org.apache.turbine.modules.Layout; 62 import org.apache.turbine.modules.ScreenLoader; 63 import org.apache.turbine.services.velocity.TurbineVelocity; 64 import org.apache.turbine.util.RunData; 65 import org.apache.turbine.util.template.TemplateNavigation; 66 67 // Velocity Stuff 68 import org.apache.velocity.context.Context; 69 70 /*** 71 * This Layout module allows Velocity templates 72 * to be used as layouts. Since dynamic content is supposed to be primarily 73 * located in screens and navigations there should be relatively few reasons 74 * to subclass this Layout. 75 * 76 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> 77 * @author Dave Bryson<a href="mailto:mbryson@mont.mindspring.com">mbryson@mont.mindspring.com</a> 78 */ 79 public class VelocityOnlyLayout extends Layout 80 { 81 /*** 82 * Method called by LayoutLoader. 83 * 84 * @param RunData 85 * @return processed template in a String 86 */ 87 public void doBuild( RunData data ) throws Exception 88 { 89 /* Get the context needed by WebMacro */ 90 Context context = TurbineVelocity.getContext( data ); 91 /* Screen results */ 92 String returnValue = ""; 93 94 /* 95 * First, generate the screen and put it in the context so 96 * we can grab it the layout template. 97 */ 98 ConcreteElement results = ScreenLoader.getInstance() 99 .eval(data, data.getScreen()); 100 if (results != null) 101 returnValue = results.toString(); 102 103 /* variable for the screen in the layout template */ 104 context.put("screen_placeholder", returnValue); 105 106 /* variable to reference the navigation screen in the layout template */ 107 context.put("navigation", new TemplateNavigation( data )); 108 109 /* Grab the layout template set in the WebMacroSitePage. 110 * If null, then use the default layout template 111 * (done by the TemplateInfo object ) 112 */ 113 String templateName = data.getTemplateInfo().getLayoutTemplate(); 114 115 /* Set the locale and content type */ 116 data.getResponse().setLocale(data.getLocale()); 117 data.getResponse().setContentType(data.getContentType()); 118 119 /* Finally, generate the layout template and send it to the browser */ 120 data.getOut().print(TurbineVelocity 121 .handleRequest(context, "layouts" + templateName)); 122 } 123 }

This page was automatically generated by Maven