org.apache.pluto.tags
Class BaseURLTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.pluto.tags.BaseURLTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
PortletURLTag, ResourceURLTag

public abstract class BaseURLTag
extends javax.servlet.jsp.tagext.TagSupport

Abstract supporting class for actionURL tag, renderURL tag and resourceURL tag.

Version:
2.0
See Also:
Serialized Form

Nested Class Summary
static class BaseURLTag.TEI
          TagExtraInfo class for BaseUrlTag.
 
Field Summary
protected  Boolean escapeXml
           
protected  Map<String,List<String>> parametersMap
           
protected  Map<String,List<String>> propertiesMap
           
protected  String secure
           
protected  Boolean secureBoolean
           
protected  String var
           
 
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
BaseURLTag()
           
 
Method Summary
protected  void addParameter(String key, String value)
          Adds a key,value pair to the parameter map.
protected  void addProperty(String key, String value)
          Adds a key,value pair to the property map.
abstract  int doEndTag()
           
protected  String doEscapeXml(String str)
          Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.
abstract  int doStartTag()
           
 Boolean getEscapeXml()
          Returns escapeXml property.
 String getSecure()
          Returns secure property as String.
 boolean getSecureBoolean()
          Returns secure property as Boolean.
 String getVar()
          Returns the var property.
 void release()
           
 void setEscapeXml(Boolean escapeXml)
          Sets the escapeXml property.
 void setSecure(String secure)
          Sets secure property to boolean value of the string.
protected  void setUrlParameters(BaseURL url)
          Copies the parameters from map to the BaseURL.
protected  void setUrlProperties(BaseURL url)
          Copies the properties from map to the BaseURL.
 void setVar(String var)
          Sets the var property.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

secure

protected String secure

secureBoolean

protected Boolean secureBoolean

var

protected String var

escapeXml

protected Boolean escapeXml

parametersMap

protected Map<String,List<String>> parametersMap

propertiesMap

protected Map<String,List<String>> propertiesMap
Constructor Detail

BaseURLTag

public BaseURLTag()
Method Detail

doStartTag

public abstract int doStartTag()
                        throws javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

doEndTag

public abstract int doEndTag()
                      throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class javax.servlet.jsp.tagext.TagSupport

getSecure

public String getSecure()
Returns secure property as String.

Returns:
String

getSecureBoolean

public boolean getSecureBoolean()
Returns secure property as Boolean.

Returns:
boolean

getVar

public String getVar()
Returns the var property.

Returns:
String

getEscapeXml

public Boolean getEscapeXml()
Returns escapeXml property.

Returns:
Boolean

setSecure

public void setSecure(String secure)
Sets secure property to boolean value of the string.

Parameters:
secure -

setVar

public void setVar(String var)
Sets the var property.

Parameters:
var - The var to set

setEscapeXml

public void setEscapeXml(Boolean escapeXml)
Sets the escapeXml property.

Parameters:
escapeXml -

addParameter

protected void addParameter(String key,
                            String value)
Adds a key,value pair to the parameter map.

Parameters:
key - String
value - String

addProperty

protected void addProperty(String key,
                           String value)
Adds a key,value pair to the property map.

Parameters:
key - String
value - String

setUrlParameters

protected void setUrlParameters(BaseURL url)
Copies the parameters from map to the BaseURL.

Parameters:
url - BaseURL

setUrlProperties

protected void setUrlProperties(BaseURL url)
Copies the properties from map to the BaseURL.

Parameters:
url - BaseURL

doEscapeXml

protected String doEscapeXml(String str)
Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.

Parameters:
str - - the String where to replace
Returns:
String


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.