Package org.opencms.ade.containerpage.shared

Class CmsContainerElementData

java.lang.Object
org.opencms.ade.containerpage.shared.CmsContainerElement
org.opencms.ade.containerpage.shared.CmsContainerElementData
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable, I_CmsHasIconClasses
public class CmsContainerElementData extends CmsContainerElement
Bean holding all element information including it's formatted contents.

Since:
8.0.0

  • Constructor Details

  • Method Details

    • getContents

      public Map<String,String> getContents()
      Returns the contents.

      Returns:
      the contents

    • getCssResources

      public Set<String> getCssResources(String containerName)
      Returns the required css resources.

      Parameters:
      containerName - the current container name
      Returns:
      the required css resources

    • getDescription

      public String getDescription()
      Returns the description.

      Returns:
      the description

    • getDndId

      public String getDndId()
      Dragging an element may require changing its settings, but this changes the id since it is computed from the settings. In the DND case this method returns the client id of the element with the changed settings.

      Returns:
      the drag and drop element id, or null if it isn't available or needed

    • getFormatedIndividualSettings

      public List<CmsAdditionalInfoBean> getFormatedIndividualSettings(String containerId)
      Returns the individual element settings formated with nice-names to be used as additional-info.

      Parameters:
      containerId - the container id
      Returns:
      the settings list

    • getFormatterConfig

      public CmsFormatterConfig getFormatterConfig(String containerName)
      Returns the current formatter configuration.

      Parameters:
      containerName - the current container name
      Returns:
      the current formatter configuration

    • getFormatters

      public Map<String,CmsFormatterConfigCollection> getFormatters()
      Gets the formatter collections for the different containers.
      Returns:
      the formatter collections for the containers

    • getInheritanceInfos

      public List<CmsInheritanceInfo> getInheritanceInfos()
      Returns the inheritance infos off all sub-items.

      Returns:
      the inheritance infos off all sub-items.

    • getInheritanceName

      public String getInheritanceName()
      Returns the inheritance name.

      Returns:
      the inheritance name

    • getLastModifiedByUser

      public String getLastModifiedByUser()
      Returns the last modifying user.

      Returns:
      the last modifying user

    • getLastModifiedDate

      public long getLastModifiedDate()
      Returns the last modification date.

      Returns:
      the last modification date

    • getListInfo

      public CmsListInfoBean getListInfo()
      Gets the list info bean.
      Returns:
      the list info bean

    • getLoadTime

      public long getLoadTime()
      Returns the load time.

      Returns:
      the load time

    • getNavText

      public String getNavText()
      Returns the navText.

      Returns:
      the navText

    • getSettingConfig

      public Map<String,CmsXmlContentProperty> getSettingConfig(String containerName)
      Gets the setting configuration for this container element.

      Parameters:
      containerName - the current container name
      Returns:
      the setting configuration map

    • getSettings

      public Map<String,String> getSettings()
      Returns the settings for this container element.

      Returns:
      a map of settings

    • getSubItems

      public List<String> getSubItems()
      Returns the sub-items.

      Returns:
      the sub-items

    • getTitle

      public String getTitle()
      Returns the supported container types.

      Overrides:
      getTitle in class CmsContainerElement
      Returns:
      the supported container types

    • getTypes

      public Set<String> getTypes()
      If this element represents an element group, this method will return the supported container type.

      Returns:
      the supported container types

    • hasAlternativeFormatters

      public boolean hasAlternativeFormatters(String containerName)
      Returns if there are alternative formatters available for the given container.

      Parameters:
      containerName - the container name
      Returns:
      true if there are alternative formatters available for the given container

    • hasSettings

      public boolean hasSettings(String containerId)
      Description copied from class: CmsContainerElement
      Returns if the element may have settings.

      Overrides:
      hasSettings in class CmsContainerElement
      Parameters:
      containerId - the container id
      Returns:
      true if the element may have settings
      See Also:

    • isAddDisabled

      public boolean isAddDisabled()
      Returns true if the element's type is disabled in the sitemap configuration.
      Returns:
      true if the type is disabled

    • isCopyDisabled

      public boolean isCopyDisabled()
      Returns true if copying of the element should be disabled.
      Returns:
      true if copying of the element should be disabled

    • isGroup

      public boolean isGroup()
      Returns if this element is used as a group.

      Returns:
      if this element is used as a group

    • isShowInContext

      public boolean isShowInContext(String currentContext)
      Returns true if the element should be shown in the current template context.

      Parameters:
      currentContext - the current template context
      Returns:
      true if the element should be shown

    • setAddDisabled

      public void setAddDisabled(boolean typeDisabled)
      Sets the 'is type disabled' flag (type is disabled in the sitemap configuration).
      Parameters:
      typeDisabled - the new value

    • setContents

      public void setContents(Map<String,String> contents)
      Sets the contents.

      Parameters:
      contents - the contents to set

    • setCopyDisabled

      public void setCopyDisabled(boolean copyDisabled)
      Sets the 'copy disabled' status.
      Parameters:
      copyDisabled - true if copying should be disabled

    • setDescription

      public void setDescription(String description)
      Sets the description.

      Parameters:
      description - the description to set

    • setDndId

      public void setDndId(String dndId)
      During dragging and dropping in the container page editor, it may be required to substitute a different element for the element being dragged. This sets the id of the element to substitute.

      Parameters:
      dndId - the drag and drop replacement element's client id

    • setFormatters

      public void setFormatters(Map<String,CmsFormatterConfigCollection> formatters)
      Sets the formatter configurations.

      Parameters:
      formatters - the formatter configurations to set

    • setGroup

      public void setGroup(boolean isGroup)
      Sets if this element is used as a group.

      Parameters:
      isGroup - if this element is used as a group

    • setInheritanceInfos

      public void setInheritanceInfos(List<CmsInheritanceInfo> inheritanceInfos)
      Sets the inheritance infos.

      Parameters:
      inheritanceInfos - the inheritance infos to set

    • setInheritanceName

      public void setInheritanceName(String inheritanceName)
      Sets the inheritance name.

      Parameters:
      inheritanceName - the inheritance name to set

    • setLastModifiedByUser

      public void setLastModifiedByUser(String lastModifiedByUser)
      Sets the modifying userdByUser.

      Parameters:
      lastModifiedByUser - the last modifying user to set

    • setLastModifiedDate

      public void setLastModifiedDate(long lastModifiedDate)
      Sets the last modification date.

      Parameters:
      lastModifiedDate - the last modification date to set

    • setListInfo

      public void setListInfo(CmsListInfoBean listInfo)
      Sets the list info bean.
      Parameters:
      listInfo - the list info bean

    • setLoadTime

      public void setLoadTime(long loadTime)
      Sets the load time.

      Parameters:
      loadTime - the load time to set

    • setNavText

      public void setNavText(String navText)
      Sets the navText.

      Parameters:
      navText - the navText to set

    • setSettings

      public void setSettings(Map<String,String> settings)
      Sets the settings for this container element.

      Parameters:
      settings - the new settings

    • setSubItems

      public void setSubItems(List<String> subItems)
      Sets the sub-items.

      Parameters:
      subItems - the sub-items to set

    • setTitle

      public void setTitle(String title)
      Sets the title.

      Overrides:
      setTitle in class CmsContainerElement
      Parameters:
      title - the title to set

    • setTypes

      public void setTypes(Set<String> types)
      Sets the supported container types.

      Parameters:
      types - the supported container types to set

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: