-
- All Implemented Interfaces:
-
android.os.Parcelable,org.readium.r2.shared.JSONable
public final class Presentation implements JSONable, Parcelable
The Presentation Hints extension defines a number of hints for User Agents about the way content should be presented to the user.
https://readium.org/webpub-manifest/extensions/presentation.html https://readium.org/webpub-manifest/schema/extensions/presentation/metadata.schema.json
These properties are nullable to avoid having default values when it doesn't make sense for a given publication. If a navigator needs a default value when not specified, Presentation.DEFAULT_X and Presentation.X.DEFAULT can be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classPresentation.Companionpublic enumPresentation.FitSuggested method for constraining a resource inside the viewport.
public enumPresentation.OrientationSuggested orientation for the device when displaying the linked resource.
public enumPresentation.OverflowSuggested method for handling overflow while displaying the linked resource.
public enumPresentation.PageIndicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.
public enumPresentation.SpreadIndicates the condition to be met for the linked resource to be rendered within a synthetic spread.
-
Field Summary
Fields Modifier and Type Field Description private final Presentation.Overflowflowprivate final Booleanclippedprivate final Booleancontinuousprivate final Presentation.Fitfitprivate final Presentation.Orientationorientationprivate final Presentation.Overflowoverflowprivate final Presentation.Spreadspreadprivate final EpubLayoutlayout
-
Constructor Summary
Constructors Constructor Description Presentation(Boolean clipped, Boolean continuous, Presentation.Fit fit, Presentation.Orientation orientation, Presentation.Overflow overflow, Presentation.Spread spread, EpubLayout layout)
-
Method Summary
Modifier and Type Method Description final Presentation.OverflowgetFlow()final BooleangetClipped()final BooleangetContinuous()final Presentation.FitgetFit()final Presentation.OrientationgetOrientation()final Presentation.OverflowgetOverflow()final Presentation.SpreadgetSpread()final EpubLayoutgetLayout()JSONObjecttoJSON()Serializes a Presentation to its RWPM JSON representation. final JSONObjectgetJSON()-
-
Constructor Detail
-
Presentation
Presentation(Boolean clipped, Boolean continuous, Presentation.Fit fit, Presentation.Orientation orientation, Presentation.Overflow overflow, Presentation.Spread spread, EpubLayout layout)
- Parameters:
clipped- Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.continuous- Indicates how the progression between resources from the reading order should be handled.fit- Suggested method for constraining a resource inside the viewport.orientation- Suggested orientation for the device when displaying the linked resource.overflow- Suggested method for handling overflow while displaying the linked resource.spread- Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.layout- Hints how the layout of the resource should be presented (EPUB extension).
-
-
Method Detail
-
getFlow
final Presentation.Overflow getFlow()
-
getClipped
final Boolean getClipped()
-
getContinuous
final Boolean getContinuous()
-
getFit
final Presentation.Fit getFit()
-
getOrientation
final Presentation.Orientation getOrientation()
-
getOverflow
final Presentation.Overflow getOverflow()
-
getSpread
final Presentation.Spread getSpread()
-
getLayout
final EpubLayout getLayout()
-
toJSON
JSONObject toJSON()
Serializes a Presentation to its RWPM JSON representation.
-
getJSON
@Deprecated(message = Use [toJSON] instead, replaceWith = @ReplaceWith(imports = {}, expression = toJSON()), level = DeprecationLevel.ERROR) final JSONObject getJSON()
-
-
-
-