Package com.day.cq.wcm.api
Class PageFilter
- java.lang.Object
-
- com.day.cq.wcm.api.PageFilter
-
-
Constructor Summary
Constructors Constructor Description PageFilter()
creates a default filter that excludes invalid and hidden pages.PageFilter(boolean includeInvalid, boolean includeHidden)
creates a filter.PageFilter(WCMMode mode)
creates a default filter that excludes hidden pages.PageFilter(ServletRequest req)
creates a default filter that excludes hidden pages.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
includes(Page page)
Checks if the given element is included in this filter.boolean
isIncludeHidden()
Checks if hidden pages are includedboolean
isIncludeInvalid()
Checks if invalid pages are included.
-
-
-
Constructor Detail
-
PageFilter
public PageFilter()
creates a default filter that excludes invalid and hidden pages.
-
PageFilter
public PageFilter(WCMMode mode)
creates a default filter that excludes hidden pages. invalid pages are only excluded if the WCM mode isWCMMode.DISABLED
.- Parameters:
mode
- the WCM mode
-
PageFilter
public PageFilter(ServletRequest req)
creates a default filter that excludes hidden pages. invalid pages are only excluded if the WCM mode isWCMMode.DISABLED
.- Parameters:
req
- request to read the WCM mode from
-
PageFilter
public PageFilter(boolean includeInvalid, boolean includeHidden)
creates a filter.- Parameters:
includeInvalid
- iftrue
invalid pages are included.includeHidden
- iftrue
hidden pages are included.
-
-
Method Detail
-
includes
public boolean includes(Page page)
Checks if the given element is included in this filter.
-
isIncludeInvalid
public boolean isIncludeInvalid()
Checks if invalid pages are included.- Returns:
true
if invalid pages are included.
-
isIncludeHidden
public boolean isIncludeHidden()
Checks if hidden pages are included- Returns:
true
if hidden pages are included.
-
-