abstract class Page extends AnyRef
- Alphabetic
- By Inheritance
- Page
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Page()
Abstract Value Members
-
abstract
def
path: List[String]
The path of this page, relative to the API site.
The path of this page, relative to the API site.
path.tailis a list of folder names leading to this page (from closest package to one-above-root package),path.headis the file name of this page. Note thatpathhas a length of at least one. -
abstract
def
writeFor(site: HtmlFactory): Unit
Writes this page as a file.
Writes this page as a file. The file's location is relative to the generator's site root, and the encoding is also defined by the generator.
- site
The generator that is writing this page.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Page, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def absoluteLinkTo(path: List[String]): String
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def createFileOutputStream(site: HtmlFactory, suffix: String = ""): FileOutputStream
- def ensuring(cond: (Page) ⇒ Boolean, msg: ⇒ Any): Page
- def ensuring(cond: (Page) ⇒ Boolean): Page
- def ensuring(cond: Boolean, msg: ⇒ Any): Page
- def ensuring(cond: Boolean): Page
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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 hasCompanion(mbr: TemplateEntity): Boolean
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def kindToString(mbr: MemberEntity): String
-
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
relativeLinkTo(destPath: List[String]): String
A relative link from a page's path to some destination path.
A relative link from a page's path to some destination path.
- destPath
The path that the link will point to.
-
def
relativeLinkTo(destClass: TemplateEntity): String
A relative link from this page to some destination class entity.
A relative link from this page to some destination class entity.
- destClass
The class or object entity that the link will point to.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def templateToPath(tpl: TemplateEntity): List[String]
-
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()
- def writeFile(site: HtmlFactory, suffix: String = "")(fn: (Writer) ⇒ Unit): Unit
- def →[B](y: B): (Page, B)
Deprecated Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Page to StringFormat[Page] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
The Scala compiler and reflection APIs.