com.codename1.cloud

Class CloudListModel

java.lang.Object

com.codename1.cloud.CloudListModel

All Implemented Interfaces:

ListModel

Deprecated.

the cloud storage API is no longer supported, we recommend switching to a solution such as parse4cn1

public class CloudListModel
extends Object
implements ListModel

Seamlessly creates a cloud based searchable list model

Constructor Summary

Constructors

Constructor and Description
CloudListModel(String type, int visibilityScope, int sortProperty, boolean ascending) Deprecated. Creates a list model that shows all the cloud elements that have the given key matching the given value at the visibility scope listed below.
CloudListModel(String type, int visibilityScope, int index, String queryValue, boolean ascending) Deprecated. Creates a list model that shows all the cloud elements that have the given key matching the given value at the visibility scope listed below.

Method Summary

Modifier and Type	Method and Description
void	addDataChangedListener(DataChangedListener l) Deprecated. Invoked to indicate interest in future change events
void	addItem(Object item) Deprecated. Notice this method does NOT commit the data, after committing the data the cache MUST be cleared! Adds the specified item to the end of this list.
void	addSelectionListener(SelectionListener l) Deprecated. Invoked to indicate interest in future selection events
void	clearCache() Deprecated. Flushes the cache which might be essential when adding new elements
int	getBatchSize() Deprecated. Returns the batch size fetched from the server
int	getCacheSize() Deprecated. Returns the elements cached within the implementation
Object	getItemAt(int index) Deprecated. Returns the item at the given offset
Hashtable	getLoadingPlaceholder() Deprecated. When loading the element from the cloud a placehold is shown to indicate to the user that the content isn't fully here
int	getRefreshRateMillis() Deprecated. Indicates the rate in milliseconds in which to poll the server for the current data of elements that are visible at the moment.
int	getSelectedIndex() Deprecated. Returns the selected list offset
int	getSize() Deprecated. Returns the number of items in the list
int	getStorageCacheSize() Deprecated. Returns the elements cached within the persistent storage
protected void	onError(CloudException err) Deprecated. Invoked when a cloud error occurs
void	refresh() Deprecated. Refreshes the list from the server, this method blocks the EDT until completion.
void	removeDataChangedListener(DataChangedListener l) Deprecated. Invoked to indicate no further interest in future change events
void	removeItem(int index) Deprecated. Notice this method does NOT commit the data, after committing the data the cache MUST be cleared! Removes the item at the specified position in this list.
void	removeSelectionListener(SelectionListener l) Deprecated. Invoked to indicate no further interest in future selection events
void	setBatchSize(int batchSize) Deprecated. Updates the number of elements fetched from the server in a single batch
void	setCacheSize(int elements) Deprecated. Sets the size of the local cache
void	setLoadingPlaceholder(Hashtable loadingPlaceholder) Deprecated. When loading the element from the cloud a placehold is shown to indicate to the user that the content isn't fully here
void	setRefreshRateMillis(int refreshRateMillis) Deprecated. Indicates the rate in milliseconds in which to poll the server for the current data of elements that are visible at the moment.
void	setSelectedIndex(int index) Deprecated. Sets the selected list offset can be set to -1 to clear selection
void	setStorageCacheSize(int elements) Deprecated. Sets the size of the cache in persistent storage

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudListModel

public CloudListModel(String type,
                      int visibilityScope,
                      int sortProperty,
                      boolean ascending)

Deprecated.

Creates a list model that shows all the cloud elements that have the given key matching the given value at the visibility scope listed below. This model can be further narrowed down by using the filter functionality below.
This is effectively equivalent to issuing a queryEquals method, however it polls in batches and caches data as needed.

Parameters:

type - the type of object shown on the list

visibilityScope - the scope of the list (CloudObject.ACCESS_* values)

sortProperty - the index by which we sort the entries, 0 for unsorted

ascending - whether the sort is ascending or descending

CloudListModel

public CloudListModel(String type,
                      int visibilityScope,
                      int index,
                      String queryValue,
                      boolean ascending)

Deprecated.

Creates a list model that shows all the cloud elements that have the given key matching the given value at the visibility scope listed below. This model can be further narrowed down by using the filter functionality below.
This is effectively equivalent to issuing a queryEquals method, however it polls in batches and caches data as needed.

Parameters:

type - the type of object shown on the list

visibilityScope - the scope of the list (CloudObject.ACCESS_* values)

index - the index by which we limit the entries

queryValue - the queryValue for the given index

ascending - whether the sort is ascending or descending

Method Detail

refresh

public void refresh()

Deprecated.

Refreshes the list from the server, this method blocks the EDT until completion.

clearCache

public void clearCache()

Deprecated.

Flushes the cache which might be essential when adding new elements

setCacheSize

public void setCacheSize(int elements)

Deprecated.

Sets the size of the local cache

Parameters:

elements - elements to store in cache

getCacheSize

public int getCacheSize()

Deprecated.

Returns the elements cached within the implementation

Returns:

the cache size

setStorageCacheSize

public void setStorageCacheSize(int elements)

Deprecated.

Sets the size of the cache in persistent storage

Parameters:

elements - elements to store in cache

getStorageCacheSize

public int getStorageCacheSize()

Deprecated.

Returns the elements cached within the persistent storage

Returns:

the cache size

setLoadingPlaceholder

public void setLoadingPlaceholder(Hashtable loadingPlaceholder)

Deprecated.

When loading the element from the cloud a placehold is shown to indicate to the user that the content isn't fully here

Parameters:

loadingPlaceholder - shows blank content to the user

getLoadingPlaceholder

public Hashtable getLoadingPlaceholder()

Deprecated.

When loading the element from the cloud a placehold is shown to indicate to the user that the content isn't fully here

Returns:

the element shown when content isn't available for a specific entry

getBatchSize

public int getBatchSize()

Deprecated.

Returns the batch size fetched from the server

Returns:

the size

setBatchSize

public void setBatchSize(int batchSize)

Deprecated.

Updates the number of elements fetched from the server in a single batch

Parameters:

batchSize - the batch size

getItemAt

public Object getItemAt(int index)

Deprecated.

Returns the item at the given offset

Specified by:

getItemAt in interface ListModel

Parameters:

index - an index into this list

Returns:

the item at the specified index

getSize

public int getSize()

Deprecated.

Returns the number of items in the list

Specified by:

getSize in interface ListModel

Returns:

the number of items in the list

onError

protected void onError(CloudException err)

Deprecated.

Invoked when a cloud error occurs

Parameters:

err - the exception representing the error in cloud communications

getSelectedIndex

public int getSelectedIndex()

Deprecated.

Returns the selected list offset

Specified by:

getSelectedIndex in interface ListModel

Returns:

the selected list index

setSelectedIndex

public void setSelectedIndex(int index)

Deprecated.

Sets the selected list offset can be set to -1 to clear selection

Specified by:

setSelectedIndex in interface ListModel

Parameters:

index - an index into this list

addDataChangedListener

public void addDataChangedListener(DataChangedListener l)

Deprecated.

Invoked to indicate interest in future change events

Specified by:

addDataChangedListener in interface ListModel

Parameters:

l - a data changed listener

removeDataChangedListener

public void removeDataChangedListener(DataChangedListener l)

Deprecated.

Invoked to indicate no further interest in future change events

Specified by:

removeDataChangedListener in interface ListModel

Parameters:

l - a data changed listener

addSelectionListener

public void addSelectionListener(SelectionListener l)

Deprecated.

Invoked to indicate interest in future selection events

Specified by:

addSelectionListener in interface ListModel

Parameters:

l - a selection listener

removeSelectionListener

public void removeSelectionListener(SelectionListener l)

Deprecated.

Invoked to indicate no further interest in future selection events

Specified by:

removeSelectionListener in interface ListModel

Parameters:

l - a selection listener

addItem

public void addItem(Object item)

Deprecated.

Notice this method does NOT commit the data, after committing the data the cache MUST be cleared! Adds the specified item to the end of this list. An optional operation for mutable lists, it can throw an unsupported operation exception if a list model is not mutable.

Specified by:

addItem in interface ListModel

Parameters:

item - the item to be added

removeItem

public void removeItem(int index)

Deprecated.

Notice this method does NOT commit the data, after committing the data the cache MUST be cleared! Removes the item at the specified position in this list.

Specified by:

removeItem in interface ListModel

Parameters:

index - the index of the item to removed

getRefreshRateMillis

public int getRefreshRateMillis()

Deprecated.

Indicates the rate in milliseconds in which to poll the server for the current data of elements that are visible at the moment.

Returns:

the refreshRateMillis

setRefreshRateMillis

public void setRefreshRateMillis(int refreshRateMillis)

Deprecated.

Indicates the rate in milliseconds in which to poll the server for the current data of elements that are visible at the moment.

Parameters:

refreshRateMillis - the refreshRateMillis to set