Package com.stimulsoft.report.components

Class StiPagesCollection

java.lang.Object

java.util.AbstractCollection<StiPage>

java.util.AbstractList<StiPage>

java.util.ArrayList<StiPage>

com.stimulsoft.report.components.StiPagesCollection

All Implemented Interfaces:

IStiJsonReportObject, Serializable, Cloneable, Iterable<StiPage>, Collection<StiPage>, List<StiPage>, RandomAccess, SequencedCollection<StiPage>

public class StiPagesCollection
extends ArrayList<StiPage>
implements IStiJsonReportObject

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
boolean	cacheMode
boolean	canUseCacheMode
List<StiPage>	notCachedPages
StiSaveLoadPageEventHandler	pageCache

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
StiPagesCollection()
StiPagesCollection(StiReport report)

Method Summary

Modifier and Type	Method	Description
boolean	add(StiPage page)
void	addAll(StiPagesCollection pagesStore)
boolean	addPage(StiPage page)
void	addPageToQuickCache(StiPage page, boolean savePage)
void	AddRange(StiPagesCollection pagesStore)
boolean	addV2Internal(StiPage page)
static void	copyEventsOfPagesCollection(StiPagesCollection sourcePages, StiPagesCollection destinationPages)
void	fillPageInChildren()
void	fillReport(StiReport report)
void	flush()	Deprecated.
void	flush(boolean final_)	Deprecated.
StiPage	get(int index)
StiPage	get(String pageName)	Return StiPage by page name
boolean	getCacheMode()
StiComponent	GetComponentByName(String componentName)
void	GetPage(StiPage page)
StiPage	getPageWithoutCache(int pageIndex)
StiReport	getReport()
boolean	isNotSavedPage(StiPage page)
void	LoadFromJsonObject(JSONObject jObject)
void	loadPage(StiPage page)
void	markPageAsNotSaved(StiPage page)
void	savePage(StiPage page)
void	savePage(StiPage page, boolean clearContent)
void	saveQuickPagesToCache()
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
StiPage	set(int index, StiPage element)
void	setCacheMode(boolean cacheMode)
void	setPageWithoutCache(int pageIndex, StiPage page)
void	setReport(StiReport report)

Methods inherited from class java.util.ArrayList

add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

cacheMode

public boolean cacheMode

canUseCacheMode

public boolean canUseCacheMode

pageCache

public StiSaveLoadPageEventHandler pageCache

notCachedPages

public List<StiPage> notCachedPages

Constructor Details

StiPagesCollection

public StiPagesCollection()

StiPagesCollection

public StiPagesCollection(StiReport report)

Method Details

get

public StiPage get(int index)

Specified by:

get in interface List<StiPage>

Overrides:

get in class ArrayList<StiPage>

set

public StiPage set(int index,
 StiPage element)

Specified by:

set in interface List<StiPage>

Overrides:

set in class ArrayList<StiPage>

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

addPage

public boolean addPage(StiPage page)

add

public boolean add(StiPage page)

Specified by:

add in interface Collection<StiPage>

Specified by:

add in interface List<StiPage>

Overrides:

add in class ArrayList<StiPage>

addV2Internal

public boolean addV2Internal(StiPage page)

fillReport

public void fillReport(StiReport report)

fillPageInChildren

public void fillPageInChildren()

getCacheMode

public boolean getCacheMode()

AddRange

public void AddRange(StiPagesCollection pagesStore)

addAll

public void addAll(StiPagesCollection pagesStore)

GetPage

public void GetPage(StiPage page)

savePage

public void savePage(StiPage page)

savePage

public void savePage(StiPage page,
 boolean clearContent)

loadPage

public void loadPage(StiPage page)

saveQuickPagesToCache

public void saveQuickPagesToCache()

flush

@Deprecated
public void flush()

Deprecated.

flush

@Deprecated
public void flush(boolean final_)

Deprecated.

copyEventsOfPagesCollection

public static void copyEventsOfPagesCollection(StiPagesCollection sourcePages,
 StiPagesCollection destinationPages)

getPageWithoutCache

public StiPage getPageWithoutCache(int pageIndex)

setPageWithoutCache

public void setPageWithoutCache(int pageIndex,
 StiPage page)

get

public StiPage get(String pageName)

Return StiPage by page name

Parameters:

pageName -

Returns:

addPageToQuickCache

public void addPageToQuickCache(StiPage page,
 boolean savePage)

isNotSavedPage

public boolean isNotSavedPage(StiPage page)

markPageAsNotSaved

public void markPageAsNotSaved(StiPage page)

GetComponentByName

public StiComponent GetComponentByName(String componentName)

getReport

public StiReport getReport()

Returns:

the report

setCacheMode

public void setCacheMode(boolean cacheMode)

Parameters:

cacheMode - the cacheMode to set

setReport

public void setReport(StiReport report)

Parameters:

report - the report to set