com.cc.framework.taglib.template
Class InsertTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.cc.framework.taglib.template.InsertTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class InsertTag
extends javax.servlet.jsp.tagext.TagSupport

Tag handler for the insert tag.

The tag inserts a template blank in the JSP-Page. The template is a JSP-Page that contains placemarkers for JSP fragments. The JSP-fragments are addressed by means of a logical name. The assignment to physical file names is achieved using -tags, which are specified within the <template:insert>-tags. For every placeholder in the template, a corresponding <template:put>-tag can be specified.

Since:
1.0
Version:
$Revision: 1.14 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  java.lang.String base
          Base directory for resources
private  java.lang.String localeName
          Locale Name
private static long serialVersionUID
          Serial Version UID
private  java.lang.String template
          The template
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
InsertTag()
          Constructor
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
private  void exposeScriptingVariables(PageDef page)
          Exposes the Page Definition instance as a scripting variable to the Tag body
 void release()
           
 void setBase(java.lang.String base)
          The base directory for the JSP-pages is determined with the base attribute.
 void setLocale(java.lang.String loc)
           
 void setPageContext(javax.servlet.jsp.PageContext arg0)
           
 void setTemplate(java.lang.String template)
          Specifies the physical filename of the JSP-templates file.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serial Version UID

See Also:
Constant Field Values

template

private java.lang.String template
The template


base

private java.lang.String base
Base directory for resources


localeName

private java.lang.String localeName
Locale Name

Constructor Detail

InsertTag

public InsertTag()
Constructor

Method Detail

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext arg0)
See Also:
Tag.setPageContext(javax.servlet.jsp.PageContext)

release

public void release()
See Also:
Tag.release()

exposeScriptingVariables

private void exposeScriptingVariables(PageDef page)
Exposes the Page Definition instance as a scripting variable to the Tag body

Parameters:
page - The Page Definition

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Throws:
javax.servlet.jsp.JspException
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Throws:
javax.servlet.jsp.JspException
See Also:
Tag.doEndTag()

setBase

public void setBase(java.lang.String base)
The base directory for the JSP-pages is determined with the base attribute. This also has an influence on the included <template:put>-tags. The base directory can be individually set for every Painter, as the following example shows:
  def:/jspDef;myPainter:/jspCustom;/jspOther
 
The example uses CAUTION: The base directory is taken into consideration only in the case of JSP-files that start with '$'.

Parameters:
base - The base directory (template list) for the JSP-pages

setTemplate

public void setTemplate(java.lang.String template)
Specifies the physical filename of the JSP-templates file. The filename is enhanced with the base directory if it starts with $.

Parameters:
template - The template to set

setLocale

public void setLocale(java.lang.String loc)
Parameters:
loc - Locale


Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.