Package io.goobi.viewer.model.viewer

Enum Class PageType

java.lang.Object
java.lang.Enum<PageType>
io.goobi.viewer.model.viewer.PageType
All Implemented Interfaces:
Serializable, Comparable<PageType>, Constable
public enum PageType extends Enum<PageType>

PageType class.

  • Enum Constant Details

    • viewImage

      public static final PageType viewImage

    • viewToc

      public static final PageType viewToc

    • viewThumbs

      public static final PageType viewThumbs

    • viewMetadata

      public static final PageType viewMetadata

    • viewFulltext

      public static final PageType viewFulltext

    • viewFullscreen

      public static final PageType viewFullscreen

    • viewObject

      public static final PageType viewObject

    • viewCalendar

      public static final PageType viewCalendar

    • searchlist

      public static final PageType searchlist

    • searchCalendar

      public static final PageType searchCalendar

    • searchGeoMap

      public static final PageType searchGeoMap

    • term

      public static final PageType term

    • expandCollection

      public static final PageType expandCollection

    • firstWorkInCollection

      public static final PageType firstWorkInCollection

    • archives

      public static final PageType archives

    • archive

      public static final PageType archive

    • timematrix

      public static final PageType timematrix

    • user

      public static final PageType user

    • userSearches

      public static final PageType userSearches

    • userContentUpload

      public static final PageType userContentUpload

    • admin

      public static final PageType admin

    • adminDashboard

      public static final PageType adminDashboard

    • adminUsers

      public static final PageType adminUsers

    • adminUser

      public static final PageType adminUser

    • adminUserNew

      public static final PageType adminUserNew

    • adminUserEdit

      public static final PageType adminUserEdit

    • adminUserGroups

      public static final PageType adminUserGroups

    • adminUserGroupEdit

      public static final PageType adminUserGroupEdit

    • adminUserGroupNew

      public static final PageType adminUserGroupNew

    • adminIpRanges

      public static final PageType adminIpRanges

    • adminIpRange

      public static final PageType adminIpRange

    • adminIpRangeNew

      public static final PageType adminIpRangeNew

    • adminLicenseTypes

      public static final PageType adminLicenseTypes

    • adminLicenseType

      public static final PageType adminLicenseType

    • adminRights

      public static final PageType adminRights

    • adminRight

      public static final PageType adminRight

    • adminRightsNew

      public static final PageType adminRightsNew

    • adminUserComments

      public static final PageType adminUserComments

    • adminUserCommentGroups

      public static final PageType adminUserCommentGroups

    • adminUserCommentGroupAll

      public static final PageType adminUserCommentGroupAll

    • adminUserCommentGroupNew

      public static final PageType adminUserCommentGroupNew

    • adminUserCommentGroupEdit

      public static final PageType adminUserCommentGroupEdit

    • adminUserTerms

      public static final PageType adminUserTerms

    • adminCreateRecord

      public static final PageType adminCreateRecord

    • adminThemes

      public static final PageType adminThemes

    • adminClients

      public static final PageType adminClients

    • adminClientsEdit

      public static final PageType adminClientsEdit

    • adminConfigEditor

      public static final PageType adminConfigEditor

    • adminMessageQueue

      public static final PageType adminMessageQueue

    • adminDeveloper

      public static final PageType adminDeveloper

    • adminTranslations

      public static final PageType adminTranslations

    • adminTranslationsEdit

      public static final PageType adminTranslationsEdit

    • adminCms

      public static final PageType adminCms

    • adminCmsOverview

      public static final PageType adminCmsOverview

    • adminCmsSelectTemplate

      public static final PageType adminCmsSelectTemplate

    • adminCmsNewPage

      public static final PageType adminCmsNewPage

    • adminCmsEditPage

      public static final PageType adminCmsEditPage

    • adminCmsTemplatesNew

      public static final PageType adminCmsTemplatesNew

    • adminCmsTemplatesEdit

      public static final PageType adminCmsTemplatesEdit

    • adminCmsSidebarWidgets

      public static final PageType adminCmsSidebarWidgets

    • adminCmsWidgetsAdd

      public static final PageType adminCmsWidgetsAdd

    • adminCmsWidgetsEdit

      public static final PageType adminCmsWidgetsEdit

    • adminCmsCategories

      public static final PageType adminCmsCategories

    • adminCmsNewCategory

      public static final PageType adminCmsNewCategory

    • adminCmsEditCategory

      public static final PageType adminCmsEditCategory

    • adminCmsStaticPages

      public static final PageType adminCmsStaticPages

    • adminCmsMedia

      public static final PageType adminCmsMedia

    • adminCmsMenuItems

      public static final PageType adminCmsMenuItems

    • adminCmsCollections

      public static final PageType adminCmsCollections

    • adminCmsEditCollection

      public static final PageType adminCmsEditCollection

    • adminCmsGeoMaps

      public static final PageType adminCmsGeoMaps

    • adminCmsGeoMapEdit

      public static final PageType adminCmsGeoMapEdit

    • adminCmsGeoMapNew

      public static final PageType adminCmsGeoMapNew

    • adminCmsRecordNotes

      public static final PageType adminCmsRecordNotes

    • adminCmsRecordNotesNew

      public static final PageType adminCmsRecordNotesNew

    • adminCmsRecordNotesEdit

      public static final PageType adminCmsRecordNotesEdit

    • adminCmsHighlights

      public static final PageType adminCmsHighlights

    • adminCmsHighlightsNew

      public static final PageType adminCmsHighlightsNew

    • adminCmsHighlightsEdit

      public static final PageType adminCmsHighlightsEdit

    • adminCmsSliders

      public static final PageType adminCmsSliders

    • adminCmsSlidersNew

      public static final PageType adminCmsSlidersNew

    • adminCmsSlidersEdit

      public static final PageType adminCmsSlidersEdit

    • adminCookieBanner

      public static final PageType adminCookieBanner

    • adminDisclaimer

      public static final PageType adminDisclaimer

    • cmsPageOfWork

      public static final PageType cmsPageOfWork

    • cmsPage

      public static final PageType cmsPage

    • adminCrowdsourcingAnnotations

      public static final PageType adminCrowdsourcingAnnotations

    • adminCrowdsourcingCampaigns

      public static final PageType adminCrowdsourcingCampaigns

    • adminCrowdsourcingCampaignsNew

      public static final PageType adminCrowdsourcingCampaignsNew

    • adminCrowdsourcingCampaignsEdit

      public static final PageType adminCrowdsourcingCampaignsEdit

    • adminUserActivity

      public static final PageType adminUserActivity

    • annotations

      public static final PageType annotations

    • editContent

      public static final PageType editContent

    • editOcr

      public static final PageType editOcr

    • editHistory

      public static final PageType editHistory

    • index

      public static final PageType index

    • advancedSearch

      public static final PageType advancedSearch

    • browse

      public static final PageType browse

    • privacy

      public static final PageType privacy

    • imprint

      public static final PageType imprint

    • feedback

      public static final PageType feedback

    • crowsourcingCampaigns

      public static final PageType crowsourcingCampaigns

    • bookmarks

      public static final PageType bookmarks

    • crowsourcingAnnotation

      public static final PageType crowsourcingAnnotation

    • crowsourcingReview

      public static final PageType crowsourcingReview

    • other

      public static final PageType other

  • Method Details

    • values

      public static PageType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PageType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getHandling

      public PageType.PageTypeHandling getHandling()

      Getter for the field handling.

      Returns:
      a PageType.PageTypeHandling object.

    • getParent

      public PageType getParent()

    • isHandledWithCms

      public boolean isHandledWithCms()

      isHandledWithCms.

      Returns:
      a boolean.

    • isCmsPage

      public boolean isCmsPage()

      isCmsPage.

      Returns:
      a boolean.

    • isDocumentPage

      public boolean isDocumentPage()

      isDocumentPage.

      Returns:
      a boolean.

    • getTypesHandledByCms

      public static List<PageType> getTypesHandledByCms()

      getTypesHandledByCms.

      Returns:
      a List object.

    • getByName

      public static PageType getByName(String name)

      getByName.

      Parameters:
      name - a String object.
      Returns:
      a PageType object.

    • getRawName

      public String getRawName()

      getRawName.

      Returns:
      a String object.

    • getName

      public String getName()

      Getter for the field name.

      Returns:
      Mapped alternative name, if available; raw name otherwise

    • getLabel

      public String getLabel()

    • getPageTypeForDocStructType

      public static PageType getPageTypeForDocStructType(String docStructType)

      getPageTypeForDocStructType.

      Parameters:
      docStructType - a String object.
      Returns:
      a PageType object.

    • determinePageType

      public static PageType determinePageType(String docStructType, String mimeType, Boolean anchorOrGroup, Boolean hasImages, boolean pageResolverUrl)

      determinePageType.

      Parameters:
      docStructType - a String object.
      mimeType - a String object.
      anchorOrGroup - a boolean.
      hasImages - a boolean.
      pageResolverUrl - If this page type is for a page resolver url, ignore certain preferences
      Returns:
      a PageType object.

    • matches

      public boolean matches(String pagePath)

      matches.

      Parameters:
      pagePath - a String object.
      Returns:
      true if the given path equals either the intrinsic or configured name of this pageType Leading and trailing slashes are ignored. PageType other is never matched

    • matches

      public boolean matches(URI pagePath)

      matches.

      Parameters:
      pagePath - a URI object.
      Returns:
      true if the given path starts with either the intrinsic or configured name of this pageType Leading and trailing slashes are ignored. PageType other is never matched

    • isAdminBackendPage

      public boolean isAdminBackendPage()