Update PdfiumAndroid to 1.3.1

Add method PDFView#getDocumentMeta()
Add method PDFView#getTableOfContents()
Add method Configurator#password(String)
Add horizontal mode to ScrollBar
Block interaction with PDFView when document is not loaded
Fix PDFView exceptions in layout preview
Update README and CHANGELOG
Update version

Author: barteksc

CHANGELOG.md

@@ -0,0 +1,23 @@
+## 1.2.0 (2016-07-11)
+* update PdfiumAndroid to 1.3.1 with support for bookmarks, Table Of Contents and documents with password:
+  * added method `PDFView#getDocumentMeta()`, which returns document metadata
+  * added method `PDFView#getTableOfContents()`, which returns whole tree of bookmarks in PDF document
+  * added method `Configurator#password(String)`
+* added horizontal mode to **ScrollBar** - use `ScrollBar#setHorizontal(true)` or `app:sb_horizontal="true"` in XML
+* block interaction with `PDFView` when document is not loaded - prevent some exceptions
+* fix `PDFView` exceptions in layout preview (edit mode)
+
+## 1.1.2 (2016-06-27)
+* update PdfiumAndroid to 1.1.0, which fixes displaying multiple `PDFView`s at the same time and few errors with loading PDF documents.
+
+## 1.1.1 (2016-06-17)
+* fixes bug with strange behavior when indices passed to `.pages()` don't start with `0`.
+
+## 1.1.0 (2016-06-16)
+* added method `pdfView.fromUri(Uri)` for opening files from content providers
+* updated PdfiumAndroid to 1.0.3, which should fix bug with exception
+* updated sample with demonstration of `fromUri()` method
+* some minor fixes
+
+## 1.0.0 (2016-06-06)
+* Initial release

README.md

@@ -6,15 +6,14 @@ Library for displaying PDF documents on Android, with `animations`, `gestures`,
 It is based on [PdfiumAndroid](https://github.com/barteksc/PdfiumAndroid) for decoding PDF files. Works on API 11 and higher.
 Licensed under Apache License 2.0.
 
-## What's new in 1.1.0?
-* added method `pdfView.fromUri(Uri)` for opening files from content providers
-* updated PdfiumAndroid to 1.0.3, which should fix bug with exception
-* updated sample with demonstration of `fromUri()` method
-* some minor fixes
-
-Version 1.1.1 fixes bug with strange behavior when indices passed to `.pages()` don't start with `0`.
-
-Version 1.1.2 updates PdfiumAndroid to 1.1.0, which fixes displaying multiple `PDFView`s at the same time and few errors with loading PDF documents.
+## What's new in 1.2.0?
+* update PdfiumAndroid to 1.3.1 with support for bookmarks, Table Of Contents and documents with password:
+  * added method `PDFView#getDocumentMeta()`, which returns document metadata
+  * added method `PDFView#getTableOfContents()`, which returns whole tree of bookmarks in PDF document
+  * added method `Configurator#password(String)`
+* added horizontal mode to **ScrollBar** - use `ScrollBar#setHorizontal(true)` or `app:sb_horizontal="true"` in XML
+* block interaction with `PDFView` when document is not loaded - prevent some exceptions
+* fix `PDFView` exceptions in layout preview (edit mode)
 
 Next release is coming soon, it will introduce continuous scroll through whole document
 and some incompatibilities with current API (only few small).
@@ -23,7 +22,7 @@ and some incompatibilities with current API (only few small).
 
 Add to _build.gradle_:
 
-`compile 'com.github.barteksc:android-pdf-viewer:1.1.2'`
+`compile 'com.github.barteksc:android-pdf-viewer:1.2.0'`
 
 Library is available in jcenter repository, probably it'll be in Maven Central soon.
 
@@ -40,8 +39,12 @@ Library is available in jcenter repository, probably it'll be in Maven Central s
 
 All available options with default values:
 ``` java
-pdfView.fromAsset(pdfName)
-    .pages(0, 2, 1, 3, 3, 3) //all pages are displayed by default
+pdfView.fromUri(Uri)
+or
+pdfView.fromFile(File)
+or
+pdfView.fromAsset(String)
+    .pages(0, 2, 1, 3, 3, 3) // all pages are displayed by default
     .enableSwipe(true)
     .enableDoubletap(true)
     .swipeVertical(false)
@@ -51,6 +54,7 @@ pdfView.fromAsset(pdfName)
     .onLoad(onLoadCompleteListener)
     .onPageChange(onPageChangeListener)
     .onError(onErrorListener)
+    .password(null)
     .load();
 ```
 
@@ -62,8 +66,9 @@ pdfView.fromAsset(pdfName)
 
 Use **ScrollBar** class to place scrollbar view near **PDFView**
 
-1. in layout XML (it's important that the parent view is **RelativeLayout**)
+1. in layout XML (it's important that the parent view is **RelativeLayout**):
 
+    Vertically:
     ``` xml
     <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
         android:layout_width="match_parent"
@@ -84,6 +89,27 @@ Use **ScrollBar** class to place scrollbar view near **PDFView**
 
     </RelativeLayout>
     ```
+    Horizontally:
+    ``` xml
+    <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    	android:layout_width="match_parent"
+    	android:layout_height="match_parent"
+    	xmlns:app="http://schemas.android.com/apk/res-auto">
+
+        <com.github.barteksc.pdfviewer.PDFView
+            android:id="@+id/pdfView"
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"/>
+
+    	<com.github.barteksc.pdfviewer.ScrollBar
+    		android:id="@+id/scrollBar"
+    		android:layout_width="match_parent"
+    		android:layout_height="wrap_content"
+    		app:sb_horizontal="true"
+    		android:layout_alignParentBottom="true" />
+
+    </RelativeLayout>
+    ```
 2. in activity or fragment
     ``` java
 
@@ -97,9 +123,11 @@ Use **ScrollBar** class to place scrollbar view near **PDFView**
             ScrollBar scrollBar = (ScrollBar) findViewById(R.id.scrollBar);
             pdfView.setScrollBar(scrollBar);
         }
-
     ```
 
+    `scrollBar.setHorizontal(true);` or `app:sb_horizontal="true"` may be used to set **ScrollBar** in horizontal mode.
+
+
 Scrollbar styling:
 ``` xml
     <com.github.barteksc.pdfviewpager.view.ScrollBar
@@ -108,12 +136,13 @@ Scrollbar styling:
         app:sb_handlerColor="..." <!-- scrollbar handler color -->
         app:sb_indicatorColor="..." <!-- background color of current page indicator -->
         app:sb_indicatorTextColor="..." <!-- text color of current page indicator -->
+        app:sb_horizontal="true|false|reference" <!-- whether to set horizontal mode -->
         android:background="..." <!-- scrollbar background -->
         />
 ```
 
 **ScrollBarPageIndicator** is added to scrollbar automatically and is shown while dragging scrollbar handler,
- displaying number of page on current position.
+ displaying number of page on current position. Its position is automatically calculated based on **ScrollBar**'s position.
 
 ## Additional options
 

android-pdf-viewer/build.gradle

@@ -13,7 +13,7 @@ ext {
     siteUrl = 'https://github.com/barteksc/AndroidPdfViewer'
     gitUrl = 'https://github.com/barteksc/AndroidPdfViewer.git'
 
-    libraryVersion = '1.1.2'
+    libraryVersion = '1.2.0'
 
     developerId = 'barteksc'
     developerName = 'Bartosz Schiller'
@@ -32,13 +32,13 @@ android {
         minSdkVersion 11
         targetSdkVersion 23
         versionCode 1
-        versionName "1.1.2"
+        versionName "1.2.0"
     }
 
 }
 
 dependencies {
-    compile 'com.github.barteksc:pdfium-android:1.1.0'
+    compile 'com.github.barteksc:pdfium-android:1.3.1'
 }
 
 apply from: 'https://raw.githubusercontent.com/nuuneoi/JCenter/master/installv1.gradle'

android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/DecodingAsyncTask.java

@@ -40,11 +40,13 @@ class DecodingAsyncTask extends AsyncTask<Void, Void, Throwable> {
     private Context context;
     private PdfiumCore pdfiumCore;
     private PdfDocument pdfDocument;
+    private String password;
 
-    public DecodingAsyncTask(String path, boolean isAsset, PDFView pdfView, PdfiumCore pdfiumCore) {
+    public DecodingAsyncTask(String path, boolean isAsset, String password, PDFView pdfView, PdfiumCore pdfiumCore) {
         this.cancelled = false;
         this.pdfView = pdfView;
         this.isAsset = isAsset;
+        this.password = password;
         this.pdfiumCore = pdfiumCore;
         this.path = path;
         context = pdfView.getContext();
@@ -56,7 +58,7 @@ protected Throwable doInBackground(Void... params) {
             if (isAsset) {
                 path = FileUtils.fileFromAsset(context, path).getAbsolutePath();
             }
-            pdfDocument = pdfiumCore.newDocument(getSeekableFileDescriptor(path));
+            pdfDocument = pdfiumCore.newDocument(getSeekableFileDescriptor(path), password);
             return null;
         } catch (Throwable t) {
             return t;

android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PDFView.java

@@ -65,7 +65,7 @@
  * - DocumentPage = A page of the PDF document.
  * - UserPage = A page as defined by the user.
  * By default, they're the same. But the user can change the pages order
- * using {@link #load(String, boolean, OnLoadCompleteListener, OnErrorListener, int[])}. In this
+ * using {@link #load(String, boolean, String, OnLoadCompleteListener, OnErrorListener, int[])}. In this
  * particular case, a userPage of 5 can refer to a documentPage of 17.
  */
 public class PDFView extends SurfaceView {
@@ -275,6 +275,11 @@ public class PDFView extends SurfaceView {
      */
     public PDFView(Context context, AttributeSet set) {
         super(context, set);
+
+        if(isInEditMode()) {
+            return;
+        }
+
         miniMapRequired = false;
         cacheManager = new CacheManager();
         animationManager = new AnimationManager(this);
@@ -299,11 +304,11 @@ public PDFView(Context context, AttributeSet set) {
         pdfiumCore = new PdfiumCore(context);
     }
 
-    private void load(String path, boolean isAsset, OnLoadCompleteListener listener, OnErrorListener onErrorListener) {
-        load(path, isAsset, listener, onErrorListener, null);
+    private void load(String path, boolean isAsset, String password, OnLoadCompleteListener listener, OnErrorListener onErrorListener) {
+        load(path, isAsset, password, listener, onErrorListener, null);
     }
 
-    private void load(String path, boolean isAsset, OnLoadCompleteListener onLoadCompleteListener, OnErrorListener onErrorListener, int[] userPages) {
+    private void load(String path, boolean isAsset, String password, OnLoadCompleteListener onLoadCompleteListener, OnErrorListener onErrorListener, int[] userPages) {
 
         if (!recycled) {
             throw new IllegalStateException("Don't call load on a PDF View without recycling it first.");
@@ -319,11 +324,11 @@ private void load(String path, boolean isAsset, OnLoadCompleteListener onLoadCom
         this.onLoadCompleteListener = onLoadCompleteListener;
         this.onErrorListener = onErrorListener;
 
+        recycled = false;
         // Start decoding document
-        decodingAsyncTask = new DecodingAsyncTask(path, isAsset, this, pdfiumCore);
+        decodingAsyncTask = new DecodingAsyncTask(path, isAsset, password, this, pdfiumCore);
         decodingAsyncTask.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
 
-
     }
 
     /**
@@ -336,6 +341,9 @@ public void jumpTo(int page) {
     }
 
     void showPage(int pageNb) {
+        if(recycled) {
+            return;
+        }
         state = State.SHOWN;
 
         // Check the page number and makes the
@@ -421,6 +429,10 @@ public void recycle() {
         state = State.DEFAULT;
     }
 
+    public boolean isRecycled() {
+        return recycled;
+    }
+
     @Override
     protected void onDetachedFromWindow() {
         recycle();
@@ -429,6 +441,9 @@ protected void onDetachedFromWindow() {
 
     @Override
     protected void onSizeChanged(int w, int h, int oldw, int oldh) {
+        if(isInEditMode()) {
+            return;
+        }
         animationManager.stopAll();
         calculateOptimalWidthAndHeight();
         loadPages();
@@ -475,6 +490,10 @@ protected void onDraw(Canvas canvas) {
         // Draws background
         canvas.drawColor(Color.WHITE);
 
+        if(recycled) {
+            return;
+        }
+
         if (state != State.SHOWN) {
             return;
         }
@@ -795,6 +814,8 @@ public void loadComplete(PdfDocument pdfDocument) {
     }
 
     public void loadError(Throwable t) {
+        recycle();
+        invalidate();
         if (this.onErrorListener != null) {
             this.onErrorListener.onError(t);
         } else {
@@ -1153,6 +1174,20 @@ public void useBestQuality(boolean bestQuality) {
         this.bestQuality = bestQuality;
     }
 
+    public PdfDocument.Meta getDocumentMeta() {
+        if(pdfDocument == null) {
+            return null;
+        }
+        return pdfiumCore.getDocumentMeta(pdfDocument);
+    }
+
+    public List<PdfDocument.Bookmark> getTableOfContents() {
+        if(pdfDocument == null) {
+            return new ArrayList<>();
+        }
+        return pdfiumCore.getTableOfContents(pdfDocument);
+    }
+
     /**
      * Use an asset file as the pdf source
      */
@@ -1223,6 +1258,8 @@ public class Configurator {
 
         private int maskAlpha = Constants.MASK_ALPHA;
 
+        private String password = null;
+
         private Configurator(String path, boolean isAsset) {
             this.path = path;
             this.isAsset = isAsset;
@@ -1273,6 +1310,11 @@ public Configurator swipeVertical(boolean swipeVertical) {
             return this;
         }
 
+        public Configurator password(String password) {
+            this.password = password;
+            return this;
+        }
+
         /**
          * @param maskColor - mask color (default Color.BLACK)
          * @param maskAlpha - alpha value in [0,255] (default 20)
@@ -1298,9 +1340,9 @@ public void load() {
             PDFView.this.maskPaint.setColor(maskColor);
             PDFView.this.maskPaint.setAlpha(maskAlpha);
             if (pageNumbers != null) {
-                PDFView.this.load(path, isAsset, onLoadCompleteListener, onErrorListener, pageNumbers);
+                PDFView.this.load(path, isAsset, password, onLoadCompleteListener, onErrorListener, pageNumbers);
             } else {
-                PDFView.this.load(path, isAsset, onLoadCompleteListener, onErrorListener);
+                PDFView.this.load(path, isAsset, password, onLoadCompleteListener, onErrorListener);
             }
         }