com.box.boxandroidlibv2.manager

Class ThumbnailManager

java.lang.Object

com.box.boxandroidlibv2.manager.ThumbnailManager

public class ThumbnailManager
extends java.lang.Object

This class manages thumbnails to display to users. This class does not do network calls.

Constructor Summary

Constructors

Constructor and Description
ThumbnailManager(java.io.File cacheDirectory) Constructor.
ThumbnailManager(java.lang.String cacheDirectoryPath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFilesInCacheDirectory() Convenience method to delete all files in the provided cache directory.
java.io.File	getCacheDirectory()
java.io.File	getThumbnailForFile(java.lang.String fileId) Returns a file in a determinate location for the given boxItem.
void	setThumbnailIntoView(ImageView icon, BoxItem boxItem) Sets the best known image for given item into the given view.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThumbnailManager

public ThumbnailManager(java.lang.String cacheDirectoryPath)
                 throws java.io.FileNotFoundException

Constructor.

Parameters:

cacheDirectoryPath - the directory to store thumbnail images.

Throws:

java.io.FileNotFoundException - thrown if the directory given does not exist and cannot be created.

ThumbnailManager

public ThumbnailManager(java.io.File cacheDirectory)
                 throws java.io.FileNotFoundException

Constructor.

Parameters:

cacheDirectory - a file representing the directory to store thumbnail images.

Throws:

java.io.FileNotFoundException - thrown if the directory given does not exist and cannot be created.

Method Detail

setThumbnailIntoView

public void setThumbnailIntoView(ImageView icon,
                        BoxItem boxItem)

Sets the best known image for given item into the given view.

Parameters:

icon - view to set image for.

boxItem - the BoxItem used to set the view.

getThumbnailForFile

public java.io.File getThumbnailForFile(java.lang.String fileId)

Returns a file in a determinate location for the given boxItem.

Parameters:

fileId - The id of the box file.

Returns:

a File object where the thumbnail is saved to or should be saved to.

getCacheDirectory

public java.io.File getCacheDirectory()

Returns:

the cacheDirectory of this thumbnail manager.

deleteFilesInCacheDirectory

public void deleteFilesInCacheDirectory()

Convenience method to delete all files in the provided cache directory.