You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by ar...@apache.org on 2002/05/13 03:41:11 UTC

cvs commit: jakarta-struts/src/share/org/apache/struts/taglib/nested NestedWriteNestingTag.java

arron       02/05/12 18:41:11

  Added:       src/share/org/apache/struts/taglib/nested
                        NestedWriteNestingTag.java
  Log:
  Tag missing from tld description.
  Provides better access to the underlying nesting values the tag rely upon.
  
  Revision  Changes    Path
  1.1                  jakarta-struts/src/share/org/apache/struts/taglib/nested/NestedWriteNestingTag.java
  
  Index: NestedWriteNestingTag.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/nested/NestedWriteNestingTag.java,v 1.1 2002/05/13 01:41:11 arron Exp $
   * $Revision: 1.1 $
   * $Date: 2002/05/13 01:41:11 $
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Struts", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package org.apache.struts.taglib.nested;
  
  import javax.servlet.jsp.*;
  import javax.servlet.jsp.tagext.*;
  import javax.servlet.http.HttpSession;
  import org.apache.struts.util.*;
  
  /**
   * NestedWriteNestingTag.
   *
   * Created so developers could have a more elegant way of getting to the
   * underlying nested property their tag properties are referencing.
   *
   * @author Arron Bates
   * @since Struts 1.1
   * @version $Revision: 1.1 $
   */
  public class NestedWriteNestingTag extends BodyTagSupport implements NestedPropertySupport {
    
    /** Getter method for the <i>property</i> property
     * @return String value of the property property
     */
    public String getProperty() {
      return this.property;
    }
  
    /** Setter method for the <i>property</i> property
     * @param property new value for the property property
     */
    public void setProperty(String newProperty) {
      this.property = newProperty;
    }
    
    
    /** Getter method for the <i>filter</i> property
     * @return String value of the filter property
     */
    public boolean getFilter() {
      return this.filter;
    }
  
    /** Setter method for the <i>filter</i> property
     * @param property new value for the filter property
     */
    public void setFilter(boolean newFilter) {
      this.filter = newFilter;
    }
    
    
    /**
     * Overriding method of the heart of the tag. Gets the relative property
     * and tells the JSP engine to evaluate its body content.
     *
     * @return int JSP continuation directive.
     */
    public int doStartTag() throws JspException {
      
      /* qualified nested property */
      String nProperty = null;
      /* property which we can process against */
      String usableProperty = null;
      
      /* make sure we're working against good property */
      if (this.property == null || this.property.trim().length() <= 0) {
        usableProperty = "./";
      } else {
        usableProperty = this.property;
      }
      
      Tag pTag = NestedPropertyHelper.getNestingParentTag(this);
      /* set the nested property value */
      nProperty = NestedPropertyHelper.getNestedProperty(usableProperty, pTag);
      
      /* write output, filtering if required */
      if (this.filter) {
        ResponseUtils.write(pageContext, ResponseUtils.filter(nProperty));
      } else {
        ResponseUtils.write(pageContext, nProperty);
      }
      
      /* continue with page processing */
      return (SKIP_BODY);
    }
    
    
    /**
     * JSP method to release all resources held by the tag.
     */
    public void release() {
      super.release();
      this.property = null;
      this.filter = false;
    }
    
    /* the usual private member variable */
    private String property = null;
    private boolean filter = false;
  }
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>