Package org.opencms.jsp
Class CmsJspTagUgc
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- org.opencms.jsp.CmsJspTagUgc
-
- All Implemented Interfaces:
java.io.Serializable
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
public class CmsJspTagUgc extends javax.servlet.jsp.tagext.TagSupport
Jsp tag to initialize an editing session for user generated content.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_ERROR_MESSAGE_ATTR
The default page context attribute name for the form error message.static java.lang.String
DEFAULT_SESSION_ID_ATTR
The default page context attribute name for the form session id.
-
Constructor Summary
Constructors Constructor Description CmsJspTagUgc()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
doEndTag()
int
doStartTag()
java.lang.String
getConfigPath()
Returns the site path to the edit configuration file.java.lang.String
getEditId()
Returns the structure id of the edit resource.java.lang.String
getEditName()
Returns the file name of the edit resource.java.lang.String
getError()
Returns the page context attribute name for the form error message.java.lang.String
getVar()
Returns the page context attribute name for the form session id.void
setConfigPath(java.lang.String configPath)
Sets the site path to the edit configuration file.void
setEditId(java.lang.String editId)
Sets the structure id of the edit resource.void
setEditName(java.lang.String editName)
Sets the file name of the edit resource.void
setError(java.lang.String error)
Sets the page context attribute name for the form error message.void
setVar(java.lang.String var)
Sets the page context attribute name for the form session id.
-
-
-
Field Detail
-
DEFAULT_ERROR_MESSAGE_ATTR
public static final java.lang.String DEFAULT_ERROR_MESSAGE_ATTR
The default page context attribute name for the form error message.- See Also:
- Constant Field Values
-
DEFAULT_SESSION_ID_ATTR
public static final java.lang.String DEFAULT_SESSION_ID_ATTR
The default page context attribute name for the form session id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsJspTagUgc
public CmsJspTagUgc()
-
-
Method Detail
-
doEndTag
public int doEndTag() throws javax.servlet.jsp.JspException
- Specified by:
doEndTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.TagSupport
- Throws:
javax.servlet.jsp.JspException
- See Also:
TagSupport.doEndTag()
-
doStartTag
public int doStartTag() throws javax.servlet.jsp.JspException
- Specified by:
doStartTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.TagSupport
- Throws:
javax.servlet.jsp.JspException
- See Also:
TagSupport.doStartTag()
-
getConfigPath
public java.lang.String getConfigPath()
Returns the site path to the edit configuration file.- Returns:
- site path to the edit configuration file
-
getEditId
public java.lang.String getEditId()
Returns the structure id of the edit resource.- Returns:
- structure id of the edit resource
-
getEditName
public java.lang.String getEditName()
Returns the file name of the edit resource.- Returns:
- the file name of the edit resource
-
getError
public java.lang.String getError()
Returns the page context attribute name for the form error message.- Returns:
- the page context attribute name for the form error message
-
getVar
public java.lang.String getVar()
Returns the page context attribute name for the form session id.- Returns:
- the page context attribute name for the form session id
-
setConfigPath
public void setConfigPath(java.lang.String configPath)
Sets the site path to the edit configuration file.- Parameters:
configPath
- the site path to the edit configuration file
-
setEditId
public void setEditId(java.lang.String editId)
Sets the structure id of the edit resource.- Parameters:
editId
- the structure id of the edit resource
-
setEditName
public void setEditName(java.lang.String editName)
Sets the file name of the edit resource.- Parameters:
editName
- the file name of the edit resource
-
setError
public void setError(java.lang.String error)
Sets the page context attribute name for the form error message.- Parameters:
error
- the page context attribute name for the form error message
-
setVar
public void setVar(java.lang.String var)
Sets the page context attribute name for the form session id.- Parameters:
var
- page context attribute name for the form session id
-
-