class NCXRenderer extends AnyRef
Renders the entire content of an NCX navigation file. These files will be ignored by EPUB 3 readers and are only added for backwards-compatibility with older readers.
- Alphabetic
- By Inheritance
- NCXRenderer
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new NCXRenderer()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
fileContent(identifier: String, title: String, navPoints: String, depth: Int): String
Inserts the specified (pre-rendered) navPoints into the NCX document template and returns the content of the entire NCX file.
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
navPoint(title: String, link: String, pos: Int, children: String): String
Renders a single navPoint node.
-
def
navPoints(bookNav: Seq[BookNavigation]): String
Generates navPoints for the structure of the DocumentTree.
Generates navPoints for the structure of the DocumentTree. Individual navPoints can stem from tree or subtree titles, document titles or document sections, depending on which recursion depth is configured. The configuration key for setting the recursion depth is
epub.toc.depth
.- bookNav
the structure to generate navPoints for
- returns
the navPoint XML nodes for the specified document tree
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
render[F[_]](result: RenderedTreeRoot[F], identifier: String, depth: Int): String
Renders the entire content of an NCX navigation file for the specified document tree.
Renders the entire content of an NCX navigation file for the specified document tree. The recursion depth will be applied to the tree structure obtained by recursively processing titles of document trees, documents and sections. The configuration key for setting the recursion depth is
epub.toc.depth
. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()