Expresso 5-6

com.jcorporate.expresso.ext.taglib
Class ExSetupTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended byorg.apache.struts.taglib.bean.DefineTag
              extended bycom.jcorporate.expresso.ext.taglib.ExSetupTag
All Implemented Interfaces:
BodyTag, IterationTag, Serializable, Tag

public class ExSetupTag
extends org.apache.struts.taglib.bean.DefineTag

Define a scripting variable based on the value(s) of the specified bean property.

Author:
Shash Chatterjee
See Also:
Serialized Form

Field Summary
protected  String db
          Defines the db Context to use in the tag.
protected  String dbToUse
           
protected  String optional
          Boolean value to determine if the setup value is required or optional.
protected  String optionalToUse
           
protected  String schema
          Defines the application schema to lookup for this setup value.
protected  String schemaToUse
           
 
Fields inherited from class org.apache.struts.taglib.bean.DefineTag
body, id, messages, name, property, scope, toScope, type, value
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
ExSetupTag()
           
 
Method Summary
 int doEndTag()
          Retrieve the required property and expose it as a scripting variable.
 int doStartTag()
          Retrieve the required property and expose it as a scripting variable.
 String getDb()
           
 String getOptional()
           
 String getSchema()
           
 void setDb(String newDb)
           
 void setOptional(String newOptional)
           
 void setSchema(String newValue)
           
 
Methods inherited from class org.apache.struts.taglib.bean.DefineTag
doAfterBody, getId, getName, getProperty, getScope, getToScope, getType, getValue, release, setId, setName, setProperty, setScope, setToScope, setType, setValue
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Field Detail

db

protected String db
Defines the db Context to use in the tag.


dbToUse

protected String dbToUse

optional

protected String optional
Boolean value to determine if the setup value is required or optional.


optionalToUse

protected String optionalToUse

schema

protected String schema
Defines the application schema to lookup for this setup value. (Optional) If not used, then com.jcorporate.expresso.core.ExpressoSchema is used.


schemaToUse

protected String schemaToUse
Constructor Detail

ExSetupTag

public ExSetupTag()
Method Detail

doStartTag

public int doStartTag()
               throws JspException
Retrieve the required property and expose it as a scripting variable.

Returns:
int as defined by the JSP taglib spec
Throws:
JspException - if a JSP exception has occurred

getDb

public String getDb()

setDb

public void setDb(String newDb)

getOptional

public String getOptional()

setOptional

public void setOptional(String newOptional)

getSchema

public String getSchema()

setSchema

public void setSchema(String newValue)

doEndTag

public int doEndTag()
             throws JspException
Retrieve the required property and expose it as a scripting variable.

Returns:
integer as per the jsp taglib spec
Throws:
JspException - if a JSP exception has occurred

Expresso 5-6

Please see www.jcorporate.com for information about new Expresso releases.