|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
org.opencms.jsp.CmsJspTagContentInfo
public class CmsJspTagContentInfo
Used to access and display XML content item information from the VFS.
Field Summary |
---|
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
id, pageContext |
Fields inherited from interface org.opencms.util.I_CmsMacroResolver |
---|
MACRO_DELIMITER, MACRO_DELIMITER_OLD, MACRO_END, MACRO_END_OLD, MACRO_START, MACRO_START_OLD |
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 | |
---|---|
CmsJspTagContentInfo()
|
Method Summary | |
---|---|
int |
doEndTag()
|
int |
doStartTag()
|
java.lang.String |
getMacroValue(java.lang.String macro)
Resolves a single macro to the macro value, returns null if the macro could not be resolved. |
java.lang.String |
getScope()
Returns the scope under which the content info is saved in the page context. |
protected int |
getScopeAsInt(java.lang.String scope)
Returns the int value of the specified scope string. |
java.lang.String |
getValue()
Returns the name of the content info's value that should be printed out. |
java.lang.String |
getVar()
Returns the name of the variable under which the content info bean should be saved in the page context. |
boolean |
isKeepEmptyMacros()
Returns true if macros that could not be resolved are kept "as is" in the
input String, false if they are replaced by an empty String. |
void |
release()
|
java.lang.String |
resolveMacros(java.lang.String input)
Resolves all macros in the input, replacing them with the macro values. |
void |
setScope(java.lang.String scope)
Sets the scope under which the content info is saved in the page context. |
void |
setValue(java.lang.String value)
Sets the name of the content info's value that should be printed out. |
void |
setVar(java.lang.String var)
Sets the name of the variable under which the content info bean should be saved in the page context. |
protected void |
storeContentInfoBean(CmsJspTagContentLoad container,
java.lang.String variable,
int scope)
Stores the container's content info bean under the specified scope in the page context. |
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 |
Constructor Detail |
---|
public CmsJspTagContentInfo()
Method Detail |
---|
public int doEndTag()
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.TagSupport
Tag.doEndTag()
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.JspException
Tag.doStartTag()
public java.lang.String getMacroValue(java.lang.String macro)
I_CmsMacroResolver
null
if the macro could not be resolved.
getMacroValue
in interface I_CmsMacroResolver
macro
- the macro to resolve
null
if the macro could not be resolvedI_CmsMacroResolver.getMacroValue(java.lang.String)
public java.lang.String getScope()
public java.lang.String getValue()
public java.lang.String getVar()
public boolean isKeepEmptyMacros()
I_CmsMacroResolver
true
if macros that could not be resolved are kept "as is" in the
input String, false
if they are replaced by an empty String.
isKeepEmptyMacros
in interface I_CmsMacroResolver
true
if macros that could not be resolved are kept "as is" in the
input String, false
if they are replaced by an empty StringI_CmsMacroResolver.isKeepEmptyMacros()
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
release
in class javax.servlet.jsp.tagext.TagSupport
Tag.release()
public java.lang.String resolveMacros(java.lang.String input)
I_CmsMacroResolver
The flag I_CmsMacroResolver.isKeepEmptyMacros()
controls how to deal with
macros found in the input that can not be resolved.
resolveMacros
in interface I_CmsMacroResolver
input
- the input to resolve the macros in
I_CmsMacroResolver.resolveMacros(java.lang.String)
public void setScope(java.lang.String scope)
scope
- the scope under which the content info is saved in the page contextpublic void setValue(java.lang.String value)
value
- the name of the content info's value that should be printed outpublic void setVar(java.lang.String var)
var
- the name of the variable under which the content info bean should be saved in the page contextprotected int getScopeAsInt(java.lang.String scope)
The default value is PageContext.PAGE_SCOPE
.
scope
- the string name of the desired scope, e.g. "application", "request"
protected void storeContentInfoBean(CmsJspTagContentLoad container, java.lang.String variable, int scope)
container
- the parent containervariable
- the variable under which the content info bean is savedscope
- the scope under which the content info bean is saved
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |