pdf.js/examples
Jonas Jenwald 2ed3591b22 Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called
*This patch is based on something that I noticed while working on PR 10126.*

The recent re-factoring of `PDFFindController` brought many improvements, among those the fact that access to `BaseViewer` is no longer required. However, with these changes there's one thing which now strikes me as not particularly user-friendly[1]: The fact that in order for searching to actually work, `PDFFindController.setDocument` must be called *and* a 'pagesinit' event must be dispatched (from somewhere).

For all other viewer components, calling the `setDocument` method[2] is enough in order for the component to actually be usable.
The `PDFFindController` thus stands out quite a bit, and it also becomes difficult to work with in any sort of custom implementation. For example: Imagine someone trying to use `PDFFindController` separately from the viewer[3], which *should* now be relatively simple given the re-factoring, and thus having to (somehow) figure out that they'll also need to manually dispatch a 'pagesinit' event for searching to work.

Note that the above even affects the unit-tests, where an out-of-place 'pagesinit' event is being used.
To attempt to address these problems, I'm thus suggesting that *only* `setDocument` should be used to indicate that searching may start. For the default viewer and/or the viewer components, `BaseViewer.setDocument` will now call `PDFFindController.setDocument` when the document is ready, thus requiring no outside configuration anymore[4]. For custom implementation, and the unit-tests, it's now as simple as just calling `PDFFindController.setDocument` to allow searching to start.

---
[1] I should have caught this during review of PR 10099, but unfortunately it's sometimes not until you actually work with the code in question that things like these become clear.

[2] Assuming, obviously, that the viewer component in question actually implements such a method :-)

[3] There's even a very recent issue, filed by someone trying to do just that.

[4] Short of providing a `PDFFindController` instance when creating a `BaseViewer` instance, of course.
2018-10-04 10:28:50 +02:00
..
acroforms Rename the globals to shorter names. 2018-03-16 11:08:56 -07:00
browserify Rename the globals to shorter names. 2018-03-16 11:08:56 -07:00
components Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called 2018-10-04 10:28:50 +02:00
image_decoders Add a new parameter to JpegImage.getData to indicate the source of the image data (issue 9513) 2018-09-02 14:15:22 +02:00
learning Fix typos 2018-04-01 23:20:41 +02:00
mobile-viewer Correct the instructions in the README file for examples/mobile-viewer 2018-07-08 15:32:06 +02:00
node Attempt to provide better default values for the disableFontFace/nativeImageDecoderSupport API options in Node.js 2018-06-03 00:28:37 +02:00
svgviewer Use the link service for getting and setting page information 2018-09-30 16:59:46 +02:00
text-only Rename the globals to shorter names. 2018-03-16 11:08:56 -07:00
webpack Upgrade to Webpack 4 2018-06-02 20:28:36 +02:00