public class

ViewerBuilder

extends SkeletalFragmentBuilder<E extends Fragment>
java.lang.Object
   ↳ com.pdftron.pdf.interfaces.builder.SkeletalFragmentBuilder<E extends Fragment>
     ↳ com.pdftron.pdf.config.ViewerBuilder

Class Overview

Builder to create a PdfViewCtrlTabHostFragment.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<ViewerBuilder> CREATOR
Public Methods
PdfViewCtrlTabHostFragment build(Context context)
Convenience build method that calls build(Context, Class) with the default class for this builder.
void checkArgs(Context context)
Check the arguments of this builder.
Bundle createBundle(Context context)
Create the bundle that will be passed as arguments to the Fragment.
int describeContents()
boolean equals(Object o)
int hashCode()
ViewerBuilder usingCacheFolder(boolean useCacheFolder)
Call to enable or disable the use of the cache folder when creating temporary files.
ViewerBuilder usingConfig(ViewerConfig config)
Call to initialize the document viewer with a specified ViewerConfig.
ViewerBuilder usingCustomHeaders(JSONObject headers)
Sets custom headers to use with all requests.
ViewerBuilder usingCustomToolbar(int[] menu)
Define the custom menu resources to use in document viewer toolbar.
ViewerBuilder usingFileType(int fileType)
Call to define how the file will be handled by the document viewer.
ViewerBuilder usingNavIcon(int navIconRes)
Call to define the navigation icon used by this fragment.
ViewerBuilder usingTabClass(Class<? extends PdfViewCtrlTabFragment> tabClass)
Call to define the fragment class that will be used to instantiate viewer tabs.
ViewerBuilder usingTabTitle(String title)
Call to set the tab title in the document viewer with the specified String.
static ViewerBuilder withFile(File file)
Similar to {@link #withFile(File, String)), but without a specified password.
static ViewerBuilder withFile(File file, String password)
Similar to {@link #withUri(Uri, String)), but with a specified File object.
static ViewerBuilder withUri(Uri file)
static ViewerBuilder withUri(Uri file, String password)
Create a ViewerBuilder 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<ViewerBuilder> CREATOR

Public Methods

public PdfViewCtrlTabHostFragment build (Context context)

Convenience build method that calls build(Context, Class) with the default class for this builder.

Parameters
context the context used to initialize the fragment and its theme.
Returns
  • an instance of E with the specified parameters from the builder.

public void checkArgs (Context context)

Check the arguments of this builder. You can also det the default builder parameters in this method.

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 boolean equals (Object o)

public int hashCode ()

public ViewerBuilder usingCacheFolder (boolean useCacheFolder)

Call to enable or disable the use of the cache folder when creating temporary files. By default the cache folder is used, and if set to false the Downloads folder is used.

Parameters
useCacheFolder true to enable using the cache folder, false to use the downloads folder
Returns
  • this builder with the specified use of the cache folder

public ViewerBuilder usingConfig (ViewerConfig config)

Call to initialize the document viewer with a specified ViewerConfig. Multi-tab is unsupported for the collab documentation viewer and must be disabled in ViewerConfig.

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

public ViewerBuilder usingCustomHeaders (JSONObject headers)

Sets custom headers to use with all requests.

Parameters
headers custom headers for all requests
Returns
  • this builder with the specified custom headers

public ViewerBuilder usingCustomToolbar (int[] menu)

Define the custom menu resources to use in document viewer toolbar.

Parameters
menu custom toolbar menu XML resources to use in the document viewer
Returns
  • this builder with the specified custom toolbar menu

public ViewerBuilder usingFileType (int fileType)

Call to define how the file will be handled by the document viewer. By default, this is unspecified (value of 0) and the document viewer will automatically handle this; this is usually called to fulfill certain requirements and will not be needed in most cases.

The file types are defined in BaseFileInfo.

Parameters
fileType specified to handle the file in a specific way.
Returns
  • this builder with the specified file type handling

public ViewerBuilder usingNavIcon (int navIconRes)

Call to define the navigation icon used by this fragment. By default, a menu list icon is used for the navigation button.

Parameters
navIconRes the class that the viewer will used to instantiate tabs
Returns
  • this builder with the specified navigation icon

public ViewerBuilder usingTabClass (Class<? extends PdfViewCtrlTabFragment> tabClass)

Call to define the fragment class that will be used to instantiate viewer tabs.

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

public ViewerBuilder usingTabTitle (String title)

Call to set the tab title in the document viewer with the specified String. If null is specified, then the default title handling in the document viewer will be used.

Parameters
title title used for the tab when viewing the specified document
Returns
  • this builder with the specified tab title

public static ViewerBuilder withFile (File file)

Similar to {@link #withFile(File, String)), but without a specified password.

public static ViewerBuilder withFile (File file, String password)

Similar to {@link #withUri(Uri, String)), but with a specified File object.

public static ViewerBuilder withUri (Uri file)

public static ViewerBuilder withUri (Uri file, String password)

Create a ViewerBuilder 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 needed, null otherwise
Returns
  • builder with the specified document and password

public void writeToParcel (Parcel dest, int flags)