Package com.helger.photon.core.page

Interface IPage

All Superinterfaces:
com.helger.commons.text.display.IHasDisplayText, com.helger.commons.id.IHasID<String>
All Known Implementing Classes:
AbstractPage
public interface IPage extends com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText
The base interface for a single page of content.
Author:
Philip Helger

  • Method Summary

    Modifier and Type
    Method
    Description
    com.helger.commons.collection.attr.IAttributeContainerAny<String>
    attrs()
     
    String
    getDescription(Locale aContentLocale)
    Get the description of the page in the passed locale.

    Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

    getAsHasText, getDisplayText

    Methods inherited from interface com.helger.commons.id.IHasID

    getID

  • Method Details

    • getDescription

      @Nullable String getDescription(@Nonnull Locale aContentLocale)
      Get the description of the page in the passed locale.
      Parameters:
      aContentLocale - The content locale to get the description from. May not be null.
      Returns:
      null if no description text in the specified locale is available.

    • attrs

      @Nonnull @ReturnsMutableObject com.helger.commons.collection.attr.IAttributeContainerAny<String> attrs()
      Returns:
      Custom attributes.