Interface PagePart

    • Method Detail

      • isValid

        boolean isValid​(Page page)
        Check if the pagepart should be displayed.
        Parameters:
        page - the page the pagepart is displayed on.
        Returns:
        true if the pagepart may be displayed according to the (qs) preconditions
      • isSearchable

        boolean isSearchable()
        Return true if the page part should be indexed by the searchengine.
        Returns:
        true if the page part should be indexed by the searchengine.
      • showPageSectionsWithoutLabel

        boolean showPageSectionsWithoutLabel()
        Check if a page section which is opened in "in context" mode should be displayed. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        true if the page sections without any label should be displayed
      • getPreSpacing

        int getPreSpacing()
        Return amount of pixels of space that should be displayed.
        Returns:
        amount of pixels of space that should be displayed before the pagepart.
        See Also:
        getPreSpacingOrientation()
      • getPreSpacingOrientation

        String getPreSpacingOrientation()
        Return "horizontal" or "vertical".
        Returns:
        "horizontal" or "vertical".
        See Also:
        getPreSpacing()
      • getBlockLabels

        BlockLabel[] getBlockLabels()
        Return page section labels of this page part. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        page section labels of this page part.
      • getIdentifier

        String getIdentifier()
        Return name of the page part used internally.
        Returns:
        name of the page part used internally.
      • getCacheTimeout

        Integer getCacheTimeout()
        Return cache timeout for this PagePart.
        Returns:
        cache timeout for this PagePart.
      • getSoftCacheTimeout

        Integer getSoftCacheTimeout()
        Return soft cache timeout for this PagePart.
        Returns:
        soft cache timeout for this PagePart.
      • getBlocks

        Page[] getBlocks()
        Return page sections. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        page sections
      • getWebsite

        Website getWebsite()
        Return website the pagepart is on.
        Returns:
        website the pagepart is on.
      • getBannerServiceUrl

        @Deprecated
        String getBannerServiceUrl()
        Deprecated.
        This method is no longer in use. As of WM 10.0.0 it will return code
        Return url for the banner service, which contains the bannermodel id. The bannermodel is connected to the page and the pagepart.
        Returns:
        url for the banner service.