Package org.opencms.jsp
Class CmsJspTagElementSetting
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- org.opencms.jsp.CmsJspTagElementSetting
-
- All Implemented Interfaces:
java.io.Serializable
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
public class CmsJspTagElementSetting extends javax.servlet.jsp.tagext.TagSupport
Provides access to the settings of an ADE container element.- Since:
- 8.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CmsJspTagElementSetting()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
doStartTag()
static java.lang.String
elementSettingTagAction(java.lang.String setting, java.lang.String defaultValue, boolean escape, javax.servlet.ServletRequest req)
Internal action method.static java.util.Map<java.lang.String,java.lang.String>
elementSettingTagAction(javax.servlet.ServletRequest req)
Internal action method.java.lang.String
getDefault()
Returns the default value.java.lang.String
getEscapeHtml()
The value of the escape HTML flag.java.lang.String
getName()
Returns the selected element setting name.void
release()
void
setDefault(java.lang.String def)
Sets the default value.void
setEscapeHtml(java.lang.String value)
Set the escape HTML flag.void
setName(java.lang.String name)
Sets the element setting name.
-
-
-
Constructor Detail
-
CmsJspTagElementSetting
public CmsJspTagElementSetting()
-
-
Method Detail
-
elementSettingTagAction
public static java.util.Map<java.lang.String,java.lang.String> elementSettingTagAction(javax.servlet.ServletRequest req)
Internal action method.- Parameters:
req
- the current request- Returns:
- a map that contains the element settings
-
elementSettingTagAction
public static java.lang.String elementSettingTagAction(java.lang.String setting, java.lang.String defaultValue, boolean escape, javax.servlet.ServletRequest req)
Internal action method.- Parameters:
setting
- the setting to look updefaultValue
- the default valueescape
- if the result String should be HTML escaped or notreq
- the current request- Returns:
- the value of the element setting or
null
if not found
-
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
- Returns:
- SKIP_BODY
- Throws:
javax.servlet.jsp.JspException
- See Also:
Tag.doStartTag()
-
getDefault
public java.lang.String getDefault()
Returns the default value.- Returns:
- the default value
-
getEscapeHtml
public java.lang.String getEscapeHtml()
The value of the escape HTML flag.- Returns:
- the value of the escape HTML flag
-
getName
public java.lang.String getName()
Returns the selected element setting name.- Returns:
- the selected element setting name
-
release
public void release()
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.TagSupport
- See Also:
Tag.release()
-
setDefault
public void setDefault(java.lang.String def)
Sets the default value.This is used if a selected element setting is not found.
- Parameters:
def
- the default value
-
setEscapeHtml
public void setEscapeHtml(java.lang.String value)
Set the escape HTML flag.- Parameters:
value
- must be"true"
or"false"
(all values other then"true"
are considered to be false)
-
setName
public void setName(java.lang.String name)
Sets the element setting name.- Parameters:
name
- the element setting name to set
-
-