Interface SearchElement

    • Method Detail

      • getSearchFieldWidth

        int getSearchFieldWidth()
        Return search field width in characters.
        Returns:
        search field width in characters.
      • setSearchFieldWidth

        void setSearchFieldWidth​(int width)
        Sets the search field width in characters.
        Parameters:
        width - search field width in characters to set
      • getShowableLowerPages

        boolean getShowableLowerPages()
        If true, the searchelement must display an option to search in children pages.
        Returns:
        True if the searchelement must display an option to search in children pages.
      • setShowableLowerPages

        void setShowableLowerPages​(boolean showableLowerPages)
        Sets if the searchelement must display an option to search in children pages.
        Parameters:
        showableLowerPages - True if the searchelement should display an option to search in children pages
      • getShowableHigherPages

        boolean getShowableHigherPages()
        If true, the searchelement must display an option to search in children pages of the parent.
        Returns:
        True if the searchelement must display an option to search in children pages of the parent.
      • setShowableHigherPages

        void setShowableHigherPages​(boolean showableHigherPages)
        Sets if the searchelement should display an option to search in children pages of the parent.
        Parameters:
        showableHigherPages - True if the searchelement should display an option to search in children pages of the parent
      • getWebsites

        Website[] getWebsites()
        Return Websites this element searches.
        Returns:
        Websites this element searches.
      • isShowableResultsSitewide

        boolean isShowableResultsSitewide()
        If true, the search results of the searchelement must be displayed on a sitewide searchresults page.
        Returns:
        True if the search results of the searchelement must be displayed on a sitewide searchresults page.
      • setShowableResultsSitewide

        void setShowableResultsSitewide​(boolean showableResultsSitewide)
        Sets if the search results of the searchelement must be displayed on a sitewide searchresults page.
        Parameters:
        showableResultsSitewide - True if the search results of the searchelement should be displayed on a sitewide searchresults page.
      • getSearchResultsPage

        Page getSearchResultsPage()
        Return search result page.
        Returns:
        search result page.
      • setSearchResultsPage

        void setSearchResultsPage​(Page page)
        Sets the search result page.
        Parameters:
        page - the search result page to set
      • getExtraPrefix

        String getExtraPrefix()
        Return the extra prefix.
        Returns:
        the extra prefix.
      • getSearchUrl

        String getSearchUrl()
        Returns the relative location of the search filter
        Returns:
        the relative location of the search filter