public class List extends Object
Modifier and Type | Class and Description |
---|---|
class |
List.PageComparator<P extends Page>
Compares pages with each other by property.
|
Constructor and Description |
---|
List(SlingHttpServletRequest request)
Creates a
List instance based on the specified request. |
List(SlingHttpServletRequest request,
PageFilter pageFilter)
Creates a
List instance based on the specified request. |
Modifier and Type | Method and Description |
---|---|
String |
getNextPageLink()
Returns the link to the page with the next set of list items.
|
Iterator<Node> |
getNodes()
Returns the list as nodes.
|
int |
getPageMaximum()
Returns the maximum of list items to return per page.
|
Iterator<Page> |
getPages()
Returns the list items as pages, respecting both starting index and
maximum number of list items if specified.
|
int |
getPageStart()
Returns the starting index for list items on this page.
|
String |
getPreviousPageLink()
Returns the link to the page with the previous set of list items.
|
Iterator<Resource> |
getResources()
Deprecated.
use
getPages() instead |
String |
getType()
Returns the type of the list.
|
boolean |
isEmpty()
States whether the list is empty.
|
boolean |
isOrdered()
States whether the list is ordered.
|
boolean |
isPaginating()
States whether the list is paginating, i.e.
|
void |
setLimit(int l)
Sets the limit for list items.
|
void |
setOrderBy(String ob)
Sets the property to order the list by.
|
void |
setOrderComparator(Comparator<Page> obc)
Sets the comparator used to order the list with.
|
void |
setOrdered(boolean o)
Sets the list style (numbered or not).
|
void |
setPageIterator(Iterator<Page> iter)
Sets the page iterator to generate the list from.
|
void |
setPageMaximum(int pm)
Sets the maximum list items to return.
|
void |
setPageStart(int psi)
Sets the starting index to be respected when returning
list items.
|
void |
setQuery(String q)
Sets the query for the fulltext search.
|
void |
setQuery(String q,
String type)
Sets the query for the search with the specified type (xpath, sql).
|
void |
setSource(String src)
Sets the source for the list.
|
void |
setStartIn(String start)
Sets the the of the page to start searching on.
|
void |
setType(String t)
Sets the type of the list.
|
int |
size()
Returns the number of list items.
|
public static final Logger log
public static final String DEFAULT_QUERY
public static final String URL_EXTENSION
public static final String TYPE_PROPERTY_NAME
public static final String SOURCE_PROPERTY_NAME
public static final String SOURCE_CHILDREN
public static final String SOURCE_DESCENDANTS
public static final String SOURCE_STATIC
public static final String SOURCE_SEARCH
public static final String SOURCE_QUERYBUILDER
public static final String SOURCE_TAGS
public static final String TYPE_DEFAULT
public static final String PARENT_PAGE_PROPERTY_NAME
public static final String ANCESTOR_PAGE_PROPERTY_NAME
public static final String TAGS_SEARCH_ROOT_PROPERTY_NAME
public static final String TAGS_PROPERTY_NAME
public static final String TAGS_MATCH_PROPERTY_NAME
public static final String PAGES_PROPERTY_NAME
public static final String QUERY_PROPERTY_NAME
public static final String SEARCH_IN_PROPERTY_NAME
public static final String SEARCH_PROPERTY
public static final String LIMIT_PROPERTY_NAME
public static final String PAGE_MAX_PROPERTY_NAME
public static final String ORDER_BY_PROPERTY_NAME
public static final String ORDERED_PROPERTY_NAME
public static final String SAVEDQUERY_PROPERTY_NAME
public static final String PAGE_START_PARAM_NAME
public static final String PAGE_MAX_PARAM_NAME
public static final String ALLOW_DUPLICATES_PROPERTY_NAME
public List(SlingHttpServletRequest request)
List
instance based on the specified request.request
- The requestpublic List(SlingHttpServletRequest request, PageFilter pageFilter)
List
instance based on the specified request.request
- The requestpageFilter
- Page filterpublic Iterator<Resource> getResources()
getPages()
insteadpublic Iterator<Page> getPages()
public Iterator<Node> getNodes()
source
is
SOURCE_QUERYBUILDER
. Otherwise null
will be
returned.null
public boolean isOrdered()
true
if list is ordered, false
otherwisepublic boolean isEmpty()
true
if list is empty, false
otherwisepublic int size()
public boolean isPaginating()
true
if list is paginating, false
otherwisepublic int getPageStart()
public int getPageMaximum()
public String getNextPageLink()
public String getPreviousPageLink()
public void setSource(String src)
SOURCE_PROPERTY_NAME
.src
- The list sourcepublic void setQuery(String q)
q
- The querypublic void setQuery(String q, String type)
q
- The querytype
- The query type (optional)public void setStartIn(String start)
start
- The start page pathpublic String getType()
public void setType(String t)
TYPE_PROPERTY_NAME
.t
- The list typepublic void setOrderComparator(Comparator<Page> obc)
obc
- The comparator to order the list withpublic void setOrderBy(String ob)
ORDER_BY_PROPERTY_NAME
.ob
- The property to order the list bypublic void setOrdered(boolean o)
false
o
- true
if list should be rendered with numbered items,
false
otherwisepublic void setLimit(int l)
LIMIT_PROPERTY_NAME
.l
- The limitpublic void setPageMaximum(int pm)
PAGE_MAX_PROPERTY_NAME
.pm
- The maximum number of pages per pagepublic void setPageStart(int psi)
psi
- The starting index (defaults to 0).Copyright © 2010 - 2020 Adobe. All Rights Reserved