blob: 1d9c3967bf802712114ab0cd2e0c1263cf147c6f [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>VelocityOnlyLayout.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Turbine</a> &gt; <a href="index.source.html" class="el_package">org.apache.turbine.modules.layouts</a> &gt; <span class="el_source">VelocityOnlyLayout.java</span></div><h1>VelocityOnlyLayout.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.layouts;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.commons.lang3.StringUtils;
import org.apache.turbine.TurbineConstants;
import org.apache.turbine.annotation.TurbineLoader;
import org.apache.turbine.modules.Screen;
import org.apache.turbine.modules.ScreenLoader;
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.util.template.TemplateNavigation;
import org.apache.velocity.context.Context;
/**
* This Layout module allows Velocity templates to be used as layouts.
* Since dynamic content is supposed to be primarily located in
* screens and navigations there should be relatively few reasons to
* subclass this Layout.
*
* To get the same functionality as with VelocityECSLayout, you can use two
* supplied VelocityMacros, TurbineHtmlHead and TurbineHtmlBodyAttributes
* in your templates. These are used to put HtmlPageAttributes into a page
* before rendering.
*
* Use these macros should be used in the Layout template like this:
*
* ... set things like style sheets, scripts here.
* &amp;lt;html&amp;gt;
* #TurbineHtmlHead()
* &amp;lt;body #TurbineHtmlBodyAttributes() &amp;gt;
* .... your body information
* &amp;lt;/body&amp;gt;
* &amp;lt;/html&amp;gt;
*
* As the layout template is rendered _after_ the screen template, you
* can of course, add information to the $page tool in your screen template.
* This will be added correctly to the &amp;lt;head&amp;gt;...&amp;lt;/head&amp;gt; and
* &amp;lt;body&amp;gt; tags.
*
* @author &lt;a href=&quot;mailto:john.mcnally@clearink.com&quot;&gt;John D. McNally&lt;/a&gt;
* @author &lt;a href=&quot;mailto:mbryson@mont.mindspring.com&quot;&gt;Dave Bryson&lt;/a&gt;
* @author &lt;a href=&quot;mailto:hps@intermeta.de&quot;&gt;Henning P. Schmiedehausen&lt;/a&gt;
* @author &lt;a href=&quot;mailto:peter@courcoux.biz&quot;&gt;Peter Courcoux&lt;/a&gt;
* @version $Id$
*/
<span class="nc" id="L65">public class VelocityOnlyLayout extends VelocityLayout</span>
{
/** Injected loader instance */
@TurbineLoader( Screen.class )
private ScreenLoader screenLoader;
/**
* @see org.apache.turbine.modules.layouts.VelocityLayout#populateContext(org.apache.turbine.pipeline.PipelineData, org.apache.velocity.context.Context)
*/
@Override
protected void populateContext(PipelineData pipelineData, Context context) throws Exception
{
<span class="nc" id="L77"> String screenName = pipelineData.getRunData().getScreen();</span>
<span class="nc" id="L79"> log.debug(&quot;Loading Screen {}&quot;, screenName);</span>
// First, generate the screen and put it in the context so
// we can grab it the layout template.
<span class="nc" id="L83"> String results = screenLoader.eval(pipelineData, screenName);</span>
<span class="nc" id="L84"> String returnValue = StringUtils.defaultIfEmpty(results, StringUtils.EMPTY);</span>
// variable for the screen in the layout template
<span class="nc" id="L87"> context.put(TurbineConstants.SCREEN_PLACEHOLDER, returnValue);</span>
// variable to reference the navigation screen in the layout template
<span class="nc" id="L90"> context.put(TurbineConstants.NAVIGATION_PLACEHOLDER,</span>
new TemplateNavigation(pipelineData));
<span class="nc" id="L92"> }</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html>