org.opencms.jsp

类 CmsJspTagContainer

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.opencms.jsp.CmsJspTagContainer

所有已实现的接口:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CmsJspTagContainer
extends javax.servlet.jsp.tagext.TagSupport

Provides access to the page container elements.

从以下版本开始:

8.0

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsJspTagContainer.JsonContainer Json property name constants for containers.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_MAX_ELEMENTS Default number of max elements in the container in case no value has been set.
static java.lang.String	DETAIL_CONTAINERS_FOLDER_NAME The detail containers folder name.
static java.lang.String	DUMMY_ELEMENT HTML used for invisible dummy elements.
static java.lang.String	KEY_CONTAINER_DATA Key used to write container data into the javascript window object.

从类继承的字段 javax.servlet.jsp.tagext.TagSupport

id, pageContext

从接口继承的字段 javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

从接口继承的字段 javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器

构造器和说明
CmsJspTagContainer()

方法概要

方法

限定符和类型	方法和说明
int	doStartTag() Internal action method.
protected static java.lang.String	getContainerDataTag(CmsContainerBean container, java.lang.String widthStr, boolean isDetailView, boolean isDetailOnly) Creates a new data tag for the given container.
static java.lang.String	getDetailOnlyPageName(java.lang.String detailContentSitePath) Returns the site path to the detail only container page.
java.lang.String	getDetailview() Returns the boolean value if this container is target of detail views.
static java.util.List<CmsContainerElementBean>	getGroupContainerElements(CmsObject cms, CmsContainerElementBean element, javax.servlet.ServletRequest req, java.lang.String containerType) Returns the element group elements.
static java.util.List<CmsContainerElementBean>	getInheritedContainerElements(CmsObject cms, CmsContainerElementBean element) Reads elements from an inherited container.
java.lang.String	getMaxElements() Returns the maxElements attribute value.
java.lang.String	getName() Returns the name attribute value.
java.lang.String	getTag() Returns the tag attribute.
java.lang.String	getTagClass() Returns the tag class attribute.
protected static java.lang.String	getTagClose(java.lang.String tagName) Creates the closing tag for the container.
protected static java.lang.String	getTagOpen(java.lang.String tagName, java.lang.String containerName, java.lang.String tagClass) Creates the opening tag for the container assigning the appropriate id and class attributes.
java.lang.String	getType() Returns the type attribute value.
java.lang.String	getWidth() Returns the container width as a string.
protected void	printElementWrapperTagEnd(boolean isOnline, boolean isGroupcontainer) Prints the closing tag for an element wrapper if in online mode.
protected void	printElementWrapperTagStart(boolean isOnline, CmsObject cms, CmsContainerElementBean elementBean, boolean isGroupContainer) Prints the opening element wrapper tag for the container page editor if we are in Offline mode.
void	release()
void	setDetailonly(java.lang.String detailOnly) Sets if this container should only be displayed on detail pages.
void	setDetailview(java.lang.String detailView) Sets if the current container is target of detail views.
void	setMaxElements(java.lang.String maxElements) Sets the maxElements attribute value.
void	setName(java.lang.String name) Sets the name attribute value.
void	setTag(java.lang.String tag) Sets the tag attribute.
void	setTagClass(java.lang.String tagClass) Sets the tag class attribute.
void	setType(java.lang.String type) Sets the type attribute value.
void	setWidth(java.lang.String width) Sets the container width as a string.

从类继承的方法 javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_MAX_ELEMENTS

public static final java.lang.String DEFAULT_MAX_ELEMENTS

Default number of max elements in the container in case no value has been set.

另请参阅:

常量字段值

DETAIL_CONTAINERS_FOLDER_NAME

public static final java.lang.String DETAIL_CONTAINERS_FOLDER_NAME

The detail containers folder name.

另请参阅:

常量字段值

DUMMY_ELEMENT

public static final java.lang.String DUMMY_ELEMENT

HTML used for invisible dummy elements.

另请参阅:

常量字段值

KEY_CONTAINER_DATA

public static final java.lang.String KEY_CONTAINER_DATA

Key used to write container data into the javascript window object.

另请参阅:

常量字段值

构造器详细资料

CmsJspTagContainer

public CmsJspTagContainer()

方法详细资料

getDetailOnlyPageName

public static java.lang.String getDetailOnlyPageName(java.lang.String detailContentSitePath)

Returns the site path to the detail only container page.

参数:

detailContentSitePath - the detail content site path

返回:

the site path to the detail only container page

getGroupContainerElements

public static java.util.List<CmsContainerElementBean> getGroupContainerElements(CmsObject cms,
                                                                CmsContainerElementBean element,
                                                                javax.servlet.ServletRequest req,
                                                                java.lang.String containerType)
                                                                         throws CmsException

Returns the element group elements.

参数:

cms - the current cms context

element - group element

req - the servlet request

containerType - the container type

返回:

the elements of this group

抛出:

CmsException - if something goes wrong

getInheritedContainerElements

public static java.util.List<CmsContainerElementBean> getInheritedContainerElements(CmsObject cms,
                                                                    CmsContainerElementBean element)

Reads elements from an inherited container.

参数:

cms - the current CMS context

element - the element which references the inherited container

返回:

the container elements

getContainerDataTag

protected static java.lang.String getContainerDataTag(CmsContainerBean container,
                                   java.lang.String widthStr,
                                   boolean isDetailView,
                                   boolean isDetailOnly)
                                               throws JSONException

Creates a new data tag for the given container.

参数:

container - the container to get the data tag for

widthStr - the width of the container as a string

isDetailView - true if this container is currently being used for the detail view

isDetailOnly - true if this container is displayed in detail view only

返回:

html data tag for the given container

抛出:

JSONException - if there is a problem with JSON manipulation

getTagClose

protected static java.lang.String getTagClose(java.lang.String tagName)

Creates the closing tag for the container.

参数:

tagName - the tag name

返回:

the closing tag

getTagOpen

protected static java.lang.String getTagOpen(java.lang.String tagName,
                          java.lang.String containerName,
                          java.lang.String tagClass)

Creates the opening tag for the container assigning the appropriate id and class attributes.

参数:

tagName - the tag name

containerName - the container name used as id attribute value

tagClass - the tag class attribute value

返回:

the opening tag

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Internal action method.

指定者:

doStartTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doStartTag 在类中 javax.servlet.jsp.tagext.TagSupport

返回:

SKIP_BODY

抛出:

javax.servlet.jsp.JspException - in case something goes wrong

另请参阅:

Tag.doStartTag()

getDetailview

public java.lang.String getDetailview()

Returns the boolean value if this container is target of detail views.

返回:

true or false

getMaxElements

public java.lang.String getMaxElements()

Returns the maxElements attribute value.

返回:

the maxElements attribute value

getName

public java.lang.String getName()

Returns the name attribute value.

返回:

String the name attribute value

getTag

public java.lang.String getTag()

Returns the tag attribute.

返回:

the tag attribute

getTagClass

public java.lang.String getTagClass()

Returns the tag class attribute.

返回:

the tag class attribute

getType

public java.lang.String getType()

Returns the type attribute value.

If the container type has not been set, the name is substituted as type.

返回:

the type attribute value

getWidth

public java.lang.String getWidth()

Returns the container width as a string.

返回:

the container width as a string

release

public void release()

指定者:

release 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

release 在类中 javax.servlet.jsp.tagext.TagSupport

另请参阅:

Tag.release()

setDetailonly

public void setDetailonly(java.lang.String detailOnly)

Sets if this container should only be displayed on detail pages.

参数:

detailOnly - if this container should only be displayed on detail pages

setDetailview

public void setDetailview(java.lang.String detailView)

Sets if the current container is target of detail views.

参数:

detailView - true or false

setMaxElements

public void setMaxElements(java.lang.String maxElements)

Sets the maxElements attribute value.

参数:

maxElements - the maxElements value to set

setName

public void setName(java.lang.String name)

Sets the name attribute value.

参数:

name - the name value to set

setTag

public void setTag(java.lang.String tag)

Sets the tag attribute.

参数:

tag - the createTag to set

setTagClass

public void setTagClass(java.lang.String tagClass)

Sets the tag class attribute.

参数:

tagClass - the tag class attribute to set

setType

public void setType(java.lang.String type)

Sets the type attribute value.

参数:

type - the type value to set

setWidth

public void setWidth(java.lang.String width)

Sets the container width as a string.

参数:

width - the container width as a string

printElementWrapperTagEnd

protected void printElementWrapperTagEnd(boolean isOnline,
                             boolean isGroupcontainer)
                                  throws java.io.IOException

Prints the closing tag for an element wrapper if in online mode.

参数:

isOnline - if true, we are online

isGroupcontainer - true if element is a group-container

抛出:

java.io.IOException - if the output fails

printElementWrapperTagStart

protected void printElementWrapperTagStart(boolean isOnline,
                               CmsObject cms,
                               CmsContainerElementBean elementBean,
                               boolean isGroupContainer)
                                    throws java.lang.Exception

Prints the opening element wrapper tag for the container page editor if we are in Offline mode.

参数:

isOnline - true if we are in Online mode

cms - the Cms context

elementBean - the element bean

isGroupContainer - true if the element is a group-container

抛出:

java.lang.Exception - if something goes wrong