scala.tools.nsc.doc.html.page

Index

class Index extends HtmlPage

Source
Index.scala
Linear Supertypes
HtmlPage, Page, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Index
  2. HtmlPage
  3. Page
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Index (universe: Universe, index: Index)

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

    Definition Classes
    HtmlPage

  9. val body : Elem

    The body of this page.

    The body of this page.

    Definition Classes
    Index → HtmlPage

  10. def bodyToHtml (body: Body): NodeSeq

    Definition Classes
    HtmlPage

  11. def browser : Elem

  12. def clone (): AnyRef

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

  13. def commentToHtml (comment: Comment): NodeSeq

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

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

    Definition Classes
    HtmlPage

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

    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.

    Definition Classes
    HtmlPage

  15. def createFileOutputStream (site: HtmlFactory): FileOutputStream

    Definition Classes
    Page

  16. def docEntityKindToBigImage (ety: DocTemplateEntity): String

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

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

    Definition Classes
    HtmlPage

  17. def docEntityKindToString (ety: DocTemplateEntity): String

    Definition Classes
    Page

  18. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  19. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  20. def finalize (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef → Any

  22. def hasPage (e: DocTemplateEntity): Boolean

    Definition Classes
    HtmlPage

  23. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  24. val headers : Group

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

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

    Definition Classes
    Index → HtmlPage

  25. def inlineToHtml (inl: Inline): NodeSeq

    Definition Classes
    HtmlPage

  26. def isExcluded (dtpl: DocTemplateEntity): Boolean

    Definition Classes
    Page

  27. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

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

    Definition Classes
    HtmlPage

  29. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  30. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  31. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  32. def packageQualifiedName (ety: DocTemplateEntity): String

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

    Definition Classes
    Index → Page

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

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef

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

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

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

    Definition Classes
    HtmlPage

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

    Definition Classes
    Page

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

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

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

    Definition Classes
    HtmlPage

  41. def title : String

    The title of this page.

    The title of this page.

    Definition Classes
    Index → HtmlPage

  42. def toString (): String

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    HtmlPage

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

    Definition Classes
    HtmlPage

  45. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  47. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  48. 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 HtmlPage

Inherited from Page

Inherited from AnyRef

Inherited from Any