public class

CollabViewerBuilder

extends SkeletalFragmentBuilder<E extends Fragment>
java.lang.Object
   ↳ com.pdftron.pdf.interfaces.builder.SkeletalFragmentBuilder<E extends Fragment>
     ↳ com.pdftron.collab.ui.viewer.CollabViewerBuilder

Class Overview

Builder to create a CollabViewerTabHostFragment.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<CollabViewerBuilder> CREATOR
Public Methods
CollabViewerTabHostFragment build(Context context)
Create a the default CollabViewerTabHostFragment, initialized with builder settings.
void checkArgs(Context context)
Helpers to check builder parameters
Bundle createBundle(Context context)
Create the bundle that will be passed as arguments to the Fragment.
int describeContents()
CollabViewerBuilder usingConfig(ViewerConfig config)
Used to initialize the reply fragment with a specified ViewerConfig.
CollabViewerBuilder usingTabClass(Class<? extends CollabViewerTabFragment> tabClass)
Defines the fragment class that will be used to instantiate viewer tabs.
static CollabViewerBuilder withUri(Uri file)
static CollabViewerBuilder withUri(Uri file, String password)
Create a CollabViewerBuilder with the specified document and password if applicable.
void writeToParcel(Parcel dest, int flags)
[Expand]
Inherited Methods
From class com.pdftron.pdf.interfaces.builder.SkeletalFragmentBuilder
From class java.lang.Object
From interface android.os.Parcelable
From interface com.pdftron.pdf.interfaces.builder.Builder

Fields

public static final Creator<CollabViewerBuilder> CREATOR

Public Methods

public CollabViewerTabHostFragment build (Context context)

Create a the default CollabViewerTabHostFragment, initialized with builder settings. Uses the theme from the specified context.

Parameters
context the context used to initialize the fragment and its theme
Returns

public void checkArgs (Context context)

Helpers to check builder parameters

Parameters
context used to initialize default building parameters

public Bundle createBundle (Context context)

Create the bundle that will be passed as arguments to the Fragment. Called right after calling checkArgs(Context)

Parameters
context used to initialize arguments for the bundle.
Returns
  • the bundle with the required arguments for the Fragment.

public int describeContents ()

public CollabViewerBuilder usingConfig (ViewerConfig config)

Used to initialize the reply fragment with a specified ViewerConfig. Multi-tab is unsupported for the collaboration documentation viewer and must be disabled in ViewerConfig.

Parameters
config to initialize the document viewer
Returns
  • this builder with the specified configurations

public CollabViewerBuilder usingTabClass (Class<? extends CollabViewerTabFragment> tabClass)

Defines the fragment class that will be used to instantiate viewer tabs. Currently, the viewer only support a single tab fragment (multi-tabs are currently unsupported).

Parameters
tabClass the class that the viewer will used to instantiate tabs
Returns
  • this builder with the specified configurations

public static CollabViewerBuilder withUri (Uri file)

public static CollabViewerBuilder withUri (Uri file, String password)

Create a CollabViewerBuilder with the specified document and password if applicable.

Parameters
file Uri that specifies the location of the document
password used to open the document if required, null otherwise
Returns
  • builder with the specified document and password

public void writeToParcel (Parcel dest, int flags)