PageParams (FirstSpirit Access-API)

java.lang.Object

de.espirit.firstspirit.access.store.PageParams

Direct Known Subclasses:: ContentMultiPageParams.ContentPageParams

public class PageParams extends Object

Since:: 4.0

Field Summary

Fields

Modifier and Type

Field

Description

static final PageParams

SINGLE_PAGE_PARAMS

Static instance which may be used as page params for 'single pages'.
Constructor Summary

Constructors

Constructor

Description

PageParams(int index, boolean last)
Method Summary

Modifier and Type

Method

Description

int

getIndex()

long

getLastChangeDate()

Calculate the last change date.

long

getLastChangeDate(long after)

Calculate the last change date after the provided timestamp.

@NotNull String

getPageSuffix()

@NotNull String

getPreviewSuffix()

int

getSize()

A single page may render multiple containers, e.g. datasets, on one page - this method delivers the number of instances.

final boolean

isFirst()

boolean

isLast()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- SINGLE_PAGE_PARAMS
  
  public static final PageParams SINGLE_PAGE_PARAMS
  
  Static instance which may be used as page params for 'single pages'.
  
  Since:
  
  5.0.3
Constructor Details
- PageParams
  
  public PageParams(int index, boolean last)
  
  Since:
  
  4.0
Method Details
- getSize
  
  public int getSize()
  
  A single page may render multiple containers, e.g. datasets, on one page - this method delivers the number of instances.
  
  Returns:
  
  number of inner elements
  
  Since:
  
  5.0.3
- isFirst
  
  public final boolean isFirst()
  
  Since:
  
  4.0
- isLast
  
  public boolean isLast()
  
  Since:
  
  4.0
- getIndex
  
  public int getIndex()
  
  Since:
  
  4.0
- getPageSuffix
  
  @NotNull public @NotNull String getPageSuffix()
  
  Since:
  
  4.0
- getPreviewSuffix
  
  @NotNull public @NotNull String getPreviewSuffix()
  
  Since:
  
  4.0
- getLastChangeDate
  
  public long getLastChangeDate()
  
  Calculate the last change date. The default implementation calls getLastChangeDate(0L).
  Since:
  
  4.0
  
  See Also:
  
  getLastChangeDate(long)
- getLastChangeDate
  
  public long getLastChangeDate(long after)
  
  Calculate the last change date after the provided timestamp. The default implementation returns the provided timestamp.
  Since:
  
  4.2.400
  
  See Also:
  
  getLastChangeDate()