Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reading order as parameter to EPubFragment factory / constructor #376

Merged
merged 13 commits into from
Sep 1, 2023
Merged

Add reading order as parameter to EPubFragment factory / constructor #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
55c4c2b
Add readingOrder as optional parameter to EPubNavigatorFragment
chrfalch Aug 18, 2023
f0e44f9
Merge branch 'develop' into feature/add-reading-order-as-parameter-to…
chrfalch Aug 29, 2023
4b09b72
CR: Updated readingOrder and readingPositions to be dependant on each…
chrfalch Aug 29, 2023
f1afa7b
CR: Removed outdated comment
chrfalch Aug 30, 2023
4ea2d0f
CR: Renamed Event.GoTo -> Event.OpenInternalLink
chrfalch Aug 30, 2023
83cab82
Reverted last commit - wrong PR
chrfalch Aug 30, 2023
4afac5b
CR: Updated readingOrder on constructor
chrfalch Aug 30, 2023
09e0b12
Fixed inversed condition - sorry
chrfalch Aug 31, 2023
758b08b
CR: Resolved constructor argument and property for readingOrder
chrfalch Aug 31, 2023
0ec982f
CR: Removed unneccessary arg
chrfalch Aug 31, 2023
a927aa5
Update readium/navigator/src/main/java/org/readium/r2/navigator/epub/…
chrfalch Aug 31, 2023
d9e6a47
CR: Fixed missing, in ctor args
chrfalch Aug 31, 2023
8705be1
CI: Lint fix
chrfalch Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorFactory.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package org.readium.r2.navigator.epub

import org.readium.r2.shared.ExperimentalReadiumApi
import org.readium.r2.shared.publication.Link
import org.readium.r2.shared.publication.Locator
import org.readium.r2.shared.publication.Publication
import org.readium.r2.shared.publication.epub.EpubLayout
Expand Down Expand Up @@ -38,6 +39,7 @@ class EpubNavigatorFactory(

fun createFragmentFactory(
initialLocator: Locator?,
readingOrder: List<Link>? = null,
initialPreferences: EpubPreferences = EpubPreferences(),
listener: EpubNavigatorFragment.Listener? = null,
paginationListener: EpubNavigatorFragment.PaginationListener? = null,
Expand All @@ -47,6 +49,7 @@ class EpubNavigatorFactory(
publication = publication,
baseUrl = null,
initialLocator = initialLocator,
readingOrder = readingOrder,
initialPreferences = initialPreferences,
listener = listener,
paginationListener = paginationListener,
Expand Down
23 changes: 15 additions & 8 deletions readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ class EpubNavigatorFragment internal constructor(
override val publication: Publication,
private val baseUrl: String?,
private val initialLocator: Locator?,
readingOrder: List<Link>?,
private val initialPreferences: EpubPreferences,
internal val listener: Listener?,
internal val paginationListener: PaginationListener?,
Expand Down Expand Up @@ -274,7 +275,12 @@ class EpubNavigatorFragment internal constructor(
)
}

internal lateinit var positionsByReadingOrder: List<List<Locator>>
private val readingOrder: List<Link> = readingOrder ?: publication.readingOrder

private val positionsByReadingOrder: List<List<Locator>> =
if (readingOrder != null) emptyList()
else runBlocking { publication.positionsByReadingOrder() }

internal lateinit var positions: List<Locator>
lateinit var resourcePager: R2ViewPager

Expand Down Expand Up @@ -306,13 +312,12 @@ class EpubNavigatorFragment internal constructor(
_binding = ActivityR2ViewpagerBinding.inflate(inflater, container, false)
val view = binding.root

positionsByReadingOrder = runBlocking { publication.positionsByReadingOrder() }
positions = positionsByReadingOrder.flatten()
publicationIdentifier = publication.metadata.identifier ?: publication.metadata.title

when (viewModel.layout) {
EpubLayout.REFLOWABLE -> {
resourcesSingle = publication.readingOrder.mapIndexed { index, link ->
resourcesSingle = readingOrder.mapIndexed { index, link ->
PageResource.EpubReflowable(
link = link,
url = viewModel.urlTo(link),
Expand All @@ -329,7 +334,7 @@ class EpubNavigatorFragment internal constructor(
var doublePageLeft: Link? = null
var doublePageRight: Link? = null

for ((index, link) in publication.readingOrder.withIndex()) {
for ((index, link) in readingOrder.withIndex()) {
val url = viewModel.urlTo(link)
resourcesSingle.add(PageResource.EpubFxl(leftLink = link, leftUrl = url))

Expand Down Expand Up @@ -881,7 +886,7 @@ class EpubNavigatorFragment internal constructor(
locatorToResourceAtIndex(resourcePager.currentItem + 1)

private fun locatorToResourceAtIndex(index: Int): Locator? =
publication.readingOrder.getOrNull(index)
readingOrder.getOrNull(index)
?.let { publication.locatorFromLink(it) }

private val r2PagerAdapter: R2PagerAdapter?
Expand Down Expand Up @@ -919,7 +924,7 @@ class EpubNavigatorFragment internal constructor(
override val currentLocator: StateFlow<Locator> get() = _currentLocator
private val _currentLocator = MutableStateFlow(
initialLocator
?: requireNotNull(publication.locatorFromLink(publication.readingOrder.first()))
?: requireNotNull(publication.locatorFromLink(this.readingOrder.first()))
)

/**
Expand All @@ -930,7 +935,7 @@ class EpubNavigatorFragment internal constructor(
override suspend fun firstVisibleElementLocator(): Locator? {
if (!::resourcePager.isInitialized) return null

val resource = publication.readingOrder[resourcePager.currentItem]
val resource = readingOrder[resourcePager.currentItem]
return currentReflowablePageFragment?.webView?.findFirstVisibleLocator()
?.copy(
href = resource.href,
Expand Down Expand Up @@ -1035,21 +1040,23 @@ class EpubNavigatorFragment internal constructor(
* if you use a local HTTP server.
* @param initialLocator The first location which should be visible when rendering the
* publication. Can be used to restore the last reading location.
* @param readingOrder custom reading order
* @param listener Optional listener to implement to observe events, such as user taps.
* @param config Additional configuration.
*/
fun createFactory(
publication: Publication,
baseUrl: String? = null,
initialLocator: Locator? = null,
readingOrder: List<Link>? = null,
listener: Listener? = null,
paginationListener: PaginationListener? = null,
config: Configuration = Configuration(),
initialPreferences: EpubPreferences = EpubPreferences()
): FragmentFactory =
createFragmentFactory {
EpubNavigatorFragment(
publication, baseUrl, initialLocator, initialPreferences,
publication, baseUrl, initialLocator, readingOrder, initialPreferences,
listener, paginationListener,
epubLayout = publication.metadata.presentation.layout ?: EpubLayout.REFLOWABLE,
defaults = EpubDefaults(),
Expand Down