Interface PageCollectionElement

    • Method Detail

      • getAge

        int getAge()
        Return the value of the age filter in days.
        Returns:
        the value of the age filter in days or -1 if it isn't configured
      • setAge

        void setAge​(int age)
        Sets the value of the age filter in days.
        Parameters:
        age - the value to set of the age filter in days or -1 if it isn't configured
      • getDateFrom

        Date getDateFrom()
        Return the from date for the date filter.
        Returns:
        the from date for the date filter
      • setDateFrom

        void setDateFrom​(Date date)
        Sets the from date in the date filter.
        Parameters:
        date - the from date in the date filter to set
      • getDateTo

        Date getDateTo()
        Return the to date for the date filter.
        Returns:
        the to date for the date filter
      • setDateTo

        void setDateTo​(Date date)
        Sets the to date in the date filter.
        Parameters:
        date - the to date in the date filter to set
      • isSortByAgeAscending

        boolean isSortByAgeAscending()
        Indicates whether to sort ascending by age.
        Returns:
        true if the element sorts ascending by age, false if it sorts descending
      • setSortByAgeAscending

        void setSortByAgeAscending​(boolean sortByAgeAscending)
        Sets whether to sort ascending by age.
        Parameters:
        sortByAgeAscending - true if the element should sort ascending by age, false if it sorts descending
      • isSortByDateAscending

        boolean isSortByDateAscending()
        Indicates whether to sort ascending by date.
        Returns:
        true if the element sorts ascending by date, false if it sorts descending
      • setSortByDateAscending

        void setSortByDateAscending​(boolean sortByDateAscending)
        Sets whether to sort ascending by date.
        Parameters:
        sortByDateAscending - true if the element should sort ascending by date, false if it should sort descending
      • isSortByLabelAscending

        boolean isSortByLabelAscending()
        Indicates whether to sort ascending by label.
        Returns:
        true if the element sort ascending by label, false if it sorts descending
      • setPageLabels

        void setPageLabels​(PageLabel[] pageLabels)
        Sets the labels by which to filter the pages that are shown
        Parameters:
        pageLabels - the array of page labels to set
      • getMaxNumberOfResults

        int getMaxNumberOfResults()
        Returns the maximum number of results to be shown.
        Returns:
        the maximum number of results to be shown or -1 if it isn't configured.
      • setMaxNumberOfResults

        void setMaxNumberOfResults​(int max)
        Sets the maximum number of results to be shown.
        Parameters:
        max - the maximum number of results to be shown or -1 if it isn't configured.
      • getResultFrom

        int getResultFrom()
        Returns the index of the first result to be shown
        Returns:
        the index of the first result to be shown or -1 if it isn't configured.
      • setResultFrom

        void setResultFrom​(int from)
        Sets the index of the first result to be shown
        Parameters:
        from - the index of the first result to be shown or -1 if it isn't configured.
      • getResultTo

        int getResultTo()
        Returns the index of the last result to be shown
        Returns:
        the index of the last result to be shown or -1 if it isn't configured.
      • setResultTo

        void setResultTo​(int to)
        Sets the index of the last result to be shown
        Parameters:
        to - the index of the last result to be shown or -1 if it isn't configured.
      • getTopPage

        Page getTopPage()
        Returns the top page; the element displays a collection of its' child pages.
        Returns:
        the top page or null if it isn't configured
      • setTopPage

        void setTopPage​(Page page)
        Sets the top page; the element displays a collection of its' child pages.
        Parameters:
        page - the top page to set or null if it isn't configured
      • isFilterByAge

        boolean isFilterByAge()
        Indicates whether to filter by age.
        Returns:
        true if filtering by age is used, false otherwise
      • setFilterByAge

        void setFilterByAge​(boolean filterByAge)
        Sets whether to filter by age.
        Parameters:
        filterByAge - true if filtering by age should be used, false otherwise
      • isFilterByDate

        boolean isFilterByDate()
        Indicates whether to filter by date.
        Returns:
        true if filtering by date is used, false otherwise
      • setFilterByDate

        void setFilterByDate​(boolean filterByDate)
        Sets whether to filter by date.
        Parameters:
        filterByDate - true if filtering by date should be used, false otherwise
      • isFilterByLabel

        boolean isFilterByLabel()
        Indicates whether to filter by label.
        Returns:
        true if filtering by label is used, false otherwise
      • setFilterByLabel

        void setFilterByLabel​(boolean filterByLabel)
        Sets whether to filter by label.
        Parameters:
        filterByLabel - true if filtering by label should be used, false otherwise
      • isUseMaxNumberOfResultsFilter

        boolean isUseMaxNumberOfResultsFilter()
        Indicates whether to limit the number of results to the configured maximum
        Returns:
        true if the number of results should be limited, false otherwise
      • setUseMaxNumberOfResultsFilter

        void setUseMaxNumberOfResultsFilter​(boolean useMax)
        Sets whether to limit the number of results to the configured maximum
        Parameters:
        useMax - true if the number of results should be limited, false otherwise