Trait/Object

org.senkbeil.grus.structures

Page

Related Docs: object Page | package structures

Permalink

trait Page extends AnyRef

Represents a page of content.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Page
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def absoluteLink: String

    Permalink

    returns

    An absolute web path link to this file, ignoring any overrides

  2. abstract def isAtRoot: Boolean

    Permalink

    returns

    Whether or not this page is at the root of the website. E.g. /example.html is at the root while /my/example.html is not.

  3. abstract def isDirectory: Boolean

    Permalink

    returns

    Whether or not this page represents a directory

  4. abstract def isIndexPage: Boolean

    Permalink

    returns

    Whether or not this page represents an index page

  5. abstract def metadata: Metadata

    Permalink

    returns

    The metadata for the page

  6. abstract def name: String

    Permalink

    returns

    The name of the page, which is based on the file name

  7. abstract def outputPath: Path

    Permalink

    returns

    The output path when the page is rendered

  8. abstract def path: Path

    Permalink

    returns

    The path to the raw page content

  9. abstract def render(context: Context, path: Path = outputPath): Boolean

    Permalink

    Renders the page and writes it to the output path.

    Renders the page and writes it to the output path.

    context

    The context to feed into this page's layout

    path

    The path to render the file

    returns

    True if successfully rendered the page, otherwise false

  10. abstract def title: String

    Permalink

    returns

    The title of the page, which either comes from the metadata of the page or the name of the file the page is associated with

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(obj: Any): Boolean

    Permalink

    Compares this page with another page.

    Compares this page with another page. Two pages are equal if they have the same path.

    obj

    The other page to compare

    returns

    True if the two pages have the same path, otherwise false

    Definition Classes
    Page → AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def isUsingDefaultLayout: Boolean

    Permalink

    Returns whether or not the page is using the default layout.

    Returns whether or not the page is using the default layout.

    returns

    True if using the default layout, otherwise false

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped