C-index

A B C D E F G H I J L M N O P R S T U V W X

C

Cache - class in org.readium.r2.shared.util.cache: A generic cache for objects of type V.
cached(Resource) - function in org.readium.r2.shared.fetcher.Resource.Companion: Creates a cached resource wrapping this resource.
cachedIn(PdfDocumentFactory,PublicationServicesHolder) - function in org.readium.r2.shared.util.pdf.PdfDocumentKt: Creates a new factory which caches the results of the wrapped factory into a PublicationServicesHolder.
cacheOf(KClass,String) - function in org.readium.r2.shared.publication.services.CacheService: Gets the cache for objects of valueType in the given namespace.
cacheOf(KClass,String) - function in org.readium.r2.shared.publication.services.InMemoryCacheService: Gets the cache for objects of valueType in the given namespace.
CacheService - class in org.readium.r2.shared.publication.services: Provides publication-bound caches.
CacheServiceKt - class in org.readium.r2.shared.publication.services
CacheTransaction - class in org.readium.r2.shared.util.cache: An atomic transaction run on a cache for objects of type V.
Cancelled - enum entry in org.readium.r2.shared.util.http.HttpException.Kind: The request was cancelled.
canCopy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights: Returns whether the user is allowed to copy the given text to the pasteboard.
canCopy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.AllRestricted: Returns whether the user is allowed to copy the given text to the pasteboard.
canCopy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.Unrestricted: Returns whether the user is allowed to copy the given text to the pasteboard.
canonicalMediaType() - function in org.readium.r2.shared.util.mediatype.MediaType: Returns the canonical version of this media type, if it is known.
canPrint(Integer) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights: Returns whether the user is allowed to print the given amount of pages.
canPrint(Integer) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.AllRestricted: Returns whether the user is allowed to print the given amount of pages.
canPrint(Integer) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.Unrestricted: Returns whether the user is allowed to print the given amount of pages.
CBZ - enum entry in org.readium.r2.shared.publication.Publication.EXTENSION
CBZ - enum entry in org.readium.r2.shared.publication.Publication.TYPE
CENTER - enum entry in org.readium.r2.shared.publication.presentation.Presentation.Page
CJK_HORIZONTAL - enum entry in org.readium.r2.shared.publication.ContentLayout
CJK_VERTICAL - enum entry in org.readium.r2.shared.publication.ContentLayout
clear() - function in org.readium.r2.shared.util.cache.CacheTransaction: Clears all cached values.
ClientError - enum entry in org.readium.r2.shared.util.http.HttpException.Kind: (4xx) Other client errors
Clip - class in org.readium.r2.shared
clip(String) - function in org.readium.r2.shared.MediaOverlays
close() - function in java.io.FilterInputStream
close() - function in org.readium.r2.shared.fetcher.ArchiveFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.BaseBytesResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.BaseBytesResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.EmptyFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.FailureResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.FallbackResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.FileFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.FileFetcher.FileResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.HttpFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.LazyResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.ProxyResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.ProxyResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.ResourceInputStream: Closes the underlying resource.
close() - function in org.readium.r2.shared.fetcher.RoutingFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.SynchronizedResource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.fetcher.TransformingFetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.publication.CacheService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.ContentProtectionService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.ContentService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.CoverService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.LocatorService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.PositionsService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.Publication: Closes any opened resource associated with the Publication, including services.
close() - function in org.readium.r2.shared.publication.Publication.Service: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.Publication.Service: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.PublicationServicesHolder: Closes the publication services.
close() - function in org.readium.r2.shared.publication.SearchService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.services.InMemoryCacheService: Closes any opened file handles, removes temporary files, etc.
close() - function in org.readium.r2.shared.publication.services.search.SearchIterator: Closes any resources allocated for the search query, such as a cursor.
close() - function in org.readium.r2.shared.util.Archive: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.Archive.Entry: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.Cache: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.Closeable: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.Fetcher: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.PdfDocument: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.Resource: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.SuspendingCloseable: Closes this object and releases any resources associated with it.
close() - function in org.readium.r2.shared.util.cache.InMemoryCache: Closes this object and releases any resources associated with it.
Closeable - class in org.readium.r2.shared.util: A Closeable is an object holding closeable resources, such as open files or streams.
CloseableKt - class in org.readium.r2.shared.util
coerceFirstNonNegative(LongRange) - function in org.readium.r2.shared.extensions.LongRangeKt
coerceIn(LongRange,LongRange) - function in org.readium.r2.shared.extensions.LongRangeKt
collect(String,String) - function in org.readium.r2.shared.parser.xml.ElementNode: Recursively collect all descendent ElementNode with the given name and namespace into a list
collectionsFromJSON(JSONObject,TypeAliased(typeAlias=GenericTypeConstructor(dri=org.readium.r2.shared.publication/LinkHrefNormalizer///PointingToDeclaration/, projections=[], presentableName=null, extra=PropertyContainer(map={})), inner=FunctionalTypeConstructor(dri=kotlin.jvm.functions/Function1///PointingToDeclaration/, projections=[, ], isExtensionFunction=false, isSuspendable=false, presentableName=null, extra=PropertyContainer(map={})), extra=PropertyContainer(map={})),WarningLogger) - function in org.readium.r2.shared.publication.PublicationCollection.Companion: Parses a map of PublicationCollection indexed by their roles from its RWPM JSON representation.
collectText() - function in org.readium.r2.shared.parser.xml.ElementNode: Recursively collect and concatenate all descendent TextNode in depth-first order
columnCount - enum entry in org.readium.r2.shared.ReadiumCSSName
conformsTo(Publication.Profile) - function in org.readium.r2.shared.publication.Manifest: Returns whether this manifest conforms to the given Readium Web Publication Profile.
conformsTo(Publication.Profile) - function in org.readium.r2.shared.publication.Publication: Returns whether this publication conforms to the given Readium Web Publication Profile.
ConsoleWarningLogger - class in org.readium.r2.shared.util.logging: Implementation of a WarningLogger printing the warnings to the console.
CONTAIN - enum entry in org.readium.r2.shared.publication.presentation.Presentation.Fit
contains(E) - function in kotlin.collections.List
contains(String) - function in org.readium.r2.shared.util.mediatype.MediaType: Returns whether the given other media type is included in this media type.
contains(MediaType) - function in org.readium.r2.shared.util.mediatype.MediaType: Returns whether the given other media type is included in this media type.
containsAll(Collection) - function in kotlin.collections.List
Content - class in org.readium.r2.shared.publication.services.content: Provides an iterable list of content Elements.
content(Locator) - function in org.readium.r2.shared.publication.services.content.ContentService: Creates a Content starting from the given start location.
content(Publication,Locator) - function in org.readium.r2.shared.publication.services.content.ContentServiceKt: Creates a Content starting from the given start location, or the beginning of the publication when missing.
content(Locator) - function in org.readium.r2.shared.publication.services.content.DefaultContentService: Creates a Content starting from the given start location.
Content.Attribute - class in org.readium.r2.shared.publication.services.content.Content: An attribute is an arbitrary key-value metadata pair.
Content.AttributeKey - class in org.readium.r2.shared.publication.services.content.Content: An attribute key uniquely an attribute.
Content.AttributeKey.Companion - class in org.readium.r2.shared.publication.services.content.Content.AttributeKey
Content.AttributesHolder - class in org.readium.r2.shared.publication.services.content.Content: An object associated with a list of attributes.
Content.AudioElement - class in org.readium.r2.shared.publication.services.content.Content: An audio clip.
Content.Element - class in org.readium.r2.shared.publication.services.content.Content: Represents a single semantic content element part of a publication.
Content.EmbeddedElement - class in org.readium.r2.shared.publication.services.content.Content: An element referencing an embedded external resource.
Content.ImageElement - class in org.readium.r2.shared.publication.services.content.Content: A bitmap image.
Content.Iterator - class in org.readium.r2.shared.publication.services.content.Content: Iterates through a list of Element items asynchronously.
Content.TextElement - class in org.readium.r2.shared.publication.services.content.Content: A text element.
Content.TextElement.Role - class in org.readium.r2.shared.publication.services.content.Content.TextElement: Represents a purpose of an element in the broader context of the document.
Content.TextElement.Role.Body - class in org.readium.r2.shared.publication.services.content.Content.TextElement.Role: Normal body of content.
Content.TextElement.Role.Footnote - class in org.readium.r2.shared.publication.services.content.Content.TextElement.Role: A footnote at the bottom of a document.
Content.TextElement.Role.Heading - class in org.readium.r2.shared.publication.services.content.Content.TextElement.Role: Title of a section.
Content.TextElement.Role.Quote - class in org.readium.r2.shared.publication.services.content.Content.TextElement.Role: A quotation.
Content.TextElement.Segment - class in org.readium.r2.shared.publication.services.content.Content.TextElement: Ranged portion of text with associated attributes.
Content.TextualElement - class in org.readium.r2.shared.publication.services.content.Content: An element which can be represented as human-readable text.
Content.VideoElement - class in org.readium.r2.shared.publication.services.content.Content: A video clip.
contentAsArchive() - function in org.readium.r2.shared.util.mediatype.SnifferContext: Content as an Archive instance.
contentAsJson() - function in org.readium.r2.shared.util.mediatype.SnifferContext: Content parsed from JSON.
contentAsRwpm() - function in org.readium.r2.shared.util.mediatype.SnifferContext: Readium Web Publication Manifest parsed from the content.
contentAsString() - function in org.readium.r2.shared.util.mediatype.SnifferContext: Content as plain text.
contentAsXml() - function in org.readium.r2.shared.util.mediatype.SnifferContext: Content as an XML document.
ContentLayout - class in org.readium.r2.shared.publication: The ContentLayout defines how a Publication should be laid out, based on the declared ReadingProgression and its language.
ContentLayout.Companion - class in org.readium.r2.shared.publication.ContentLayout
contentLayoutForLanguage(String) - function in org.readium.r2.shared.publication.Publication
ContentProtection - class in org.readium.r2.shared.publication: Bridge between a Content Protection technology and the Readium toolkit.
ContentProtection.Exception - class in org.readium.r2.shared.publication.ContentProtection
ContentProtection.Exception.SchemeNotSupported - class in org.readium.r2.shared.publication.ContentProtection.Exception: Exception returned when the given Content Protection scheme is not supported by the app.
ContentProtection.ProtectedAsset - class in org.readium.r2.shared.publication.ContentProtection: Holds the result of opening a PublicationAsset with a ContentProtection.
ContentProtection.Scheme - class in org.readium.r2.shared.publication.ContentProtection: Represents a specific Content Protection technology, uniquely identified with an uri.
ContentProtection.Scheme.Companion - class in org.readium.r2.shared.publication.ContentProtection.Scheme
ContentProtectionService - class in org.readium.r2.shared.publication.services: Provides information about a publication's content protection and manages user rights.
ContentProtectionService.UserRights - class in org.readium.r2.shared.publication.services.ContentProtectionService: Manages consumption of user rights and permissions.
ContentProtectionService.UserRights.AllRestricted - class in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights: A UserRights which forbids any right.
ContentProtectionService.UserRights.Unrestricted - class in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights: A UserRights without any restriction.
ContentProtectionServiceKt - class in org.readium.r2.shared.publication.services
ContentService - class in org.readium.r2.shared.publication.services.content: Provides a way to extract the raw Content of a Publication.
ContentServiceKt - class in org.readium.r2.shared.publication.services.content
ContentTokenizer - class in org.readium.r2.shared.publication.services.content: A tokenizer splitting a Content.Element into smaller pieces.
Contributor - class in org.readium.r2.shared.publication: Contributor Object for the Readium Web Publication Manifest.
Contributor.Companion - class in org.readium.r2.shared.publication.Contributor
Copies - class in org.readium.r2.shared.opds: Library-specific feature that contains information about the copies that a library has acquired.
Copies.Companion - class in org.readium.r2.shared.opds.Copies
copy(String) - function in org.readium.r2.shared.drm.DRMLicense
copy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights: Consumes the given text with the copy right.
copy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.AllRestricted: Consumes the given text with the copy right.
copy(String) - function in org.readium.r2.shared.publication.services.ContentProtectionService.UserRights.Unrestricted: Consumes the given text with the copy right.
copyWithLocations(List,Double,Integer,Double,Map) - function in org.readium.r2.shared.publication.Locator: Shortcut to get a copy of the Locator with different Locations sub-properties.
copyWithPositionsFactory(Function1) - function in org.readium.r2.shared.publication.Publication: Copy the Publication with a different PositionListFactory.
copyWithString(String,String) - function in org.readium.r2.shared.publication.LocalizedString: Returns a new LocalizedString after adding (or replacing) the translation with the given language.
CountingInputStream - class in org.readium.r2.shared.util.io: An InputStream counting the number of bytes read from a wrapped inputStream.
COVER - enum entry in org.readium.r2.shared.publication.presentation.Presentation.Fit
cover() - function in org.readium.r2.shared.publication.services.CoverService: Returns the publication cover as a Bitmap at its maximum size.
cover(Publication) - function in org.readium.r2.shared.publication.services.CoverServiceKt: Returns the publication cover as a Bitmap at its maximum size.
cover() - function in org.readium.r2.shared.publication.services.GeneratedCoverService: Returns the publication cover as a Bitmap at its maximum size.
cover() - function in org.readium.r2.shared.publication.services.InMemoryCoverService: Returns the publication cover as a Bitmap at its maximum size.
cover(Context) - function in org.readium.r2.shared.util.pdf.PdfDocument: The first page rendered as a cover.
coverFitting(Size) - function in org.readium.r2.shared.publication.services.CoverService: Returns the publication cover as a Bitmap, scaled down to fit the given maxSize.
coverFitting(Size) - function in org.readium.r2.shared.publication.services.CoverService: Returns the publication cover as a Bitmap, scaled down to fit the given maxSize.
coverFitting(Publication,Size) - function in org.readium.r2.shared.publication.services.CoverServiceKt: Returns the publication cover as a Bitmap, scaled down to fit the given maxSize.
CoverService - class in org.readium.r2.shared.publication.services: Provides an easy access to a bitmap version of the publication cover.
CoverServiceKt - class in org.readium.r2.shared.publication.services
create(Parcel) - function in org.readium.r2.shared.extensions.JSONParceler
create() - function in org.readium.r2.shared.publication.Publication.PositionListFactory
createDefaultFactory(Integer,StringSearchService.Algorithm,ResourceContentExtractor.Factory) - function in org.readium.r2.shared.publication.services.search.StringSearchService.Companion
createExtractor(Resource) - function in org.readium.r2.shared.fetcher.DefaultResourceContentExtractorFactory: Creates a ResourceContentExtractor instance for the given resource.
createExtractor(Resource) - function in org.readium.r2.shared.fetcher.ResourceContentExtractor.Factory: Creates a ResourceContentExtractor instance for the given resource.
createFactory(Context) - function in org.readium.r2.shared.publication.services.InMemoryCacheService.Companion
createFactory(Bitmap) - function in org.readium.r2.shared.publication.services.InMemoryCoverService.Companion
createFactory(String) - function in org.readium.r2.shared.publication.services.PerResourcePositionsService.Companion
createFactory(List) - function in org.readium.r2.shared.publication.services.content.DefaultContentService.Companion
createFactory() - function in org.readium.r2.shared.publication.services.content.iterators.HtmlResourceContentIterator.Companion: Creates a new factory for HtmlResourceContentIterator.
createFetcher(PublicationAsset.Dependencies,String) - function in org.readium.r2.shared.publication.asset.FileAsset: Creates a fetcher used to access the asset's content.
createFetcher(PublicationAsset.Dependencies,String) - function in org.readium.r2.shared.publication.asset.PublicationAsset: Creates a fetcher used to access the asset's content.
Critical - enum entry in org.readium.r2.shared.util.MemoryObserver.Level
CursorList - class in org.readium.r2.shared.util: A List with a mutable cursor index.

A B C D E F G H I J L M N O P R S T U V W X