1. Home
  2. Foxit PDF SDK for Android
  3. How to Implement the UIExtensions project in Foxit PDF SDK for Android

How to Implement the UIExtensions project in Foxit PDF SDK for Android

To customize the plugin UI, use the UIExtensions project. Foxit PDF SDK for Android comes with a built-in UI design including the basic UI for app and the feature modules UI, which are implemented using Foxit PDF SDK for Android and are shipped in the UI Extensions Component. Hence, building a full-featured PDF Reader is getting simpler and easier. All you need to do is to instantiate a UIExtensionsManager object, and then set it to PDFViewCtrl.

Instantiate a UIExtensionsManager object and set it to PDFViewCtrl

In “MainActivity.java” file, we are now going to add the code necessary for including the UIExtensionsManager. The required code additions are shown below and further down you will find a full example of what the “MainActivity.java” file should look like.

a) Set the system theme to “No Title” mode and set the window to Fullscreen.

Note: The UI Extensions Component has customized the user interface, so you need to set the system theme to “No Title” mode and set the window to Fullscreen. Otherwise, the layout of the built-in features might be affected.

import android.view.Window;
import android.view.WindowManager;
...
// Turn off the title at the top of the screen.
this.requestWindowFeature(Window.FEATURE_NO_TITLE);
// Set the window to Fullscreen.
getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN, 
WindowManager.LayoutParams.FLAG_FULLSCREEN);

b) Add code to instantiate a UIExtensionsManager object and set it to PDFViewCtrl.

import com.foxit.uiextensions.UIExtensionsManager;
...
private UIExtensionsManager uiExtensionsManager = null;
...
uiExtensionsManager = new UIExtensionsManager(this.getApplicationContext(), pdfViewCtrl);
uiExtensionsManager.setAttachedActivity(this);
uiExtensionsManager.onCreate(this, pdfViewCtrl, savedInstanceState);
pdfViewCtrl.setUIExtensionsManager(uiExtensionsManager);

c) Open and reader a PDF document, and set the content view.

Call UIExtensionsManager.openDocument() function to open and reader a PDF document instead of calling PDFViewCtrl.openDoc() function.

import com.foxit.uiextensions.UIExtensionsManager;
...
String path = "/mnt/sdcard/input_files/Sample.pdf";
uiExtensionsManager.openDocument(path, null);
setContentView(uiExtensionsManager.getContentView());

Update MainActivity.java as follows:

Note: The Activity Lifecycle Events should be handled as below, otherwise some features may not work correctly.

package com.foxit.pdfreader;
import android.Manifest;
import android.content.pm.PackageManager;
import android.content.res.Configuration;
import android.os.Build;
import android.support.annotation.NonNull;
import android.support.v4.app.ActivityCompat;
import android.support.v4.content.ContextCompat;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.KeyEvent;
import android.view.Window;
import android.view.WindowManager;
import com.foxit.sdk.PDFViewCtrl;
import com.foxit.sdk.common.Constants;
import com.foxit.sdk.common.Library;
import com.foxit.uiextensions.UIExtensionsManager;
public class MainActivity extends AppCompatActivity {
 private PDFViewCtrl pdfViewCtrl = null;
 private UIExtensionsManager uiExtensionsManager = null;
 private static final int REQUEST_EXTERNAL_STORAGE = 1;
 private static final String[] PERMISSIONS_STORAGE = {
 Manifest.permission.READ_EXTERNAL_STORAGE,
 Manifest.permission.WRITE_EXTERNAL_STORAGE
 };
 // The value of "sn" can be found in the "rdk_sn.txt".
 // The value of "key" can be found in the "rdk_key.txt".
 private static String sn = " ";
 private static String key = " ";
 @Override
 protected void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 // initialize the library.
 int errorCode = Library.initialize(sn, key);
 if (errorCode != Constants.e_ErrSuccess)
 return;
 // Turn off the title at the top of the screen.
 this.requestWindowFeature(Window.FEATURE_NO_TITLE);
 // Set the window to Fullscreen.
 getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN, WindowManager.LayoutParams.FLAG_FULLSCREEN);
 // Instantiate a PDFViewCtrl object.
 pdfViewCtrl = new PDFViewCtrl(this);
 // Set the associated activity for RMS UI operations.
 pdfViewCtrl.setAttachedActivity(this);
 // Initialize a UIExtensionManager object and set it to PDFViewCtrl.
 uiExtensionsManager = new UIExtensionsManager(this.getApplicationContext(), pdfViewCtrl);
 uiExtensionsManager.setAttachedActivity(this);
 uiExtensionsManager.onCreate(this, pdfViewCtrl, savedInstanceState);
 pdfViewCtrl.setUIExtensionsManager(uiExtensionsManager);
 // Require the authorization of runtime permissions.
 if (Build.VERSION.SDK_INT >= 23) {
 int permission = ContextCompat.checkSelfPermission(this.getApplicationContext(), Manifest.permission.WRITE_EXTERNAL_STORAGE);
 if (permission != PackageManager.PERMISSION_GRANTED) {
 ActivityCompat.requestPermissions(this, PERMISSIONS_STORAGE, REQUEST_EXTERNAL_STORAGE);
 return;
 }
 }
 // Open and Render a PDF document.
 String path = "/mnt/sdcard/input_files/Sample.pdf";
 uiExtensionsManager.openDocument(path, null);
 setContentView(uiExtensionsManager.getContentView());
 }
 @Override
 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
 if (requestCode == 1 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
 // Open and Render a PDF document.
 String path = "/mnt/sdcard/input_files/Sample.pdf";
 uiExtensionsManager.openDocument(path, null);
 setContentView(uiExtensionsManager.getContentView());
 } else {
 super.onRequestPermissionsResult(requestCode, permissions, grantResults);
 }
 }
 @Override
 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 pdfViewCtrl.handleActivityResult(requestCode, resultCode, data);
 }
 @Override
 public void onStart() {
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onStart(this);
 }
 super.onStart();
 }
 @Override
 public void onStop() {
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onStop(this);
 }
 super.onStop();
 }
 @Override
 public void onPause() {
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onPause(this);
 }
 super.onPause();
 }
 @Override
 public void onResume() {
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onResume(this);
 }
 super.onResume();
 }
 @Override
 protected void onDestroy() {
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onDestroy(this);
 }
 super.onDestroy();
 }
 @Override
 public void onConfigurationChanged(Configuration newConfig) {
 super.onConfigurationChanged(newConfig);
 if (uiExtensionsManager != null) {
 uiExtensionsManager.onConfigurationChanged(this, newConfig);
 }
 }
 @Override
 public boolean onKeyDown(int keyCode, KeyEvent event) {
 if (uiExtensionsManager != null && uiExtensionsManager.onKeyDown(this, keyCode, event))
 return true;
 return super.onKeyDown(keyCode, event);
 }
}

Update AndroidManifest.xml

Add “<uses-permission android:name=”android.permission.CAMERA“/>” to grant the project permissions to access the camera.

Add “<uses-permission android:name=”android.permission.RECORD_AUDIO“/>” to grant the project permissions to record audio or video. If you do not add it, the audio and video features will not work correctly.

Add “<uses-permission android:name=”android.permission.SYSTEM_ALERT_WINDOW“/>” to grant your phone the floating window permissions. If you do not add this permission, the Pan and Zoom feature will not be able to work.

Add android:configChanges=”keyboardHidden|orientation|locale|layoutDirection|screenSize”>” property to make sure that the project will only execute the onConfigurationChanged() function without recalling the activity lifecycle when rotating the screen. If you do not add this property, the signature feature will not work correctly.

Update AndroidManifest.xml as follows:

< ?xml version="1.0" encoding="utf-8"?>










Run the project
In this section, we build and run the project on an AVD targeting Android 8.1 (API 27). After building the project and installing APK on the emulator, tap
Allow on the pop-up windows to allow the demo to access files on the device, and then you will see that the “Sample.pdf” document is displayed as shown in Figure 3-9. Up to now, it is a full-featured PDF Reader which includes all of the features in Complete PDF viewer demo. Feel free to try it.

Figure 3-9

Updated on October 16, 2019

Was this article helpful?

Related Articles