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 import freemarker.template.SimpleHash; 58 import freemarker.template.SimpleScalar; 59 import org.apache.ecs.ConcreteElement; 60 import org.apache.ecs.StringElement; 61 import org.apache.turbine.modules.Layout; 62 import org.apache.turbine.modules.ScreenLoader; 63 import org.apache.turbine.services.TurbineServices; 64 import org.apache.turbine.services.freemarker.FreeMarkerService; 65 import org.apache.turbine.services.freemarker.NavigationModel; 66 import org.apache.turbine.util.RunData; 67 68 69 /*** 70 * FreeMarker Site Layout. This Layout module allows FreeMarker 71 * templates to be used as layouts. Since dynamic content is supposed 72 * to be primarily located in screens and navigations there should be 73 * relatively few reasons to subclass this Layout. 74 * 75 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> 76 * @version $Id: FreeMarkerSiteLayout.java,v 1.2 2002/07/11 16:53:29 mpoeschl Exp $ 77 * @deprecated you should use velocity 78 */ 79 public class FreeMarkerSiteLayout extends Layout 80 { 81 /*** 82 * Build the layout. 83 * 84 * @param data Turbine information. 85 * @exception Exception, a generic exception. 86 */ 87 public void doBuild(RunData data) 88 throws Exception 89 { 90 SimpleHash context = getContext(data); 91 92 // First, generate the screen and put it in the context so we 93 // can grab it the layout template. 94 ConcreteElement results = ScreenLoader.getInstance() 95 .eval(data, data.getScreen()); 96 String screenValue = ""; 97 if (results != null) 98 { 99 screenValue = results.toString(); 100 } 101 context.put("screen_placeholder", new SimpleScalar(screenValue)); 102 103 // Variable to reference the navigation templates in the 104 // layout template. 105 context.put("navigation", new NavigationModel(data)); 106 107 // Grab the layout template set in the WebMacroSitePage. If 108 // null, then use the default layout template ( done by the 109 // TemplateInfo object ). 110 String templateName = data.getTemplateInfo().getLayoutTemplate(); 111 112 boolean isCache; 113 isCache = data.getParameters().getBoolean("template_cache", true); 114 data.getPage().getBody().addElement( 115 doBuildTemplate(context, "layouts" + templateName, isCache)); 116 } 117 118 /*** 119 * Return the model needed by FreeMarker. This is where information 120 * needed by the template should be placed. 121 * 122 * @param RunData data 123 * @return SimpleHash 124 */ 125 protected SimpleHash getContext(RunData data) 126 { 127 FreeMarkerService fm = (FreeMarkerService) 128 TurbineServices.getInstance() 129 .getService(FreeMarkerService.SERVICE_NAME); 130 return fm.getContext(data); 131 } 132 133 /*** 134 * Return the model needed by FreeMarker. This is where 135 * information needed by the template should be placed. 136 * 137 * @return SimpleHash 138 */ 139 protected SimpleHash getContext() 140 { 141 FreeMarkerService fm = (FreeMarkerService) 142 TurbineServices.getInstance() 143 .getService(FreeMarkerService.SERVICE_NAME); 144 return fm.getContext(); 145 } 146 147 /*** 148 * Build the template. 149 * 150 * @param context retrieved from getContext method. 151 * @param templateFile the name of the template file. 152 * @param cache 153 * @return A String with the processed template. 154 */ 155 protected StringElement doBuildTemplate(SimpleHash context, 156 String templateFile, 157 boolean cache) 158 throws Exception 159 { 160 FreeMarkerService fm = (FreeMarkerService) 161 TurbineServices.getInstance() 162 .getService(FreeMarkerService.SERVICE_NAME); 163 StringElement output = new StringElement(); 164 output.setFilterState(false); 165 output.addElement(fm.handleRequest(context,templateFile, cache)); 166 return output; 167 } 168 }

This page was automatically generated by Maven