org.cesiumjs.cs.collections

Class DataSourceCollection<T extends DataSource>

java.lang.Object

org.cesiumjs.cs.collections.Collection<DataSource>

org.cesiumjs.cs.collections.DataSourceCollection<T>

@JsType(isNative=true,
        namespace="Cesium",
        name="DataSourceCollection")
public class DataSourceCollection<T extends DataSource>
extends Collection<DataSource>

A collection of DataSource instances.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
DataSourceCollection()

Method Summary

Modifier and Type	Method and Description
Promise<T,Void>	add(Promise<T,Void> dataSource) Adds a data source to the collection.
Promise<T,Void>	add(T dataSource) Adds a data source to the collection.
Event	dataSourceAdded() An event that is raised when a data source is added to the collection.
Event	dataSourceRemoved() An event that is raised when a data source is removed from the collection.
int	indexOf(T dataSource) Determines the index of a given data source in the collection.
void	lower(T dataSource) Lowers a data source down one position in the collection.
void	lowerToBottom(T dataSource) Lowers a data source to the bottom of the collection.
void	raise(T dataSource) Raises a data source up one position in the collection.
void	raiseToTop(T dataSource) Raises a data source to the top of the collection.
boolean	remove(T dataSource, boolean destroy) Removes a data source from this collection, if present.
void	removeAll(boolean destroy) Removes all data sources from this collection.

Methods inherited from class org.cesiumjs.cs.collections.Collection

add, add, contains, destroy, get, isDestroyed, length, remove, remove, removeAll, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSourceCollection

@JsConstructor
public DataSourceCollection()

Method Detail

dataSourceAdded

@JsProperty(name="dataSourceAdded")
public Event dataSourceAdded()

An event that is raised when a data source is added to the collection. Event handlers are passed the data source that was added.

dataSourceRemoved

@JsProperty(name="dataSourceRemoved")
public Event dataSourceRemoved()

An event that is raised when a data source is removed from the collection. Event handlers are passed the data source that was removed.

add

@JsMethod
public Promise<T,Void> add(Promise<T,Void> dataSource)

Adds a data source to the collection.

Parameters:

dataSource - A data source or a promise to a data source to add to the collection. When passing a promise, the data source will not actually be added to the collection until the promise resolves successfully.

add

@JsMethod
public Promise<T,Void> add(T dataSource)

Adds a data source to the collection.

Parameters:

dataSource - A data source or a promise to a data source to add to the collection. When passing a promise, the data source will not actually be added to the collection until the promise resolves successfully.

indexOf

@JsMethod
public int indexOf(T dataSource)

Determines the index of a given data source in the collection.

Parameters:

dataSource - The data source to find the index of.

Returns:

The index of the data source in the collection, or -1 if the data source does not exist in the collection.

remove

@JsMethod
public boolean remove(T dataSource,
                                boolean destroy)

Removes a data source from this collection, if present.

Parameters:

dataSource - The data source to remove.

destroy - Whether to destroy the data source in addition to removing it. Default: false

Returns:

true if the data source was in the collection and was removed, false if the data source was not in the collection.

removeAll

@JsMethod
public void removeAll(boolean destroy)

Removes all data sources from this collection.

Parameters:

destroy - whether to destroy the data sources in addition to removing them. Default: false

lower

@JsMethod
public void lower(T dataSource)

Lowers a data source down one position in the collection.

Parameters:

dataSource - The data source to move.

lowerToBottom

@JsMethod
public void lowerToBottom(T dataSource)

Lowers a data source to the bottom of the collection.

Parameters:

dataSource - The data source to move.

raise

@JsMethod
public void raise(T dataSource)

Raises a data source up one position in the collection.

Parameters:

dataSource - The data source to move.

raiseToTop

@JsMethod
public void raiseToTop(T dataSource)

Raises a data source to the top of the collection.

Parameters:

dataSource - The data source to move.