|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opencms.jsp.CmsJspTagContentLoad
Implementation of the <cms:contentload/>
tag,
used to access and display XML content item information from the VFS.
Field Summary |
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, 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 | |
CmsJspTagContentLoad()
Empty constructor, required for JSP tags. |
|
CmsJspTagContentLoad(I_CmsXmlContentContainer container,
javax.servlet.jsp.PageContext context,
java.lang.String collectorName,
java.lang.String collectorParam,
java.util.Locale locale,
boolean editable)
Constructor used when using contentload from scriptlet code. |
|
CmsJspTagContentLoad(I_CmsXmlContentContainer container,
javax.servlet.jsp.PageContext context,
java.lang.String collectorName,
java.lang.String collectorParam,
java.lang.String pageIndex,
java.lang.String pageSize,
java.util.Locale locale,
boolean editable)
Constructor used when using contentload from scriptlet code. |
|
CmsJspTagContentLoad(I_CmsXmlContentContainer container,
javax.servlet.jsp.PageContext context,
java.lang.String collectorName,
java.lang.String collectorParam,
java.lang.String pageIndex,
java.lang.String pageSize,
java.util.Locale locale,
CmsDirectEditMode editMode)
Constructor used when using contentload from scriptlet code. |
Method Summary | |
int |
doAfterBody()
|
int |
doEndTag()
|
protected void |
doLoadNextFile()
Load the next file name from the initialized list of file names. |
int |
doStartTag()
|
java.lang.String |
getCollector()
Returns the collector. |
java.lang.String |
getCollectorName()
Returns the name of the currently used XML content collector. |
java.lang.String |
getCollectorParam()
Returns the parameters of the currently used XML content collector. |
java.util.List |
getCollectorResult()
Returns the list of all currently loaded XML content documents (instances of ). |
protected CmsContentInfoBean |
getContentInfoBean()
Returns the content info bean. |
java.lang.String |
getEditable()
Returns the editable flag. |
java.lang.String |
getLocale()
Returns the locale. |
java.lang.String |
getPageIndex()
Returns the index of the page to be displayed. |
java.lang.String |
getPageNavLength()
Returns the number of page links in the Google-like page navigation. |
java.lang.String |
getPageSize()
Returns the size of a single page to be displayed. |
java.lang.String |
getParam()
Returns the collector parameter. |
java.lang.String |
getPreload()
Returns "true" if this content load tag should only preload the values from the collector. |
java.lang.String |
getProperty()
Returns the property. |
java.lang.String |
getResourceName()
Returns the resource name in the VFS for the currently loaded XML content document. |
protected static java.lang.String |
getResourceName(CmsObject cms,
I_CmsXmlContentContainer contentContainer)
Returns the resource name currently processed. |
I_CmsXmlDocument |
getXmlDocument()
Returns the currently loaded OpenCms XML content document. |
java.lang.String |
getXmlDocumentElement()
Returns the currently selected element name in the loaded XML content document. |
java.util.Locale |
getXmlDocumentLocale()
Returns the currently selected locale used for acessing the content in the loaded XML content document. |
boolean |
hasMoreContent()
Content iteration method to be used by JSP scriptlet code. |
protected void |
init(I_CmsXmlContentContainer container)
Initializes this content load tag. |
boolean |
isPreloader()
Returns true if this container is used as a content preloader. |
void |
release()
|
void |
setCollector(java.lang.String collector)
Sets the collector. |
void |
setEditable(java.lang.String mode)
Sets the editable mode. |
void |
setLocale(java.lang.String locale)
Sets the locale. |
void |
setPageIndex(java.lang.String pageIndex)
Sets the index of the page to be displayed. |
void |
setPageNavLength(java.lang.String pageNavLength)
Sets the number of page links in the Google-like page navigation. |
void |
setPageSize(java.lang.String pageSize)
Sets the size of a single page to be displayed. |
void |
setParam(java.lang.String param)
Sets the collector parameter. |
void |
setPreload(java.lang.String preload)
Sets the preload flag for this content load tag. |
void |
setProperty(java.lang.String property)
Sets the property. |
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
doInitBody, getBodyContent, getPreviousOut, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
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 |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
getParent, setPageContext, setParent |
Constructor Detail |
public CmsJspTagContentLoad()
public CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.util.Locale locale, boolean editable) throws javax.servlet.jsp.JspException
contentload
from scriptlet code.
container
- the parent content container (could be a preloader)context
- the JSP page contextcollectorName
- the collector name to usecollectorParam
- the collector param to uselocale
- the locale to useeditable
- indicates if "direct edit" support is wanted
javax.servlet.jsp.JspException
- in case something goes wrongpublic CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.lang.String pageIndex, java.lang.String pageSize, java.util.Locale locale, boolean editable) throws javax.servlet.jsp.JspException
contentload
from scriptlet code.
container
- the parent content container (could be a preloader)context
- the JSP page contextcollectorName
- the collector name to usecollectorParam
- the collector param to usepageIndex
- the display page index (may contain macros)pageSize
- the display page size (may contain macros)locale
- the locale to useeditable
- indicates if "direct edit" support is wanted
javax.servlet.jsp.JspException
- in case something goes wrongpublic CmsJspTagContentLoad(I_CmsXmlContentContainer container, javax.servlet.jsp.PageContext context, java.lang.String collectorName, java.lang.String collectorParam, java.lang.String pageIndex, java.lang.String pageSize, java.util.Locale locale, CmsDirectEditMode editMode) throws javax.servlet.jsp.JspException
contentload
from scriptlet code.
container
- the parent content container (could be a preloader)context
- the JSP page contextcollectorName
- the collector name to usecollectorParam
- the collector param to usepageIndex
- the display page index (may contain macros)pageSize
- the display page size (may contain macros)locale
- the locale to useeditMode
- indicates which "direct edit" mode is wanted
javax.servlet.jsp.JspException
- in case something goes wrongMethod Detail |
protected static java.lang.String getResourceName(CmsObject cms, I_CmsXmlContentContainer contentContainer)
cms
- the current OpenCms user contextcontentContainer
- the current content container
public int doAfterBody() throws javax.servlet.jsp.JspException
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
javax.servlet.jsp.JspException
BodyTagSupport.doAfterBody()
public int doEndTag()
doEndTag
in interface javax.servlet.jsp.tagext.Tag
Tag.doEndTag()
public int doStartTag() throws javax.servlet.jsp.JspException, CmsIllegalArgumentException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
javax.servlet.jsp.JspException
CmsIllegalArgumentException
Tag.doStartTag()
public java.lang.String getCollector()
public java.lang.String getCollectorName()
I_CmsXmlContentContainer
getCollectorName
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorName()
public java.lang.String getCollectorParam()
I_CmsXmlContentContainer
getCollectorParam
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorParam()
public java.util.List getCollectorResult()
I_CmsXmlContentContainer
I_CmsXmlDocument
).
getCollectorResult
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getCollectorResult()
public java.lang.String getEditable()
public java.lang.String getLocale()
public java.lang.String getPageIndex()
public java.lang.String getPageNavLength()
public java.lang.String getPageSize()
public java.lang.String getParam()
public java.lang.String getPreload()
"true"
if this content load tag should only preload the values from the collector.
"true"
if this content load tag should only preload the values from the collectorpublic java.lang.String getProperty()
public java.lang.String getResourceName()
I_CmsXmlContentContainer
getResourceName
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getResourceName()
public I_CmsXmlDocument getXmlDocument()
I_CmsXmlContentContainer
getXmlDocument
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocument()
public java.lang.String getXmlDocumentElement()
I_CmsXmlContentContainer
getXmlDocumentElement
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocumentElement()
public java.util.Locale getXmlDocumentLocale()
I_CmsXmlContentContainer
getXmlDocumentLocale
in interface I_CmsXmlContentContainer
I_CmsXmlContentContainer.getXmlDocumentLocale()
public boolean hasMoreContent() throws javax.servlet.jsp.JspException
I_CmsXmlContentContainer
Calling this method will insert "direct edit" HTML to the output page (if required).
hasMoreContent
in interface I_CmsXmlContentContainer
true
if more content is to be iterated
javax.servlet.jsp.JspException
- in case something goes wrongI_CmsXmlContentContainer.hasMoreContent()
public boolean isPreloader()
I_CmsXmlContentContainer
true
if this container is used as a content preloader.A content preloader is used to load content without looping through it.
isPreloader
in interface I_CmsXmlContentContainer
true
if this container is used as a content preloaderI_CmsXmlContentContainer.isPreloader()
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
Tag.release()
public void setCollector(java.lang.String collector)
collector
- the collector to setpublic void setEditable(java.lang.String mode)
mode
- the mode to setpublic void setLocale(java.lang.String locale)
locale
- the locale to setpublic void setPageIndex(java.lang.String pageIndex)
pageIndex
- the index of the page to be displayedpublic void setPageNavLength(java.lang.String pageNavLength)
pageNavLength
- the number of page links in the Google-like page navigationpublic void setPageSize(java.lang.String pageSize)
pageSize
- the size of a single page to be displayedpublic void setParam(java.lang.String param)
param
- the collector parameter to setpublic void setPreload(java.lang.String preload)
If this is set to true
, then the collector result will only
be preloaded, but not iterated.
preload
- the preload flag to setpublic void setProperty(java.lang.String property)
property
- the property to setprotected void doLoadNextFile() throws CmsException
CmsException
- if something goes wrongprotected CmsContentInfoBean getContentInfoBean()
protected void init(I_CmsXmlContentContainer container) throws javax.servlet.jsp.JspException
container
- the parent container (could be a preloader)
javax.servlet.jsp.JspException
- in case something goes wrong
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |