Class CmsContentInfoBean


  • public class CmsContentInfoBean
    extends java.lang.Object
    A container to store information about a collector's result.

    Since:
    6.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PAGE_CONTEXT_ATTRIBUTE_NAME
      The name under which the collector info is saved in the page context.
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsContentInfoBean()
      Creates a new content info bean.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      Gets an id which is common to all items in a collector list.
      java.lang.String getLocale()
      Returns the locale used by the content loader.
      java.lang.String getNewContentLink()
      Gets the javascript: link for creating and editing a new content.
      java.lang.String getNewContentScript()
      Gets the Javascript for creating and editing a new content.
      int getPageCount()
      Returns the number of pages of browse through the result list.
      int getPageIndex()
      Returns the index of the current page that gets displayed.
      int getPageNavEndIndex()
      Returns the page index of the first element in the Google-like page navigation.
      int getPageNavLength()
      Returns the page index of the last element in the Google-like page navigation.
      int getPageNavStartIndex()
      Returns the page index of the first element in the Google-like page navigation.
      int getPageSize()
      Returns the size of a page.
      int getResultIndex()
      Returns the index of the current resource that gets iterated in the result list.
      int getResultSize()
      Returns the total size of the collector's result list.
      boolean isEmptyResult()
      Returns true if there is no resource in the result list.
      boolean isFirstOnPage()
      Returns true if the current resource is the first resource on the current page.
      boolean isFirstResult()
      Returns true if the current resource is the first resource in the result list.
      boolean isLastOnPage()
      Returns true if the current resource is the last resource on the current page.
      boolean isLastResult()
      Returns true if the current resource is the last resource in the result list.
      void setLocale​(java.lang.String locale)
      Sets the current locale used by the content loader.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getId

        public java.lang.String getId()
        Gets an id which is common to all items in a collector list.

        Returns:
        the id identifying the collector list
      • getLocale

        public java.lang.String getLocale()
        Returns the locale used by the content loader.

        Returns:
        the locale used by the content loader
      • getNewContentLink

        public java.lang.String getNewContentLink()
        Gets the javascript: link for creating and editing a new content.

        Returns:
        the javascript: link for creating and editing a new content
      • getNewContentScript

        public java.lang.String getNewContentScript()
        Gets the Javascript for creating and editing a new content.

        Returns:
        the Javascript for creating and editing a new content
      • getPageCount

        public int getPageCount()
        Returns the number of pages of browse through the result list.

        Returns:
        the number of pages of browse through the result list
      • getPageIndex

        public int getPageIndex()
        Returns the index of the current page that gets displayed.

        Returns:
        the index of the current page that gets displayed
      • getPageNavEndIndex

        public int getPageNavEndIndex()
        Returns the page index of the first element in the Google-like page navigation.

        Returns:
        the page index of the first element in the Google-like page navigation
      • getPageNavLength

        public int getPageNavLength()
        Returns the page index of the last element in the Google-like page navigation.

        Returns:
        page index of the last element in the Google-like page navigation
      • getPageNavStartIndex

        public int getPageNavStartIndex()
        Returns the page index of the first element in the Google-like page navigation.

        Returns:
        the page index of the first element in the Google-like page navigation
      • getPageSize

        public int getPageSize()
        Returns the size of a page.

        Returns:
        the size of a page
      • getResultIndex

        public int getResultIndex()
        Returns the index of the current resource that gets iterated in the result list.

        Returns:
        the index of the current resource that gets iterated in the result list
      • getResultSize

        public int getResultSize()
        Returns the total size of the collector's result list.

        Returns:
        the total size of the collector's result list
      • isEmptyResult

        public boolean isEmptyResult()
        Returns true if there is no resource in the result list.

        Returns:
        true if there is no resource in the result list
      • isFirstOnPage

        public boolean isFirstOnPage()
        Returns true if the current resource is the first resource on the current page.

        Returns:
        true if the current resource is the first resource on the current page
      • isFirstResult

        public boolean isFirstResult()
        Returns true if the current resource is the first resource in the result list.

        Returns:
        true if the current resource is the first resource in the result list
      • isLastOnPage

        public boolean isLastOnPage()
        Returns true if the current resource is the last resource on the current page.

        Returns:
        true if the current resource is the last resource on the current page
      • isLastResult

        public boolean isLastResult()
        Returns true if the current resource is the last resource in the result list.

        Returns:
        true if the current resource is the last resource in the result list
      • setLocale

        public void setLocale​(java.lang.String locale)
        Sets the current locale used by the content loader.

        Parameters:
        locale - the locale to set