Reflow

Reflow requires the full version of PDFTron library. See PDFTron full or standard?

Reflow makes the document more flexible and easier to read, especially on small devices. PDFTron is able to extract the reflowable layout of each page of a PDF document as an HTML file. First, we explain how simple it is to show a widget that allows the user to swipe left or right through the pages of the document to see reflowable document pages. Then, we provide the methods necessary for converting a hard-layout PDF page to an HTML document page.

Showing reflow pager

ReflowControl is a ViewPager that allows the user to flip left and right through the reflowable layout of pages in a certain PDF document.

Implementation

To set up your layout with ReflowControl, add a <ReflowControl> element to your XML layout. For example, if each page in the swipe view should consume the entire layout, then your layout looks like this:

<com.pdftron.pdf.controls.ReflowControl
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/reflow_pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Then, you need to attach a PDFDoc to the reflow pager:

ReflowControl reflowControl = (ReflowControl) findViewById(R.id.reflow_pager);
reflowControl.setup(pdfDoc);

That is everything you need to have a simple reflow pager. Next, we will go through advanced features.

Post-processing color

If you want to map each original color to a new color (for example for handling night mode) you need to pass an OnPostProcessColorListener listener to the ReflowControl.

To do so, you can provide an OnPostProcessColorListener listener when setting up the ReflowControl:

ReflowControl reflowControl = (ReflowControl) findViewById(R.id.reflow_pager);
reflowControl.setup(pdfDoc, mOnPostProcessColorListener);

For example, OnPostProcessColorListener can be defined by PDFViewCtrl as:

private final ReflowControl.OnPostProcessColorListener mOnPostProcessColorListener =
    new ReflowControl.OnPostProcessColorListener() {
        @Override
        public ColorPt getPostProcessedColor(ColorPt cp) {
            if (mPDFViewCtrl != null) {
                return mPDFViewCtrl.getPostProcessedColor(cp);
            }
            return cp;
        }
    };

Alternatively you can set a listener:

ReflowControl reflowControl = (ReflowControl) findViewById(R.id.reflow_pager);
reflowControl.setup(pdfDoc);
reflowControl.setOnPostProcessColorListener(mOnPostProcessColorListener):

Notifying the reflow pager that the document has been modified

To refresh the reflow pager to show the latest changes on your document, you should let the reflow pager know that the document has been modified:

void notifyReflowModified(ReflowControl reflowControl) {
    if (reflowControl != null && reflowControl.isReady()) {
        reflowControl.notifyPagesModified();
    }
}

Setting the text size

It is possible to change the size of reflowable text. The default text size is 100; valid values are 5, 10, 25, 50, 75, 100, 125, 150, 200, 400, 800, and 1600. See the following code as an example

void changeReflowSize(ReflowControl reflowControl, int percent) {
    if (reflowControl != null && reflowControl.isReady()) {
        reflowControl.setTextSizeInPercent(percent);
    }
}

Alternatively, you can zoom in/out to change the reflowable text size:

void zoomReflow(ReflowControl reflowControl, boolean zoomIn) {
    if (reflowControl != null && reflowControl.isReady()) {
        if (zoomIn) {
            reflowControl.zoomIn();
        } else {
            reflowControl.zoomOut();
        }
    }
}

Assuming the current text size is 100%, by calling zoomReflow(reflowControl, true) and zoomReflow(reflowControl, false) the new text size will be 125% and 75% of the original size, respectively.

Setting background color

There are three methods to change the background color:

setDayMode(): no background

setNightMode(): night background

setCustomColorMode(int): customized background

Setting right-to-left direction

You can support right-to-left languages by setting the direction of reflowable text by calling setRightToLeftDirection(isRtlMode)

Generating a reflow page

It is not necessary to use a reflow pager to create a reflowable layout of PDF pages. It is also possible to extract the reflowable layout by creating an HTML file from a certain page of the document using the ReflowProcessor class. The first step is to let the Core know you are going to use reflow by calling initialize(). Please note that this method clears all existing reflowable data. Thus, preferably put this call in your Application or Activity.

When reflow processor has been initialized, it is possible to turn reflow on by calling getReflow(Page, RequestHandler, Object) and passing a RequestHandler callback in order to be notified once the reflowable HTML file is ready::

void getReflowPage(PDFDoc doc, int pageNum) {
    boolean shouldUnlockRead = false;
    try {
        // request for reflow output
        doc.lockRead();
        shouldUnlockRead = true;
        Page page = doc.getPage(pageNum);
        ReflowProcessor.getReflow(page, mRequestHandler, pageNum);
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (shouldUnlockRead) {
            try {
                doc.unlockRead();
            } catch (Exception ignored) {
                e.printStackTrace();
            }
        }
    }
}

RequestHandler mRequestHandler = new RequestHandler(new RequestHandler.RequestHandlerCallback() {
    @Override
    public void RequestHandlerProc(RequestHandler.JobRequestResult result, String outFilename, Object customData) {
        if (result == RequestHandler.JobRequestResult.FINISHED) {
            // int pageNum = (int) customData;
            // A reflowable HTML file with a page number of pageNum is located at outFilename
        }
    }
});

To cancel all reflow requests, call cancelAllRequests().

Finally, if you want to clear all HTML files created in the cache, you may need to call clearCache().