com.box.androidsdk.preview.fragments

Class BoxPreviewDocumentFragment

java.lang.Object

androidx.fragment.app.Fragment

com.box.androidsdk.preview.fragments.BoxPreviewFragment

com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

com.box.androidsdk.preview.fragments.BoxPreviewDocumentFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, BoxExecutor

public class BoxPreviewDocumentFragment
extends BoxPreviewDefaultFragment

PDF Fragment used to display PDF previews for all document types. Acts as a wrapper for BoxPSPDFFragment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxPreviewDocumentFragment.TrackingProgressListener

Nested classes/interfaces inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

BoxPreviewFragment.BoxPreviewController, BoxPreviewFragment.Listener

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_DOCUMENT_TAG

Fields inherited from class com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

mIsErrorShowing, mReportsTransferBytes

Fields inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

EXTRA_BOX_ITEM, EXTRA_POSITION, EXTRA_PREVIEW_LOADED, EXTRA_THUMBNAIL_LOADED, MANDATORY_BOX_FILE_FIELDS, mController, mPosition, mPreviewLoaded, mReceiver, mThumbnailLoaded, TAG

Constructor Summary

Constructors

Constructor and Description
BoxPreviewDocumentFragment()

Method Summary

Modifier and Type	Method and Description
com.pspdfkit.configuration.activity.PdfActivityConfiguration	buildViewConfiguration(java.lang.String key) Method used by the PSPDFKit native libraries to return the appropriate view configurations
static BoxRequestsPreview.DownloadPreview	getCachePreviewRequest(PreviewController previewController, com.box.androidsdk.content.models.BoxFile boxFile)
com.pspdfkit.ui.PdfFragment	getPdfFragment()
boolean	isProgressBarVisible()
void	loadContent(BoxExecutor executor, java.util.Collection<java.util.concurrent.FutureTask> tasks, PreviewStorage storage)
protected void	onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)
protected void	onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroy()
void	onDocumentLoaded()
void	onTaskCompleted(java.util.concurrent.FutureTask task, java.util.Collection<java.util.concurrent.FutureTask> tasks, PreviewStorage storage)
protected void	restartDownload() Logic to handle a restarted download, such as resetting requests, adding progress bars, and removing default views.
void	setDocumentListener(com.pspdfkit.listeners.DocumentListener documentListener)
void	showUnavailable(java.lang.String message) Logic to handle unavailable previews, such as removing progress bars and showing default views.
protected void	updateProgress(long bytesLoaded, long totalBytes)

Methods inherited from class com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

getProgressBar, getVisibleViews, hideError, hideProgress, initDefaultViews, isContainerVisible, onActivityCreated, onCreate, onSaveInstanceState, onStart, restoreStatus, setProgress, showProgress

Methods inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

cancelLoadContent, checkTasksBeforeExecute, checkTasksBeforeExecute, createInstance, execute, getBoxFile, getBoxSession, getIntentFilter, getPosition, getPreviewController, handleMessage, isContentLoading, loadContent, notifyFragmentLoaded, notifyFragmentUnloaded, onDetach, onInternetConnectionChanged, onPause, onResume, setPreviewController, setUserVisibleHint, showNetworkUnavailable

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_DOCUMENT_TAG

public static final java.lang.String METADATA_DOCUMENT_TAG

See Also:

Constant Field Values

Constructor Detail

BoxPreviewDocumentFragment

public BoxPreviewDocumentFragment()

Method Detail

onCreateView

@Nullable
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                                android.view.ViewGroup container,
                                                android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class BoxPreviewDefaultFragment

onBoxRequestSuccess

protected void onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)

Overrides:

onBoxRequestSuccess in class BoxPreviewDefaultFragment

onBoxRequestError

protected void onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)

Overrides:

onBoxRequestError in class BoxPreviewDefaultFragment

onTaskCompleted

public void onTaskCompleted(java.util.concurrent.FutureTask task,
                            java.util.Collection<java.util.concurrent.FutureTask> tasks,
                            PreviewStorage storage)

Overrides:

onTaskCompleted in class BoxPreviewFragment

restartDownload

protected void restartDownload()

Description copied from class: BoxPreviewFragment

Logic to handle a restarted download, such as resetting requests, adding progress bars, and removing default views.

Overrides:

restartDownload in class BoxPreviewDefaultFragment

showUnavailable

public void showUnavailable(java.lang.String message)

Description copied from class: BoxPreviewFragment

Logic to handle unavailable previews, such as removing progress bars and showing default views.

Overrides:

showUnavailable in class BoxPreviewDefaultFragment

Parameters:

message - message to show when handling this error case.

loadContent

public void loadContent(BoxExecutor executor,
                        java.util.Collection<java.util.concurrent.FutureTask> tasks,
                        PreviewStorage storage)

Overrides:

loadContent in class BoxPreviewDefaultFragment

updateProgress

protected void updateProgress(long bytesLoaded,
                              long totalBytes)

getCachePreviewRequest

public static BoxRequestsPreview.DownloadPreview getCachePreviewRequest(PreviewController previewController,
                                                                        com.box.androidsdk.content.models.BoxFile boxFile)

buildViewConfiguration

public com.pspdfkit.configuration.activity.PdfActivityConfiguration buildViewConfiguration(java.lang.String key)

Method used by the PSPDFKit native libraries to return the appropriate view configurations

Parameters:

key - the library key

Returns:

a PdfActivityConfiguration to use to show a pdf

getPdfFragment

public com.pspdfkit.ui.PdfFragment getPdfFragment()

setDocumentListener

public void setDocumentListener(com.pspdfkit.listeners.DocumentListener documentListener)

onDocumentLoaded

public void onDocumentLoaded()

onDestroy

public void onDestroy()

Overrides:

onDestroy in class BoxPreviewFragment

isProgressBarVisible

public boolean isProgressBarVisible()