Uses of Class
org.opencms.xml.containerpage.CmsContainerElementBean
-
Packages that use CmsContainerElementBean Package Description org.opencms.ade.configuration Contains the ade configuration classes.org.opencms.ade.containerpage Contains the container page editor service classes.org.opencms.ade.containerpage.inherited Contains classes used for reading and caching inheritance groups.org.opencms.i18n.tools Tools for i18n.org.opencms.jsp The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.org.opencms.jsp.util Utility classes to be used for JSP pages.org.opencms.workplace.editors.directedit Used to control the generation of the HTML for the "direct edit" buttons.org.opencms.xml.containerpage Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.org.opencms.xml.containerpage.mutable org.opencms.xml.templatemapper org.opencms.xml.xml2json.renderer -
-
Uses of CmsContainerElementBean in org.opencms.ade.configuration
Methods in org.opencms.ade.configuration that return CmsContainerElementBean Modifier and Type Method Description protected CmsContainerElementBean
CmsADEManager. elementFromJson(JSONObject data)
Creates an element from its serialized data.CmsContainerElementBean
CmsADEManager. getCurrentElement(javax.servlet.ServletRequest req)
Reads the current element bean from the request.Methods in org.opencms.ade.configuration that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description java.util.List<CmsContainerElementBean>
CmsADEManager. getFavoriteList(CmsObject cms)
Returns the favorite list, or creates it if not available.java.util.List<CmsContainerElementBean>
CmsADEManager. getRecentList(CmsObject cms)
Returns the favorite list, or creates it if not available.Methods in org.opencms.ade.configuration with parameters of type CmsContainerElementBean Modifier and Type Method Description protected JSONObject
CmsADEManager. elementToJson(CmsContainerElementBean element, java.util.Set<java.lang.String> excludeSettings)
Converts the given element to JSON.static java.util.Set<java.lang.String>
CmsFormatterUtils. getAllFormatterKeys(CmsADEConfigData configData, CmsContainerElementBean element)
Gets the set of all formatter keys from the settings.static java.lang.String
CmsFormatterUtils. getFormatterKey(java.lang.String containerName, CmsContainerElementBean element)
Gets the formatter key for the given container name from an element's settings.Method parameters in org.opencms.ade.configuration with type arguments of type CmsContainerElementBean Modifier and Type Method Description void
CmsADEManager. saveFavoriteList(CmsObject cms, java.util.List<CmsContainerElementBean> favoriteList)
Saves the favorite list, user based.void
CmsADEManager. saveInheritedContainer(CmsObject cms, java.lang.String sitePath, java.lang.String name, boolean newOrder, java.util.List<CmsContainerElementBean> elements)
Saves the inheritance container information.void
CmsADEManager. saveInheritedContainer(CmsObject cms, CmsResource pageResource, java.lang.String name, boolean newOrder, java.util.List<CmsContainerElementBean> elements)
Saves the inheritance container information.void
CmsADEManager. saveRecentList(CmsObject cms, java.util.List<CmsContainerElementBean> recentList)
Saves the favorite list, user based. -
Uses of CmsContainerElementBean in org.opencms.ade.containerpage
Methods in org.opencms.ade.containerpage that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsContainerpageService. getCachedElement(java.lang.String clientId, java.lang.String pageRootPath)
Reads the cached element-bean for the given client-side-id from cache.Methods in org.opencms.ade.containerpage with parameters of type CmsContainerElementBean Modifier and Type Method Description CmsContainerElementData
CmsElementUtil. getElementData(CmsResource page, CmsContainerElementBean element, java.util.Collection<CmsContainer> containers)
Returns the data for an element.CmsElementSettingsConfig
CmsElementUtil. getElementSettingsConfig(CmsResource page, CmsContainerElementBean element, java.lang.String containerId, java.util.Collection<CmsContainer> containers)
Returns the formatter and settings config data for an element.static I_CmsFormatterBean
CmsElementUtil. getFormatterForContainer(CmsObject cms, CmsContainerElementBean element, CmsContainer container, CmsADEConfigData config, CmsADESessionCache cache)
Returns the formatter bean for the given element and container.static java.lang.String
CmsContainerpageService. getSerializedElementInfo(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsContainerElementBean elementBean, CmsContainerPageBean page)
Returns the serialized element data.CmsContainerElement
CmsElementUtil. setElementInfo(CmsContainerElementBean elementBean, CmsContainerElement result)
Sets the data to the given container element.Method parameters in org.opencms.ade.containerpage with type arguments of type CmsContainerElementBean Modifier and Type Method Description static CmsContainerBean
CmsElementUtil. clientToServerContainer(CmsContainer container, java.util.List<CmsContainerElementBean> elements)
CmsContainerPageBean
CmsModelGroupHelper. prepareforModelGroupContent(java.util.Map<java.lang.String,CmsContainerElementBean> elements, java.util.List<java.lang.String> foundGroups, CmsContainerPageBean page, boolean alwaysCopy, java.util.Locale locale)
Adds the model group elements to the page. -
Uses of CmsContainerElementBean in org.opencms.ade.containerpage.inherited
Methods in org.opencms.ade.containerpage.inherited that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description java.util.List<CmsContainerElementBean>
CmsInheritedContainerState. getElements(boolean includeHidden)
Gets a list of container element beans which represent the state of the inherited container.java.util.Map<java.lang.String,CmsContainerElementBean>
CmsContainerConfiguration. getNewElements()
Gets the map of new elements.java.util.LinkedHashMap<java.lang.String,CmsContainerElementBean>
CmsContainerConfiguration. getNewElementsInOrder()
Gets the new elements in the order in which they appear in the 'ordering' list.Method parameters in org.opencms.ade.containerpage.inherited with type arguments of type CmsContainerElementBean Modifier and Type Method Description protected CmsContainerConfiguration
CmsContainerConfigurationWriter. createConfigurationBean(boolean newOrdering, java.util.List<CmsContainerElementBean> elements, java.util.Set<java.lang.String> parentKeys)
Converts a list of container elements into a bean which should be saved to the inherited container configuration.void
CmsContainerConfigurationWriter. save(CmsObject cms, java.lang.String name, boolean newOrdering, CmsResource pageResource, java.util.List<CmsContainerElementBean> elements)
Saves a list of container element beans to a file in the VFS. -
Uses of CmsContainerElementBean in org.opencms.i18n.tools
Methods in org.opencms.i18n.tools that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsContainerPageCopier. replaceContainerElement(CmsResource targetPage, CmsContainerElementBean originalElement)
Produces the replacement for a container page element to use in a copy of an existing container page.Methods in org.opencms.i18n.tools with parameters of type CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsContainerPageCopier. replaceContainerElement(CmsResource targetPage, CmsContainerElementBean originalElement)
Produces the replacement for a container page element to use in a copy of an existing container page. -
Uses of CmsContainerElementBean in org.opencms.jsp
Methods in org.opencms.jsp that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description static java.util.List<CmsContainerElementBean>
CmsJspTagContainer. getGroupContainerElements(CmsObject cms, CmsContainerElementBean element, javax.servlet.ServletRequest req, java.lang.String containerType)
Returns the element group elements.static java.util.List<CmsContainerElementBean>
CmsJspTagContainer. getInheritedContainerElements(CmsObject cms, CmsContainerElementBean element)
Reads elements from an inherited container.Methods in org.opencms.jsp with parameters of type CmsContainerElementBean Modifier and Type Method Description static void
CmsJspTagDisplay. displayAction(CmsContainerElementBean element, I_CmsFormatterBean formatter, boolean cacheable, boolean editable, boolean canCreate, boolean canDelete, java.lang.String creationSiteMap, java.lang.String postCreateHandler, java.lang.String uploadFolder, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
Includes the formatter rendering the given element.static void
CmsJspTagDisplay. displayAction(CmsContainerElementBean element, I_CmsFormatterBean formatter, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
Includes the formatter rendering the given element.static I_CmsFormatterBean
CmsJspTagContainer. ensureValidFormatterSettings(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth)
Ensures the appropriate formatter configuration ID is set in the element settings.static I_CmsFormatterBean
CmsJspTagContainer. getFormatterConfigurationForElement(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth)
Returns the formatter configuration for the given element.static java.util.List<CmsContainerElementBean>
CmsJspTagContainer. getGroupContainerElements(CmsObject cms, CmsContainerElementBean element, javax.servlet.ServletRequest req, java.lang.String containerType)
Returns the element group elements.static java.util.List<CmsContainerElementBean>
CmsJspTagContainer. getInheritedContainerElements(CmsObject cms, CmsContainerElementBean element)
Reads elements from an inherited container.protected void
CmsJspTagContainer. printElementWrapperTagStart(CmsObject cms, CmsContainerElementBean elementBean, CmsContainerPageBean page, boolean isGroupContainer)
Prints the opening element wrapper tag for the container page editor if we are in Offline mode. -
Uses of CmsContainerElementBean in org.opencms.jsp.util
Subclasses of CmsContainerElementBean in org.opencms.jsp.util Modifier and Type Class Description class
CmsJspStandardContextBean.CmsContainerElementWrapper
Container element wrapper to add some API methods.Methods in org.opencms.jsp.util that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsJspStandardContextBean.CmsContainerElementWrapper. clone()
CmsContainerElementBean
CmsJspStandardContextBean. getParentElement()
Returns the parent element to the current element if available.protected CmsContainerElementBean
CmsJspStandardContextBean. getParentElement(CmsContainerElementBean element)
Returns the parent element if available.Methods in org.opencms.jsp.util that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description java.util.Map<java.lang.String,java.util.List<CmsContainerElementBean>>
CmsJspContentAttachmentsBean. getByContainer()
Gets lazy map that returns lists of element beans for the container whose name is given as a key.java.util.Map<java.lang.String,java.util.List<CmsContainerElementBean>>
CmsJspContentAttachmentsBean. getByType()
Gets lazy map that maps type names to lists of container elements of that type.Methods in org.opencms.jsp.util with parameters of type CmsContainerElementBean Modifier and Type Method Description protected I_CmsFormatterBean
CmsJspStandardContextBean. getElementFormatter(CmsContainerElementBean element)
Returns the formatter configuration to the given element.protected CmsContainerElementBean
CmsJspStandardContextBean. getParentElement(CmsContainerElementBean element)
Returns the parent element if available.void
CmsJspStandardContextBean. setElement(CmsContainerElementBean element)
Sets the currently rendered element.Constructors in org.opencms.jsp.util with parameters of type CmsContainerElementBean Constructor Description CmsContainerElementWrapper(CmsContainerElementBean element)
Constructor. -
Uses of CmsContainerElementBean in org.opencms.workplace.editors.directedit
Methods in org.opencms.workplace.editors.directedit that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsDirectEditParams. getContainerElement()
Gets the container element (used for display formatters).Methods in org.opencms.workplace.editors.directedit with parameters of type CmsContainerElementBean Modifier and Type Method Description CmsDialogOptions
CmsDateSeriesEditHandler. getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
CmsDialogOptions
I_CmsEditHandler. getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Returns a map of delete options.CmsDialogOptions
CmsDateSeriesEditHandler. getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement)
CmsDialogOptions
I_CmsEditHandler. getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement)
Returns a map of edit options.CmsDialogOptions
CmsDateSeriesEditHandler. getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam)
CmsDialogOptions
I_CmsEditHandler. getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam)
Gets the options for the 'New' (plus) operation in the page editor.void
CmsDateSeriesEditHandler. handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
void
I_CmsEditHandler. handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Executes the actual delete.java.lang.String
CmsDateSeriesEditHandler. handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice)
java.lang.String
I_CmsEditHandler. handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice)
Creates a new resource to edit.CmsUUID
CmsDateSeriesEditHandler. prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
CmsUUID
I_CmsEditHandler. prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
Prepares the resource to be edited.void
CmsDirectEditParams. setContainerElement(CmsContainerElementBean element)
Sets the container element bean. -
Uses of CmsContainerElementBean in org.opencms.xml.containerpage
Methods in org.opencms.xml.containerpage that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsContainerElementBean. clone()
static CmsContainerElementBean
CmsContainerElementBean. cloneWithFormatter(CmsContainerElementBean source, CmsUUID formatterId)
Clones the given element bean with a different formatter.static CmsContainerElementBean
CmsContainerElementBean. cloneWithSettings(CmsContainerElementBean source, java.util.Map<java.lang.String,java.lang.String> settings)
Clones the given element bean with a different set of settings.static CmsContainerElementBean
CmsContainerElementBean. createElementForResourceType(CmsObject cms, I_CmsResourceType resourceType, java.lang.String targetFolder, java.util.Map<java.lang.String,java.lang.String> individualSettings, boolean isCopyModels, java.util.Locale locale)
Creates an element bean for the given resource type.CmsContainerElementBean
CmsADESessionCache. getCacheContainerElement(java.lang.String key)
Returns the cached container element under the given key.Methods in org.opencms.xml.containerpage that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description java.util.List<CmsContainerElementBean>
CmsContainerBean. getElements()
Returns the elements in this container.java.util.List<CmsContainerElementBean>
CmsContainerPageBean. getElements()
Returns the elements of all containers in this page.java.util.List<CmsContainerElementBean>
CmsGroupContainerBean. getElements()
Returns the elements.protected static java.util.List<CmsContainerElementBean>
CmsXmlGroupContainerHandler. loadGroupContainerElements(CmsObject cms, CmsResource resource)
Helper method to load and prepare the elements of a group container.static java.util.List<CmsContainerElementBean>
CmsXmlInheritGroupContainerHandler. loadInheritContainerElements(CmsObject cms, CmsResource resource)
Returns the elements of the given inheritance group for the request context URI.Methods in org.opencms.xml.containerpage with parameters of type CmsContainerElementBean Modifier and Type Method Description static CmsContainerElementBean
CmsContainerElementBean. cloneWithFormatter(CmsContainerElementBean source, CmsUUID formatterId)
Clones the given element bean with a different formatter.static CmsContainerElementBean
CmsContainerElementBean. cloneWithSettings(CmsContainerElementBean source, java.util.Map<java.lang.String,java.lang.String> settings)
Clones the given element bean with a different set of settings.void
CmsADESessionCache. setCacheContainerElement(java.lang.String key, CmsContainerElementBean containerElement)
Caches the given container element under the given key.Method parameters in org.opencms.xml.containerpage with type arguments of type CmsContainerElementBean Modifier and Type Method Description CmsContainerBean
CmsContainerBean. copyWithNewElements(java.util.List<CmsContainerElementBean> elements)
Creates a copy of this bean, but with the element list replaced with something else.Constructor parameters in org.opencms.xml.containerpage with type arguments of type CmsContainerElementBean Constructor Description CmsContainerBean(java.lang.String name, java.lang.String type, java.lang.String parentInstanceId, boolean isRootContainer, int maxElements, java.util.List<CmsContainerElementBean> elements)
Creates a new container bean.CmsContainerBean(java.lang.String name, java.lang.String type, java.lang.String parentInstanceId, boolean isRootContainer, java.util.List<CmsContainerElementBean> elements)
Creates a new container bean with an unlimited number of elements.CmsGroupContainerBean(java.lang.String title, java.lang.String description, java.util.List<CmsContainerElementBean> elements, java.util.Set<java.lang.String> types)
Creates a new group container bean. -
Uses of CmsContainerElementBean in org.opencms.xml.containerpage.mutable
Methods in org.opencms.xml.containerpage.mutable that return types with arguments of type CmsContainerElementBean Modifier and Type Method Description java.util.List<CmsContainerElementBean>
CmsMutableContainer. elements()
Gets the mutable list of container elements.Methods in org.opencms.xml.containerpage.mutable with parameters of type CmsContainerElementBean Modifier and Type Method Description boolean
CmsContainerPageWrapper. addElementToContainer(java.lang.String containerName, CmsContainerElementBean element)
Adds an element to the given container (the first container with the given container suffix is used).Constructor parameters in org.opencms.xml.containerpage.mutable with type arguments of type CmsContainerElementBean Constructor Description CmsMutableContainer(java.lang.String name, java.lang.String type, java.lang.String parentInstanceId, boolean isRootContainer, java.util.List<CmsContainerElementBean> elements)
Creates a new instance. -
Uses of CmsContainerElementBean in org.opencms.xml.templatemapper
Methods in org.opencms.xml.templatemapper that return CmsContainerElementBean Modifier and Type Method Description protected CmsContainerElementBean
CmsTemplateMapper. transformContainerElement(CmsObject cms, CmsTemplateMapperConfiguration config, CmsContainerElementBean element)
Helper method to transform a single container element.CmsContainerElementBean
CmsTemplateMapper. transformDetailElement(CmsObject cms, CmsContainerElementBean input, java.lang.String rootPath)
Transforms a container element bean used for detail elements.Methods in org.opencms.xml.templatemapper with parameters of type CmsContainerElementBean Modifier and Type Method Description protected CmsContainerElementBean
CmsTemplateMapper. transformContainerElement(CmsObject cms, CmsTemplateMapperConfiguration config, CmsContainerElementBean element)
Helper method to transform a single container element.CmsContainerElementBean
CmsTemplateMapper. transformDetailElement(CmsObject cms, CmsContainerElementBean input, java.lang.String rootPath)
Transforms a container element bean used for detail elements. -
Uses of CmsContainerElementBean in org.opencms.xml.xml2json.renderer
Methods in org.opencms.xml.xml2json.renderer that return CmsContainerElementBean Modifier and Type Method Description CmsContainerElementBean
CmsJsonRendererContainerPage.ElementNode. getElement()
Gets the container element bean which this node is wrapping.Constructors in org.opencms.xml.xml2json.renderer with parameters of type CmsContainerElementBean Constructor Description ElementNode(CmsContainerElementBean elementBean, CmsJsonRendererContainerPage.ContainerNode parentContainerNode)
Creates a new element node.
-