java.lang.Object | ||
↳ | com.pdftron.pdf.interfaces.builder.SkeletalFragmentBuilder<E extends Fragment> | |
↳ | com.pdftron.pdf.config.ViewerBuilder |
This class is deprecated.
use ViewerBuilder2
instead.
Builder to create a PdfViewCtrlTabHostFragment
.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
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 |
usingFileExtension(String fileExtension)
Call to define the actual extension of a file.
| ||||||||||
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> tabFragmentClass)
Call to define the fragment class that will be used to instantiate viewer tabs.
| ||||||||||
ViewerBuilder |
usingTabHostClass(Class<? extends PdfViewCtrlTabHostFragment> tabHostClass)
Call to define the fragment class that will be used to instantiate viewer host fragment.
| ||||||||||
ViewerBuilder |
usingTabTitle(String title)
Call to set the tab title in the document viewer with the specified String.
| ||||||||||
ViewerBuilder |
usingTheme(int theme)
Call to define the theme.
| ||||||||||
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Convenience build method that calls build(Context, Class)
with the default class
for this builder.
context | the context used to initialize the fragment and its theme. |
---|
Check the arguments of this builder. You can also det the default builder parameters in this method.
context | used to initialize default building parameters |
---|
Create the bundle that will be passed as arguments to the Fragment. Called right after
calling checkArgs(Context)
context | used to initialize arguments for the bundle. |
---|
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.
useCacheFolder | true to enable using the cache folder, false to use the downloads folder |
---|
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.
config | to initialize the document viewer |
---|
ViewerConfig
configurations
Sets custom headers to use with all requests.
headers | custom headers for all requests |
---|
Define the custom menu resources to use in document viewer toolbar.
menu | custom toolbar menu XML resources to use in the document viewer |
---|
Call to define the actual extension of a file. By default, file extension is obtained from the file name unless otherwise specified
fileExtension | actual extension of a file. |
---|
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
.
fileType | specified to handle the file in a specific way. |
---|
Call to define the navigation icon used by this fragment. By default, a menu list icon is used for the navigation button.
navIconRes | the navigation icon res |
---|
Call to define the fragment class that will be used to instantiate viewer tabs.
tabFragmentClass | the class that the viewer will used to instantiate tabs |
---|
Call to define the fragment class that will be used to instantiate viewer host fragment.
tabHostClass | the class that the viewer will |
---|
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.
title | title used for the tab when viewing the specified document |
---|
Call to define the theme. By default, CustomAppTheme is used.
theme | the theme res |
---|
Similar to {@link #withFile(File, String)), but without a specified password.
Similar to {@link #withUri(Uri, String)), but with a specified File object.
Create a ViewerBuilder
with the specified document and password if applicable.
file | Uri that specifies the location of the document |
---|---|
password | used to open the document if needed, null otherwise |