/*
  Copyright (C) 2006 Helge Hess

  This file is part of JOPE.

  JOPE is free software; you can redistribute it and/or modify it under
  the terms of the GNU Lesser General Public License as published by the
  Free Software Foundation; either version 2, or (at your option) any
  later version.

  JOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with JOPE; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

package org.opengroupware.jope.appserver.elements;

import java.util.Map;

import org.opengroupware.jope.appserver.core.WOAssociation;
import org.opengroupware.jope.appserver.core.WOContext;
import org.opengroupware.jope.appserver.core.WOElement;
import org.opengroupware.jope.appserver.core.WOElementWalker;
import org.opengroupware.jope.appserver.core.WORequest;
import org.opengroupware.jope.appserver.core.WOResponse;

/*
 * WOGenericContainer
 *
 * This renders an arbitary (HTML) tag. It allows you to make attributes of the
 * tag dynamic. WOGenericContainer is for elements which have close tags (like
 * font), for empty elements use WOGenericElement (like <br/>).
 * 
 * Sample:
 *   MyFont: WOGenericContainer {
 *     elementName = "font";
 *     color       = currentColor;
 *   }
 *   
 * Renders:
 *   <font color="[red]">[sub-template]</font>
 *   
 * Bindings:
 *   tagName [in] - string
 *   - all other bindings are mapped to tag attributes
 */
public class WOGenericContainer extends WOGenericElement {
  
  protected WOElement template;

  public WOGenericContainer(String _n, Map<String, WOAssociation> _assoc,
                            WOElement _template)
  {
    super(_n, _assoc, _template);
    
    this.template = _template;
  }

  /* responder */
  
  @Override
  public void takeValuesFromRequest(WORequest _rq, WOContext _ctx) {
    this.template.takeValuesFromRequest(_rq, _ctx);
  }
  
  @Override
  public Object invokeAction(WORequest _rq, WOContext _ctx) {
    return this.template.invokeAction(_rq, _ctx);
  }
  
  @Override
  public void appendToResponse(WOResponse _r, WOContext _ctx) {
    if (_ctx.isRenderingDisabled()) {
      if (this.template != null)
        this.template.appendToResponse(_r, _ctx);
      return;
    }

    boolean omit = false;
    String s = null;
    
    if (this.omitTags != null)
      omit = this.omitTags.booleanValueInComponent(_ctx.cursor());
    
    if (!omit && this.tagName != null)
      s = this.tagName.stringValueInComponent(_ctx.cursor());
    
    /* open tag */

    if (s != null) {
      _r.appendBeginTag(s);
      this.appendExtraAttributesToResponse(_r, _ctx);
      
      if (this.template != null)
        _r.appendBeginTagEnd();
      else {
        _r.appendBeginTagClose(); /* we are done, no further content */
        return;
      }
    }
    
    /* add content */
    
    if (this.template != null)
      this.template.appendToResponse(_r, _ctx);
    
    /* close tag */
    
    if (s != null)
      _r.appendEndTag(s);
  }
  
  @Override
  public void walkTemplate(WOElementWalker _walker, WOContext _ctx) {
    if (this.template != null)
      _walker.processTemplate(this, this.template, _ctx);
  }
}