BoxPreviewFragment (box-preview-sdk 3.0.0 API)

java.lang.Object
- androidx.fragment.app.Fragment
- - com.box.androidsdk.preview.fragments.BoxPreviewFragment

All Implemented Interfaces:

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

Direct Known Subclasses:

BoxPreviewDefaultFragment
```
public abstract class BoxPreviewFragment
extends androidx.fragment.app.Fragment
implements BoxExecutor
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BoxPreviewFragment.BoxPreviewController

static interface BoxPreviewFragment.Listener
- Nested classes/interfaces inherited from class androidx.fragment.app.Fragment
  androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BoxPreviewFragment.BoxPreviewController`
`static interface`	`BoxPreviewFragment.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTRA_BOX_ITEM`
`static java.lang.String`	`EXTRA_POSITION`
`static java.lang.String`	`EXTRA_PREVIEW_LOADED`
`static java.lang.String`	`EXTRA_THUMBNAIL_LOADED`
`static java.util.Set<java.lang.String>`	`MANDATORY_BOX_FILE_FIELDS`
`protected BoxPreviewFragment.BoxPreviewController`	`mController`
`protected int`	`mPosition`
`protected boolean`	`mPreviewLoaded` Represents whether the preview has been loaded/cached
`protected android.content.BroadcastReceiver`	`mReceiver`
`protected boolean`	`mThumbnailLoaded`
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

BoxPreviewFragment()

Constructors
Constructor and Description
`BoxPreviewFragment()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelLoadContent(java.util.Collection<java.util.concurrent.FutureTask> tasks)`
`protected <E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E>`	`checkTasksBeforeExecute(java.lang.Class<E> retObj, com.box.androidsdk.content.requests.BoxRequest request)` Checks if the request has already been added to the task queue.
`<E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E>`	`checkTasksBeforeExecute(InspectableBoxFutureTask request)` Checks if the request has already been added to the task queue.
`static BoxPreviewFragment`	`createInstance(com.box.androidsdk.content.models.BoxFile boxFile, int position)`
`void`	`execute(java.util.concurrent.FutureTask request)`
`com.box.androidsdk.content.models.BoxFile`	`getBoxFile()`
`com.box.androidsdk.content.models.BoxSession`	`getBoxSession()`
`protected android.content.IntentFilter`	`getIntentFilter()`
`int`	`getPosition()`
`BoxPreviewFragment.BoxPreviewController`	`getPreviewController()`
`protected void`	`handleMessage(BoxPreviewMessage msg)`
`protected boolean`	`isContentLoading()` Returns whether or not content is currently loading for the fragment ie.
`protected void`	`loadContent()`
`void`	`loadContent(BoxExecutor executor, java.util.Collection<java.util.concurrent.FutureTask> tasks, PreviewStorage storage)`
`protected void`	`notifyFragmentLoaded()` Notifies listeners that all necessary components required by the preview fragment are loaded and ready
`protected void`	`notifyFragmentUnloaded()` Notifies listeners that the fragment is unloaded and no longer visible
`protected abstract void`	`onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)`
`protected abstract void`	`onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)`
`void`	`onCreate(android.os.Bundle savedInstanceState)`
`void`	`onDestroy()`
`void`	`onDetach()`
`void`	`onInternetConnectionChanged(boolean connected)` Entry public static final String METADATA_DOCUMENT_TAG = "doc"; point to handle a lost or found internet connection at the fragment level.
`void`	`onPause()`
`void`	`onResume()`
`void`	`onSaveInstanceState(android.os.Bundle outState)`
`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`	`setPreviewController(BoxPreviewFragment.BoxPreviewController controller)`
`void`	`setUserVisibleHint(boolean isVisibleToUser)`
`protected void`	`showNetworkUnavailable()` Shows that the preview is unavailable due to the network not being available
`protected void`	`showUnavailable(java.lang.String message)` Logic to handle unavailable previews, such as removing progress bars and showing default views.

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, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroyOptionsMenu, onDestroyView, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onStart, 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
  - EXTRA_POSITION
```
public static final java.lang.String EXTRA_POSITION
```
    See Also:
    
    Constant Field Values
  - EXTRA_BOX_ITEM
```
public static final java.lang.String EXTRA_BOX_ITEM
```
    See Also:
    
    Constant Field Values
  - EXTRA_PREVIEW_LOADED
```
public static final java.lang.String EXTRA_PREVIEW_LOADED
```
    See Also:
    
    Constant Field Values
  - EXTRA_THUMBNAIL_LOADED
```
public static final java.lang.String EXTRA_THUMBNAIL_LOADED
```
    See Also:
    
    Constant Field Values
  - TAG
```
public static final java.lang.String TAG
```
  - MANDATORY_BOX_FILE_FIELDS
```
public static final java.util.Set<java.lang.String> MANDATORY_BOX_FILE_FIELDS
```
  - mController
```
protected BoxPreviewFragment.BoxPreviewController mController
```
  - mPosition
```
protected int mPosition
```
  - mPreviewLoaded
```
protected boolean mPreviewLoaded
```
    Represents whether the preview has been loaded/cached
  - mThumbnailLoaded
```
protected boolean mThumbnailLoaded
```
  - mReceiver
```
protected android.content.BroadcastReceiver mReceiver
```
- Constructor Detail
  - BoxPreviewFragment
```
public BoxPreviewFragment()
```
- Method Detail
  - onCreate
```
public void onCreate(@Nullable
                     android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreate in class androidx.fragment.app.Fragment
  - setPreviewController
```
public void setPreviewController(BoxPreviewFragment.BoxPreviewController controller)
```
  - getPreviewController
```
public BoxPreviewFragment.BoxPreviewController getPreviewController()
```
  - getBoxFile
```
public com.box.androidsdk.content.models.BoxFile getBoxFile()
```
  - getBoxSession
```
public com.box.androidsdk.content.models.BoxSession getBoxSession()
```
  - getIntentFilter
```
protected android.content.IntentFilter getIntentFilter()
```
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
    Overrides:
    
    onSaveInstanceState in class androidx.fragment.app.Fragment
  - onResume
```
public void onResume()
```
    Overrides:
    
    onResume in class androidx.fragment.app.Fragment
  - setUserVisibleHint
```
public void setUserVisibleHint(boolean isVisibleToUser)
```
    Overrides:
    
    setUserVisibleHint in class androidx.fragment.app.Fragment
  - onDestroy
```
public void onDestroy()
```
    Overrides:
    
    onDestroy in class androidx.fragment.app.Fragment
  - onDetach
```
public void onDetach()
```
    Overrides:
    
    onDetach in class androidx.fragment.app.Fragment
  - onPause
```
public void onPause()
```
    Overrides:
    
    onPause in class androidx.fragment.app.Fragment
  - getPosition
```
public int getPosition()
```
  - execute
```
public void execute(java.util.concurrent.FutureTask request)
```
    Specified by:
    
    execute in interface BoxExecutor
  - notifyFragmentLoaded
```
protected void notifyFragmentLoaded()
```
    Notifies listeners that all necessary components required by the preview fragment are loaded and ready
  - notifyFragmentUnloaded
```
protected void notifyFragmentUnloaded()
```
    Notifies listeners that the fragment is unloaded and no longer visible
  - handleMessage
```
protected void handleMessage(BoxPreviewMessage msg)
```
  - onTaskCompleted
```
public void onTaskCompleted(java.util.concurrent.FutureTask task,
                            java.util.Collection<java.util.concurrent.FutureTask> tasks,
                            PreviewStorage storage)
```
  - onBoxRequestError
```
protected abstract void onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)
```
  - onBoxRequestSuccess
```
protected abstract void onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)
```
  - loadContent
```
protected void loadContent()
```
  - loadContent
```
public void loadContent(BoxExecutor executor,
                        java.util.Collection<java.util.concurrent.FutureTask> tasks,
                        PreviewStorage storage)
```
  - onInternetConnectionChanged
```
public void onInternetConnectionChanged(boolean connected)
```
    Entry public static final String METADATA_DOCUMENT_TAG = "doc"; point to handle a lost or found internet connection at the fragment level.
    
    Parameters:
    
    connected - whether or not there is a valid internet connection
  - restartDownload
```
protected void restartDownload()
```
    Logic to handle a restarted download, such as resetting requests, adding progress bars, and removing default views.
  - showUnavailable
```
protected void showUnavailable(java.lang.String message)
```
    Logic to handle unavailable previews, such as removing progress bars and showing default views.
    
    Parameters:
    
    message - message to show when handling this error case.
  - showNetworkUnavailable
```
protected void showNetworkUnavailable()
```
    Shows that the preview is unavailable due to the network not being available
  - checkTasksBeforeExecute
```
protected <E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E> checkTasksBeforeExecute(java.lang.Class<E> retObj,
                                                                                                                                             com.box.androidsdk.content.requests.BoxRequest request)
```
    Checks if the request has already been added to the task queue. If the request is done it will attempt to return the response. If the request is not in the task queue or was not successful, the request will be executed again. This will only compare the request class name to see if the tasks are the same.
    
    Type Parameters:
    
    E - return type for the request that extends from {BoxObject}
    
    Parameters:
    
    retObj - return type for the request
    
    request - the request to try executing
    
    Returns:
    
    The completed response for the request only if it was successful
  - checkTasksBeforeExecute
```
public <E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E> checkTasksBeforeExecute(InspectableBoxFutureTask request)
```
    Checks if the request has already been added to the task queue. If the request is done it will attempt to return the response. If the request is not in the task queue or was not successful, the request will be executed again. This will compare the request class name as well as the tag to see if the request has already been added.
    
    Type Parameters:
    
    E - return type for the request that extends from {BoxObject}
    
    Parameters:
    
    request - the inspectable request to try executing
    
    Returns:
    
    The completed response for the request only if it was successful
  - isContentLoading
```
protected boolean isContentLoading()
```
    Returns whether or not content is currently loading for the fragment ie. if an InspectableBoxFutureTask is in the task queue but has not yet completed
    
    Returns:
    
    true if content is still loading, false otherwise.
  - cancelLoadContent
```
public void cancelLoadContent(java.util.Collection<java.util.concurrent.FutureTask> tasks)
```
  - createInstance
```
public static BoxPreviewFragment createInstance(com.box.androidsdk.content.models.BoxFile boxFile,
                                                int position)
```

Class BoxPreviewFragment

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class androidx.fragment.app.Fragment

Methods inherited from class java.lang.Object

Field Detail

EXTRA_POSITION

EXTRA_BOX_ITEM

EXTRA_PREVIEW_LOADED

EXTRA_THUMBNAIL_LOADED

TAG

MANDATORY_BOX_FILE_FIELDS

mController

mPosition

mPreviewLoaded

mThumbnailLoaded

mReceiver

Constructor Detail

BoxPreviewFragment

Method Detail

onCreate

setPreviewController

getPreviewController

getBoxFile

getBoxSession

getIntentFilter

onSaveInstanceState

onResume

setUserVisibleHint

onDestroy

onDetach

onPause

getPosition

execute

notifyFragmentLoaded

notifyFragmentUnloaded

handleMessage

onTaskCompleted

onBoxRequestError

onBoxRequestSuccess

loadContent

loadContent

onInternetConnectionChanged

restartDownload

showUnavailable

showNetworkUnavailable

checkTasksBeforeExecute

checkTasksBeforeExecute

isContentLoading

cancelLoadContent

createInstance