-
Notifications
You must be signed in to change notification settings - Fork 101
/
Copy pathreader_view.js
1806 lines (1435 loc) · 57.5 KB
/
reader_view.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Created by Boris Schneiderman.
// Modified by Daniel Weck
// Copyright (c) 2014 Readium Foundation and/or its licensees. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 1. Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or
// other materials provided with the distribution.
// 3. Neither the name of the organization nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
define(["../globals", "jquery", "underscore", "eventEmitter", "./fixed_view", "../helpers", "./iframe_loader", "./internal_links_support",
"./media_overlay_data_injector", "./media_overlay_player", "../models/package", "../models/metadata", "../models/page_open_request",
"./reflowable_view", "./scroll_view", "../models/style_collection", "../models/switches", "../models/trigger",
"../models/viewer_settings", "../models/bookmark_data", "../models/node_range_info", "./external_agent_support"],
function (Globals, $, _, EventEmitter, FixedView, Helpers, IFrameLoader, InternalLinksSupport,
MediaOverlayDataInjector, MediaOverlayPlayer, Package, Metadata, PageOpenRequest,
ReflowableView, ScrollView, StyleCollection, Switches, Trigger,
ViewerSettings, BookmarkData, NodeRangeInfo, ExternalAgentSupport) {
/**
* Options passed on the reader from the readium loader/initializer
*
* @typedef {object} Globals.Views.ReaderView.ReaderOptions
* @property {jQueryElement|string} el The element the reader view should create itself in. Can be a jquery wrapped element or a query selector.
* @property {Globals.Views.IFrameLoader} iframeLoader An instance of an iframe loader or one expanding it.
* @property {boolean} needsFixedLayoutScalerWorkAround
*/
/**
* Top level View object. Interface for view manipulation public APIs
* @param {Views.ReaderView.ReaderOptions} options
* @constructor
*/
var ReaderView = function (options) {
$.extend(this, new EventEmitter());
var self = this;
var _currentView = undefined;
var _package = undefined;
var _metadata = undefined;
var _spine = undefined;
var _viewerSettings = new ViewerSettings({});
//styles applied to the container divs
var _userStyles = new StyleCollection();
//styles applied to the content documents
var _bookStyles = new StyleCollection();
var _internalLinksSupport = new InternalLinksSupport(this);
var _externalAgentSupport = new ExternalAgentSupport(this);
var _mediaOverlayPlayer;
var _mediaOverlayDataInjector;
var _iframeLoader;
var _$el;
//We will call onViewportResize after user stopped resizing window
var lazyResize = Helpers.extendedThrottle(
handleViewportResizeStart,
handleViewportResizeTick,
handleViewportResizeEnd, 250, 1000, self);
$(window).on("resize.ReadiumSDK.readerView", lazyResize);
this.fonts = options.fonts;
if (options.el instanceof $) {
_$el = options.el;
console.log("** EL is a jQuery selector:" + options.el.attr('id'));
} else {
_$el = $(options.el);
console.log("** EL is a string:" + _$el.attr('id'));
}
if (options.iframeLoader) {
_iframeLoader = options.iframeLoader;
}
else {
_iframeLoader = new IFrameLoader({mathJaxUrl: options.mathJaxUrl});
}
_needsFixedLayoutScalerWorkAround = options.needsFixedLayoutScalerWorkAround;
/**
* @returns {boolean}
*/
this.needsFixedLayoutScalerWorkAround = function () {
return _needsFixedLayoutScalerWorkAround;
};
/**
* Create a view based on the given view type.
* @param {Views.ReaderView.ViewType} viewType
* @param {Views.ReaderView.ViewCreationOptions} options
* @returns {*}
*/
this.createViewForType = function (viewType, options) {
var createdView;
// NOTE: _$el == options.$viewport
_$el.css("overflow", "hidden");
switch (viewType) {
case ReaderView.VIEW_TYPE_FIXED:
_$el.css("overflow", "auto"); // for content pan, see self.setZoom()
createdView = new FixedView(options, self);
break;
case ReaderView.VIEW_TYPE_SCROLLED_DOC:
createdView = new ScrollView(options, false, self);
break;
case ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS:
createdView = new ScrollView(options, true, self);
break;
default:
createdView = new ReflowableView(options, self);
break;
}
return createdView;
};
/**
* Returns the current view type of the reader view
* @returns {ReaderView.ViewType}
*/
this.getCurrentViewType = function () {
if (!_currentView) {
return undefined;
}
if (_currentView instanceof ReflowableView) {
return ReaderView.VIEW_TYPE_COLUMNIZED;
}
if (_currentView instanceof FixedView) {
return ReaderView.VIEW_TYPE_FIXED;
}
if (_currentView instanceof ScrollView) {
if (_currentView.isContinuousScroll()) {
return ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS;
}
return ReaderView.VIEW_TYPE_SCROLLED_DOC;
}
console.error("Unrecognized view type");
return undefined;
};
this.getCurrentView = function () {
return _currentView;
};
//based on https://docs.google.com/spreadsheet/ccc?key=0AoPMUkQhc4wcdDI0anFvWm96N0xRT184ZE96MXFRdFE&usp=drive_web#gid=0 document
function deduceDesiredViewType(spineItem) {
//check settings
if (_viewerSettings.scroll == "scroll-doc") {
return ReaderView.VIEW_TYPE_SCROLLED_DOC;
}
if (_viewerSettings.scroll == "scroll-continuous") {
return ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS;
}
//is fixed layout ignore flow
if (spineItem.isFixedLayout()) {
return ReaderView.VIEW_TYPE_FIXED;
}
//flow
if (spineItem.isFlowScrolledDoc()) {
return ReaderView.VIEW_TYPE_SCROLLED_DOC;
}
if (spineItem.isFlowScrolledContinuous()) {
return ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS;
}
return ReaderView.VIEW_TYPE_COLUMNIZED;
}
// returns true is view changed
function initViewForItem(spineItem, callback) {
var desiredViewType = deduceDesiredViewType(spineItem);
if (_currentView) {
if (self.getCurrentViewType() == desiredViewType) {
callback(false);
return;
}
resetCurrentView();
}
/**
* View creation options
* @typedef {object} Globals.Views.ReaderView.ViewCreationOptions
* @property {jQueryElement} $viewport The view port element the reader view has created.
* @property {Globals.Models.Spine} spine The spine item collection object
* @property {Globals.Collections.StyleCollection} userStyles User styles
* @property {Globals.Collections.StyleCollection} bookStyles Book styles
* @property {Globals.Views.IFrameLoader} iframeLoader An instance of an iframe loader or one expanding it.
*/
var viewCreationParams = {
$viewport: _$el,
spine: _spine,
userStyles: _userStyles,
bookStyles: _bookStyles,
iframeLoader: _iframeLoader
};
_currentView = self.createViewForType(desiredViewType, viewCreationParams);
Globals.logEvent("READER_VIEW_CREATED", "EMIT", "reader_view.js");
self.emit(Globals.Events.READER_VIEW_CREATED, desiredViewType);
_currentView.on(Globals.Events.CONTENT_DOCUMENT_LOADED, function ($iframe, spineItem) {
var contentDoc = $iframe[0].contentDocument;
Globals.logEvent("CONTENT_DOCUMENT_LOADED", "ON", "reader_view.js (current view) [ " + spineItem.href + " ]");
if (!Helpers.isIframeAlive($iframe[0])) return;
// performance degrades with large DOM (e.g. word-level text-audio sync)
_mediaOverlayDataInjector.attachMediaOverlayData($iframe, spineItem, _viewerSettings);
_internalLinksSupport.processLinkElements($iframe, spineItem);
_externalAgentSupport.bindToContentDocument(contentDoc, spineItem);
Trigger.register(contentDoc);
Switches.apply(contentDoc);
Globals.logEvent("CONTENT_DOCUMENT_LOADED", "EMIT", "reader_view.js [ " + spineItem.href + " ]");
self.emit(Globals.Events.CONTENT_DOCUMENT_LOADED, $iframe, spineItem);
});
_currentView.on(Globals.Events.CONTENT_DOCUMENT_LOAD_START, function ($iframe, spineItem) {
Globals.logEvent("CONTENT_DOCUMENT_LOAD_START", "EMIT", "reader_view.js [ " + spineItem.href + " ]");
self.emit(Globals.Events.CONTENT_DOCUMENT_LOAD_START, $iframe, spineItem);
});
_currentView.on(Globals.Events.CONTENT_DOCUMENT_UNLOADED, function ($iframe, spineItem) {
Globals.logEvent("CONTENT_DOCUMENT_UNLOADED", "EMIT", "reader_view.js [ " + spineItem.href + " ]");
self.emit(Globals.Events.CONTENT_DOCUMENT_UNLOADED, $iframe, spineItem);
});
_currentView.on(Globals.InternalEvents.CURRENT_VIEW_PAGINATION_CHANGED, function (pageChangeData) {
Globals.logEvent("InternalEvents.CURRENT_VIEW_PAGINATION_CHANGED", "ON", "reader_view.js");
//we call on onPageChanged explicitly instead of subscribing to the Globals.Events.PAGINATION_CHANGED by
//mediaOverlayPlayer because we hve to guarantee that mediaOverlayPlayer will be updated before the host
//application will be notified by the same Globals.Events.PAGINATION_CHANGED event
_mediaOverlayPlayer.onPageChanged(pageChangeData);
_.defer(function () {
Globals.logEvent("PAGINATION_CHANGED", "EMIT", "reader_view.js");
self.emit(Globals.Events.PAGINATION_CHANGED, pageChangeData);
if (!pageChangeData.spineItem) return;
_.defer(function () {
_externalAgentSupport.updateContentDocument(pageChangeData.spineItem);
});
});
});
_currentView.on(Globals.Events.FXL_VIEW_RESIZED, function () {
Globals.logEvent("FXL_VIEW_RESIZED", "EMIT", "reader_view.js");
self.emit(Globals.Events.FXL_VIEW_RESIZED);
})
_currentView.render();
var docWillChange = true;
_currentView.setViewSettings(_viewerSettings, docWillChange);
// we do this to wait until elements are rendered otherwise book is not able to determine view size.
setTimeout(function () {
callback(true);
}, 50);
}
/**
* Returns a list of the currently active spine items
*
* @returns {Models.SpineItem[]}
*/
this.getLoadedSpineItems = function () {
if (_currentView) {
return _currentView.getLoadedSpineItems();
}
return [];
};
function resetCurrentView() {
if (!_currentView) {
return;
}
Globals.logEvent("READER_VIEW_DESTROYED", "EMIT", "reader_view.js");
self.emit(Globals.Events.READER_VIEW_DESTROYED);
Globals.logEvent("InternalEvents.CURRENT_VIEW_PAGINATION_CHANGED", "OFF", "reader_view.js");
_currentView.off(Globals.InternalEvents.CURRENT_VIEW_PAGINATION_CHANGED);
_currentView.remove();
_currentView = undefined;
}
/**
* Returns the currently instanced viewer settings
*
* @returns {Models.ViewerSettings}
*/
this.viewerSettings = function () {
return _viewerSettings;
};
/**
* Returns a data object based on the package document
*
* @returns {Models.Package}
*/
this.package = function () {
return _package;
};
/**
* Returns a data object based on the package document metadata
*
* @returns {Models.Metadata}
*/
this.metadata = function () {
return _metadata;
};
/**
* Returns a representation of the spine as a data object, also acts as list of spine items
*
* @returns {Models.Spine}
*/
this.spine = function () {
return _spine;
};
/**
* Returns the user CSS styles collection
*
* @returns {Collections.StyleCollection}
*/
this.userStyles = function () {
return _userStyles;
};
/**
* Open Book Data
*
* @typedef {object} Globals.Views.ReaderView.OpenBookData
* @property {Globals.Models.Package} package - packageData (required)
* @property {Globals.Models.PageOpenRequest} openPageRequest - openPageRequestData, (optional) data related to open page request
* @property {Globals.Views.ReaderView.SettingsData} [settings]
* @property {Globals.Collections.StyleCollection} styles: [cssStyles]
* @todo Define missing types
*/
/**
* Triggers the process of opening the book and requesting resources specified in the packageData
*
* @param {Views.ReaderView.OpenBookData} openBookData Open book data object
*/
this.openBook = function (openBookData) {
var packageData = openBookData.package ? openBookData.package : openBookData;
_package = new Package(packageData);
_metadata = new Metadata(packageData.metadata);
_spine = _package.spine;
_spine.handleLinear(true);
if (_mediaOverlayPlayer) {
_mediaOverlayPlayer.reset();
}
_mediaOverlayPlayer = new MediaOverlayPlayer(self, $.proxy(onMediaPlayerStatusChanged, self));
_mediaOverlayPlayer.setAutomaticNextSmil(_viewerSettings.mediaOverlaysAutomaticPageTurn ? true : false); // just to ensure the internal var is set to the default settings (user settings are applied below at self.updateSettings(openBookData.settings);)
_mediaOverlayDataInjector = new MediaOverlayDataInjector(_package.media_overlay, _mediaOverlayPlayer);
resetCurrentView();
if (openBookData.settings) {
self.updateSettings(openBookData.settings);
}
if (openBookData.styles) {
self.setStyles(openBookData.styles);
}
var pageRequestData = undefined;
if (openBookData.openPageRequest && typeof(openBookData.openPageRequest) === 'function') {
openBookData.openPageRequest = openBookData.openPageRequest();
}
if (openBookData.openPageRequest) {
if (openBookData.openPageRequest.idref || (openBookData.openPageRequest.contentRefUrl && openBookData.openPageRequest.sourceFileHref)) {
pageRequestData = openBookData.openPageRequest;
}
else {
console.log("Invalid page request data: idref required!");
}
}
var fallback = false;
if (pageRequestData) {
pageRequestData = openBookData.openPageRequest;
try {
if (pageRequestData.idref) {
if (pageRequestData.spineItemPageIndex) {
fallback = !self.openSpineItemPage(pageRequestData.idref, pageRequestData.spineItemPageIndex, self);
}
else if (pageRequestData.elementCfi) {
fallback = !self.openSpineItemElementCfi(pageRequestData.idref, pageRequestData.elementCfi, self);
}
else {
fallback = !self.openSpineItemPage(pageRequestData.idref, 0, self);
}
}
else {
fallback = !self.openContentUrl(pageRequestData.contentRefUrl, pageRequestData.sourceFileHref, self);
}
} catch (err) {
console.error("openPageRequest fail: fallback to first page!")
console.log(err);
fallback = true;
}
}
else {
fallback = true;
}
if (fallback) {// if we where not asked to open specific page we will open the first one
var spineItem = _spine.first();
if (spineItem) {
var pageOpenRequest = new PageOpenRequest(spineItem, self);
pageOpenRequest.setFirstPage();
openPage(pageOpenRequest, 0);
}
}
};
function onMediaPlayerStatusChanged(status) {
Globals.logEvent("MEDIA_OVERLAY_STATUS_CHANGED", "EMIT", "reader_view.js (via MediaOverlayPlayer + AudioPlayer)");
self.emit(Globals.Events.MEDIA_OVERLAY_STATUS_CHANGED, status);
}
/**
* Flips the page from left to right.
* Takes to account the page progression direction to decide to flip to prev or next page.
*/
this.openPageLeft = function () {
if (_package.spine.isLeftToRight()) {
self.openPagePrev();
}
else {
self.openPageNext();
}
};
/**
* Flips the page from right to left.
* Takes to account the page progression direction to decide to flip to prev or next page.
*/
this.openPageRight = function () {
if (_package.spine.isLeftToRight()) {
self.openPageNext();
}
else {
self.openPagePrev();
}
};
/**
* Returns if the current child view is an instance of a fixed page view
*
* @returns {boolean}
*/
this.isCurrentViewFixedLayout = function () {
return _currentView instanceof FixedView;
};
/**
* Zoom options
*
* @typedef {object} Globals.Views.ReaderView.ZoomOptions
* @property {string} style - "user"|"fit-screen"|"fit-width"
* @property {number} scale - 0.0 to 1.0
*/
/**
* Set the zoom options.
*
* @param {Views.ReaderView.ZoomOptions} zoom Zoom options
*/
this.setZoom = function (zoom) {
// zoom only handled by fixed layout views
if (self.isCurrentViewFixedLayout()) {
_currentView.setZoom(zoom);
}
};
/**
* Returns the current view scale as a percentage
*
* @returns {number}
*/
this.getViewScale = function () {
if (self.isCurrentViewFixedLayout()) {
return 100 * _currentView.getViewScale();
}
else {
return 100;
}
};
/**
* Settings Data
*
* @typedef {object} Globals.Views.ReaderView.SettingsData
* @property {number} fontSize - Font size as percentage
* @property {number} fontSelection - Font selection as the number in the list of possible fonts, where 0 is special meaning default.
* @property {(string|boolean)} syntheticSpread - "auto"|"single"|"double"
* @property {(string|boolean)} scroll - "auto"|true|false
* @property {boolean} doNotUpdateView - Indicates whether the view should be updated after the settings are applied
* @property {boolean} mediaOverlaysEnableClick - Indicates whether media overlays are interactive on mouse clicks
*/
/**
* Updates reader view based on the settings specified in settingsData object
*
* @param {Globals.Views.ReaderView.SettingsData} settingsData Settings data
* @fires Globals.Events.SETTINGS_APPLIED
*/
this.updateSettings = function (settingsData) {
//console.debug("UpdateSettings: " + JSON.stringify(settingsData));
_viewerSettings.update(settingsData);
if (_mediaOverlayPlayer) {
_mediaOverlayPlayer.setAutomaticNextSmil(_viewerSettings.mediaOverlaysAutomaticPageTurn ? true : false);
}
if (_currentView && !settingsData.doNotUpdateView) {
var bookMark = _currentView.bookmarkCurrentPage();
if (bookMark && bookMark.idref) {
var wasPlaying = false;
if (_currentView.isReflowable && _currentView.isReflowable()) {
wasPlaying = self.isPlayingMediaOverlay();
if (wasPlaying) {
self.pauseMediaOverlay();
}
}
var spineItem = _spine.getItemById(bookMark.idref);
initViewForItem(spineItem, function (isViewChanged) {
if (!isViewChanged) {
var docWillChange = false;
_currentView.setViewSettings(_viewerSettings, docWillChange);
}
self.once(ReadiumSDK.Events.PAGINATION_CHANGED, function (pageChangeData)
{
var cfi = new BookmarkData(bookMark.idref, bookMark.contentCFI);
self.debugBookmarkData(cfi);
});
self.openSpineItemElementCfi(bookMark.idref, bookMark.contentCFI, self);
if (wasPlaying) {
self.playMediaOverlay();
// setTimeout(function()
// {
// }, 60);
}
Globals.logEvent("SETTINGS_APPLIED 1 (view update)", "EMIT", "reader_view.js");
self.emit(Globals.Events.SETTINGS_APPLIED);
});
return;
}
}
Globals.logEvent("SETTINGS_APPLIED 2 (no view update)", "EMIT", "reader_view.js");
self.emit(Globals.Events.SETTINGS_APPLIED);
};
/**
* Opens the next page.
*/
this.openPageNext = function () {
if (self.getCurrentViewType() === ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS) {
_currentView.openPageNext(self);
return;
}
var paginationInfo = _currentView.getPaginationInfo();
if (paginationInfo.openPages.length == 0) {
return;
}
var lastOpenPage = paginationInfo.openPages[paginationInfo.openPages.length - 1];
if (lastOpenPage.spineItemPageIndex < lastOpenPage.spineItemPageCount - 1) {
_currentView.openPageNext(self);
return;
}
var currentSpineItem = _spine.getItemById(lastOpenPage.idref);
var nextSpineItem = _spine.nextItem(currentSpineItem);
if (!nextSpineItem) {
return;
}
var openPageRequest = new PageOpenRequest(nextSpineItem, self);
openPageRequest.setFirstPage();
openPage(openPageRequest, 2);
};
/**
* Opens the previous page.
*/
this.openPagePrev = function () {
if (self.getCurrentViewType() === ReaderView.VIEW_TYPE_SCROLLED_CONTINUOUS) {
_currentView.openPagePrev(self);
return;
}
var paginationInfo = _currentView.getPaginationInfo();
if (paginationInfo.openPages.length == 0) {
return;
}
var firstOpenPage = paginationInfo.openPages[0];
if (firstOpenPage.spineItemPageIndex > 0) {
_currentView.openPagePrev(self);
return;
}
var currentSpineItem = _spine.getItemById(firstOpenPage.idref);
var prevSpineItem = _spine.prevItem(currentSpineItem);
if (!prevSpineItem) {
return;
}
var openPageRequest = new PageOpenRequest(prevSpineItem, self);
openPageRequest.setLastPage();
openPage(openPageRequest, 1);
};
function getSpineItem(idref) {
if (!idref) {
console.log("idref parameter value missing!");
return undefined;
}
var spineItem = _spine.getItemById(idref);
if (!spineItem) {
console.log("Spine item with id " + idref + " not found!");
return undefined;
}
return spineItem;
}
/**
* Opens the page of the spine item with element with provided cfi
*
* @param {string} idref Id of the spine item
* @param {string} elementCfi CFI of the element to be shown
* @param {object} initiator optional
*/
this.openSpineItemElementCfi = function (idref, elementCfi, initiator) {
var spineItem = getSpineItem(idref);
if (!spineItem) {
return false;
}
var pageData = new PageOpenRequest(spineItem, initiator);
if (elementCfi) {
pageData.setElementCfi(elementCfi);
}
openPage(pageData, 0);
return true;
};
/**
* Opens specified page index of the current spine item
*
* @param {number} pageIndex Zero based index of the page in the current spine item
* @param {object} initiator optional
*/
this.openPageIndex = function (pageIndex, initiator) {
if (!_currentView) {
return false;
}
var pageRequest;
if (_package.isFixedLayout()) {
var spineItem = _spine.items[pageIndex];
if (!spineItem) {
return false;
}
pageRequest = new PageOpenRequest(spineItem, initiator);
pageRequest.setPageIndex(0);
}
else {
var spineItems = this.getLoadedSpineItems();
if (spineItems.length > 0) {
pageRequest = new PageOpenRequest(spineItems[0], initiator);
pageRequest.setPageIndex(pageIndex);
}
}
openPage(pageRequest, 0);
return true;
};
// dir: 0 => new or same page, 1 => previous, 2 => next
function openPage(pageRequest, dir) {
initViewForItem(pageRequest.spineItem, function (isViewChanged) {
if (!isViewChanged) {
var docWillChange = true;
_currentView.setViewSettings(_viewerSettings, docWillChange);
}
_currentView.openPage(pageRequest, dir);
});
}
/**
* Opens page index of the spine item with idref provided
*
* @param {string} idref Id of the spine item
* @param {number} pageIndex Zero based index of the page in the spine item
* @param {object} initiator optional
*/
this.openSpineItemPage = function (idref, pageIndex, initiator) {
var spineItem = getSpineItem(idref);
if (!spineItem) {
return false;
}
var pageData = new PageOpenRequest(spineItem, initiator);
if (pageIndex) {
pageData.setPageIndex(pageIndex);
}
openPage(pageData, 0);
return true;
};
/**
* Set CSS Styles to the reader container
*
* @param {Collections.StyleCollection} styles Style collection containing selector property and declarations object
* @param {boolean} doNotUpdateView Whether to update the view after the styles are applied.
*/
this.setStyles = function (styles, doNotUpdateView) {
var count = styles.length;
for (var i = 0; i < count; i++) {
if (styles[i].declarations) {
_userStyles.addStyle(styles[i].selector, styles[i].declarations);
}
else {
_userStyles.removeStyle(styles[i].selector);
}
}
applyStyles(doNotUpdateView);
};
/**
* Set CSS Styles to the content documents
*
* @param {Collections.StyleCollection} styles Style collection containing selector property and declarations object
*/
this.setBookStyles = function (styles) {
var count = styles.length;
for (var i = 0; i < count; i++) {
if (styles[i].declarations) {
_bookStyles.addStyle(styles[i].selector, styles[i].declarations);
}
else {
_bookStyles.removeStyle(styles[i].selector);
}
}
if (_currentView) {
_currentView.applyBookStyles();
}
};
/**
* Gets an element from active content documents based on a query selector.
*
* @param {Models.SpineItem} spineItem The spine item object associated with an active content document
* @param {string} selector The query selector
* @returns {HTMLElement|undefined}
*/
this.getElement = function (spineItemIdref, selector) {
if (_currentView) {
return _currentView.getElement(spineItemIdref, selector);
}
return undefined;
};
/**
* Gets an element from active content documents based on an element id.
*
* @param {string} spineItemIdref The spine item idref associated with an active content document
* @param {string} id The element id
* @returns {HTMLElement|undefined}
*/
this.getElementById = function (spineItemIdref, id) {
if (_currentView) {
return _currentView.getElementById(spineItemIdref, id);
}
return undefined;
};
/**
* Gets an element from active content documents based on a content CFI.
*
* @param {string} spineItemIdref The spine item idref associated with an active content document
* @param {string} cfi The partial content CFI
* @param {string[]} [classBlacklist]
* @param {string[]} [elementBlacklist]
* @param {string[]} [idBlacklist]
* @returns {HTMLElement|undefined}
*/
this.getElementByCfi = function (spineItemIdref, cfi, classBlacklist, elementBlacklist, idBlacklist) {
if (_currentView) {
return _currentView.getElementByCfi(spineItemIdref, cfi, classBlacklist, elementBlacklist, idBlacklist);
}
return undefined;
};
function applyStyles(doNotUpdateView) {
Helpers.setStyles(_userStyles.getStyles(), _$el);
if (_mediaOverlayPlayer)
_mediaOverlayPlayer.applyStyles();
if (doNotUpdateView) return;
if (_currentView) {
_currentView.applyStyles();
}
}
/**
* Opens a content url from a media player context
*
* @param {string} contentRefUrl
* @param {string} sourceFileHref
* @param offset
*/
this.mediaOverlaysOpenContentUrl = function (contentRefUrl, sourceFileHref, offset) {
_mediaOverlayPlayer.mediaOverlaysOpenContentUrl(contentRefUrl, sourceFileHref, offset);
};
/**
* Opens the content document specified by the url
*
* @param {string} contentRefUrl Url of the content document
* @param {string | undefined} sourceFileHref Url to the file that contentRefUrl is relative to. If contentRefUrl is
* relative ot the source file that contains it instead of the package file (ex. TOC file) We have to know the
* sourceFileHref to resolve contentUrl relative to the package file.
* @param {object} initiator optional
*/
this.openContentUrl = function (contentRefUrl, sourceFileHref, initiator) {
var combinedPath = Helpers.ResolveContentRef(contentRefUrl, sourceFileHref);
var hashIndex = combinedPath.indexOf("#");
var hrefPart;
var elementId;
if (hashIndex >= 0) {
hrefPart = combinedPath.substr(0, hashIndex);
elementId = combinedPath.substr(hashIndex + 1);
}
else {
hrefPart = combinedPath;
elementId = undefined;
}
var spineItem = _spine.getItemByHref(hrefPart);
if (!spineItem) {
console.warn('spineItem ' + hrefPart + ' not found');
// sometimes that happens because spine item's URI gets encoded,
// yet it's compared with raw strings by `getItemByHref()` -
// so we try to search with decoded link as well
var decodedHrefPart = decodeURIComponent(hrefPart);
spineItem = _spine.getItemByHref(decodedHrefPart);
if (!spineItem) {