scala.tools.nsc.doc.html

HtmlPage

class HtmlPage extends Page

An html page that is part of a Scaladoc site.

Attributes
abstract
Self Type
HtmlPage
Source
HtmlPage.scala
Linear Supertypes
Page, AnyRef, Any
Known Subclasses
Index, ReferenceIndex, Source, Template
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. HtmlPage
  2. Page
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HtmlPage ()

Abstract Value Members

  1. def body : NodeSeq

    The body of this page.

    The body of this page.

    Attributes
    abstract

  2. def headers : NodeSeq

    Additional header elements (links, scripts, meta tags, etc.

    Additional header elements (links, scripts, meta tags, etc.) required for this page.

    Attributes
    protected abstract

  3. 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.tail is a list of folder names leading to this page (from closest package to one-above-root package), path.head is the file name of this page. Note that path has a length of at least one.

    Attributes
    abstract
    Definition Classes
    Page

  4. def title : String

    The title of this page.

    The title of this page.

    Attributes
    protected abstract

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def absoluteLinkTo (path: List[String]): String

    Definition Classes
    Page

  7. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  8. def blockToHtml (block: Block): NodeSeq

  9. def bodyToHtml (body: Body): NodeSeq

  10. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. def commentToHtml (comment: Comment): NodeSeq

    Transforms a comment into an styled HTML tree representing its body.

  12. def commentToHtml (comment: Option[Comment]): NodeSeq

    Transforms an optional comment into an styled HTML tree representing its body if it is defined, or into an empty node sequence if it is not.

  13. def createFileOutputStream (site: HtmlFactory): FileOutputStream

    Definition Classes
    Page

  14. def docEntityKindToBigImage (ety: DocTemplateEntity): String

    Returns the _big image name corresponding to the DocTemplate Entity (upper left icon)

  15. def docEntityKindToString (ety: DocTemplateEntity): String

    Definition Classes
    Page

  16. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  17. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  19. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  20. def hasPage (e: DocTemplateEntity): Boolean

  21. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  22. def inlineToHtml (inl: Inline): NodeSeq

  23. def isExcluded (dtpl: DocTemplateEntity): Boolean

    Definition Classes
    Page

  24. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  25. def listItemsToHtml (items: Seq[Block]): NodeSeq

  26. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  27. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  28. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  29. def relativeLinkTo (destPath: List[String]): String

    A relative link from this page to some destination path.

    A relative link from this page to some destination path.

    destPath

    The path that the link will point to.

    Definition Classes
    Page

  30. def relativeLinkTo (destPage: HtmlPage): String

    A relative link from this page to some destination page in the Scaladoc site.

    A relative link from this page to some destination page in the Scaladoc site.

    destPage

    The page that the link will point to.

    Definition Classes
    Page

  31. 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.

    Definition Classes
    Page

  32. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  33. def templateToHtml (tpl: TemplateEntity): Node with Serializable

    Returns the HTML code that represents the template in tpl as a hyperlinked name.

  34. def templateToPath (tpl: TemplateEntity): List[String]

    Definition Classes
    Page

  35. def templatesToHtml (tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq

    Returns the HTML code that represents the templates in tpls as a list of hyperlinked names.

  36. def toString (): String

    Definition Classes
    AnyRef → Any

  37. def typeToHtml (tpe: TypeEntity, hasLinks: Boolean): NodeSeq

  38. def typesToHtml (tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq

  39. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  40. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  41. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  42. 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.

    Definition Classes
    HtmlPage → Page

Inherited from Page

Inherited from AnyRef

Inherited from Any