View Javadoc
1 package org.apache.turbine.modules.navigations; 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 // Turbine/Village/ECS Imports 58 import org.apache.ecs.ConcreteElement; 59 import org.apache.ecs.StringElement; 60 import org.apache.turbine.util.RunData; 61 import org.apache.turbine.services.velocity.TurbineVelocity; 62 63 // Velocity Stuff 64 import org.apache.velocity.context.Context; 65 66 67 /*** 68 * VelocityNavigation. This screen relies on the VelocityPage 69 * being set as the default page. The doBuildTemplate() assumes the 70 * user has put the template filename in the RunData parameter and set 71 * it to the value of the template file to execute. Specialized 72 * Navigations screens should extend this class and overide the 73 * doBuildTemplate( data , context) method. 74 * 75 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 76 * @version $Id: VelocityNavigation.java,v 1.1.1.1 2001/08/16 05:08:35 jvanzyl Exp $ 77 */ 78 public class VelocityNavigation extends TemplateNavigation 79 { 80 /*** 81 * Velocity Navigations extending this class should overide this 82 * method to perform any particular business logic and add 83 * information to the context. 84 * 85 * @param data Turbine information. 86 * @param context Context for web pages. 87 * @exception Exception, a generic exception. 88 */ 89 protected void doBuildTemplate( RunData data, 90 Context context ) 91 throws Exception 92 { 93 } 94 95 /*** 96 * Needs to be implemented to make TemplateNavigation like us. 97 * The actual method that you should override is the one with the 98 * context in the parameter list. 99 * 100 * @param data Turbine information. 101 * @exception Exception, a generic exception. 102 */ 103 protected void doBuildTemplate( RunData data ) 104 throws Exception 105 { 106 doBuildTemplate( data, TurbineVelocity.getContext(data) ); 107 } 108 109 /*** 110 * This Builds the Velocity template. 111 * 112 * @param data Turbine information. 113 * @return A ConcreteElement. 114 * @exception Exception, a generic exception. 115 */ 116 public ConcreteElement buildTemplate( RunData data ) 117 throws Exception 118 { 119 Context context = TurbineVelocity.getContext( data ); 120 121 String templateName = data.getTemplateInfo().getNavigationTemplate(); 122 123 StringElement output = new StringElement(); 124 output.setFilterState(false); 125 126 // Usually adds the leading slash, but make it sure. 127 if ((templateName.length() > 0) && 128 (templateName.charAt(0) != '/')) 129 { 130 templateName = '/' + templateName; 131 } 132 output.addElement( TurbineVelocity 133 .handleRequest(context,"navigations" + templateName) ); 134 return output; 135 } 136 137 }

This page was automatically generated by Maven