DetailedPageLayout

Type Members

case class Arguments(context: Context, content: NamedContent) extends Product with Serializable

Definition Classes
Layout
type NamedContent = Map[String, HtmlContents]

Definition Classes
Layout

Abstract Value Members

abstract def arrangementDescription: Map[String, String]

Definition Classes
Layout
abstract def description: String

Definition Classes
Layout
abstract def id: Symbol

Definition Classes
Identifiable
implicit abstract def scrupal: Scrupal

Definition Classes
Layout

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to any2stringadd[DetailedPageLayout] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (DetailedPageLayout, B)

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to ArrowAssoc[DetailedPageLayout] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def alternate(args: Arguments): Option[String]
def application(args: Arguments): Option[String]

Generate Page Application
Generate Page Application
args
Arguments from which the page's application is derived
returns
An optional string containing the page's application name (for meta tag)
def apply(context: Context, arrangement: Arrangement): Future[HtmlElement]

Definition Classes
Layout → Function2
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authorLink(args: Arguments): Option[String]
def authorName(args: Arguments): Option[String]

Generate Page Author
Generate Page Author
args
Arguments from which the page's author is derived
returns
An optional string containing the page's author (for meta tag)
def await[X](future: ⇒ Future[X], opName: String)(implicit to: FiniteDuration): Try[X]

Definition Classes
FutureHelper
def await[X](future: ⇒ Future[X], duration: FiniteDuration, opName: String): Try[X]

Definition Classes
FutureHelper
def baseTag(args: Arguments): Option[BaseTag]

HTML Base Tag Represents the HTML
HTML Base Tag Represents the HTML
```
<base href="@htref" target="@target">
```
tag and provides the href and target as a result
<base href="@htref" target="@target"> }}}
returns
(href,target): href is the default url to use for links on the page, target is the default link target
def bodyTag(args: Arguments): HtmlElement

Generate HTML body Tag
Generate HTML body Tag
args
Arguments from which the body tag should be derived

Definition Classes
PageLayout
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createLoggerName: String

Attributes
protected
Definition Classes
LoggingHelper
def curried: (Context) ⇒ (Arrangement) ⇒ Future[HtmlElement]

Definition Classes
Function2
Annotations
@unspecialized()
def description(args: Arguments): Option[String]

Generate Page Descriptions
Generate Page Descriptions
args
Arguments from which the page description is derived
returns
An optional string containing the page's description (for meta tag)
def ensuring(cond: (DetailedPageLayout) ⇒ Boolean, msg: ⇒ Any): DetailedPageLayout

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to Ensuring[DetailedPageLayout] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (DetailedPageLayout) ⇒ Boolean): DetailedPageLayout

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to Ensuring[DetailedPageLayout] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): DetailedPageLayout

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to Ensuring[DetailedPageLayout] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): DetailedPageLayout

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to Ensuring[DetailedPageLayout] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def favIcon(args: Arguments): Option[String]
def finalize(): Unit

Definition Classes
Registrable → AnyRef
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to StringFormat[DetailedPageLayout] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def generator(args: Arguments): Option[String]

Generate Page Generator
Generate Page Generator
args
Arguments from which the page's generator is derived
returns
An optional string containing the page's generator name (for meta tag)
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def headTag(args: Arguments): HtmlElement

Generate HTML Head Element Generates the head tag and all content it requires
Generate HTML Head Element Generates the head tag and all content it requires
args
the arguments with which to customize the head element
returns
The head element

Definition Classes
DetailedPageLayout → PageLayout
def iconLink(args: Arguments): Option[IconLinkTag]
def imports(args: Arguments): Seq[String]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isRegistered: Boolean

Definition Classes
Registrable
def javascriptLinks(args: Arguments): Seq[String]
def keywords(args: Arguments): Seq[String]

Generate Page Keywords
Generate Page Keywords
args
Arguments from which the page's keywords are derived
returns
Strings that provide the keywords for the page (for meta tag)
lazy val label: String

Definition Classes
Identifiable
def layout(args: Arguments): HtmlElement

Lay out the content of this page
Lay out the content of this page
args
Arguments from which this page's content should be derived

Definition Classes
PageLayout → Layout
def level: Level

Definition Classes
LoggingHelper
def licenseLink(args: Arguments): Option[String]
def links(args: Arguments): List[HtmlElement]

Generate Page link tags
Generate Page link tags
args
The argument which which to customize the link tags
returns
A list of link tags for the head tag
lazy val log: Logger

Attributes
protected
Definition Classes
LoggingHelper
def loggerName: String

Definition Classes
LoggingHelper
def metas(args: Arguments): List[HtmlElement]

Generate HTML meta tags
Generate HTML meta tags
args
The arguments with which to customize the meta tags
returns
A List of the meta elements for the head
def mkThrowable(msg: String, cause: Option[Throwable] = None): ThrowableWithComponent

Attributes
protected
Definition Classes
ScrupalComponent → ThrowingHelper
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def notImplemented(what: String): Nothing

Definition Classes
ThrowingHelper
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def otherLinks(args: Arguments): Seq[LinkTag]
def otherMeta(args: Arguments): Map[String, String]
def page(context: Context, arrangement: Arrangement): Future[String]

Get a full page for this layout with the DOCTYPE declaration (HTML5 only)
Get a full page for this layout with the DOCTYPE declaration (HTML5 only)
context
The context in which to run the page generation
arrangement
The argument arrangement for substituting into the page layout

Definition Classes
PageLayout
def pageTitle(args: Arguments): String

Generate the page title
Generate the page title
args
the arguments with which to customize the title
returns
the title of the page for inclusion in the meta tags

Definition Classes
PageLayout
def reference: RegistryReference[Layout]

Definition Classes
Registrable
def refresh(args: Arguments): Int

Generate Page Refresh Time
Generate Page Refresh Time
args
Arguments from which the page's refresh delay is derived
returns
A non-zero value providing the number of seconds after which the page should automatically refresh or zero if that feature is not desired.
def register(): Unit

Definition Classes
Registrable
def registry: LayoutRegistry

Definition Classes
Layout → Registrable → IdentifiedWithRegistry
def registryName: String

Definition Classes
IdentifiedWithRegistry
def scripts(args: Arguments): Seq[String]
def sheets(args: Arguments): Seq[String]
def stylesheetLinks(args: Arguments): Seq[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
implicit val timeout: FiniteDuration

Definition Classes
FutureHelper
def toParArray: ParArray[T]

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to CollectionsHaveToParArray[DetailedPageLayout, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (DetailedPageLayout) ⇒ GenTraversableOnce[T] is in scope.
Definition Classes
CollectionsHaveToParArray
def toString(): String

Definition Classes
Function2 → AnyRef → Any
def toss(msg: ⇒ String, cause: Option[Throwable]): Nothing

Definition Classes
ThrowingHelper
def tupled: ((Context, Arrangement)) ⇒ Future[HtmlElement]

Definition Classes
Function2
Annotations
@unspecialized()
def unregister(): Unit

Definition Classes
Registrable
def validateArrangement(args: Arrangement): Iterable[Throwable]

Definition Classes
Layout
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( ... )
def →[B](y: B): (DetailedPageLayout, B)

Implicit information
This member is added by an implicit conversion from DetailedPageLayout to ArrowAssoc[DetailedPageLayout] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from PageLayout

Inherited from Layout

Inherited from Arranger

Inherited from (Context, Arrangement) ⇒ Future[HtmlElement]

Inherited from Registrable[Layout]

Inherited from IdentifiedWithRegistry

Inherited from Identifiable

Inherited from ScrupalComponent

Inherited from HelperComponent

Inherited from FutureHelper

Inherited from ThrowingHelper

Inherited from LoggingHelper

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion CollectionsHaveToParArray from DetailedPageLayout to CollectionsHaveToParArray[DetailedPageLayout, T]

Inherited by implicit conversion any2stringadd from DetailedPageLayout to any2stringadd[DetailedPageLayout]

Inherited by implicit conversion StringFormat from DetailedPageLayout to StringFormat[DetailedPageLayout]

Inherited by implicit conversion Ensuring from DetailedPageLayout to Ensuring[DetailedPageLayout]

Inherited by implicit conversion ArrowAssoc from DetailedPageLayout to ArrowAssoc[DetailedPageLayout]

Ungrouped

Related Doc: package html

trait DetailedPageLayout extends PageLayout

Type Members

case class Arguments(context: Context, content: NamedContent) extends Product with Serializable

type NamedContent = Map[String, HtmlContents]

Abstract Value Members

abstract def arrangementDescription: Map[String, String]

abstract def description: String

abstract def id: Symbol

implicit abstract def scrupal: Scrupal

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DetailedPageLayout, B)

final def ==(arg0: Any): Boolean

def alternate(args: Arguments): Option[String]

def application(args: Arguments): Option[String]

def apply(context: Context, arrangement: Arrangement): Future[HtmlElement]

final def asInstanceOf[T0]: T0

def authorLink(args: Arguments): Option[String]

def authorName(args: Arguments): Option[String]

def await[X](future: ⇒ Future[X], opName: String)(implicit to: FiniteDuration): Try[X]

def await[X](future: ⇒ Future[X], duration: FiniteDuration, opName: String): Try[X]

def baseTag(args: Arguments): Option[BaseTag]

def bodyTag(args: Arguments): HtmlElement

def clone(): AnyRef

def createLoggerName: String

def curried: (Context) ⇒ (Arrangement) ⇒ Future[HtmlElement]

def description(args: Arguments): Option[String]

def ensuring(cond: (DetailedPageLayout) ⇒ Boolean, msg: ⇒ Any): DetailedPageLayout

def ensuring(cond: (DetailedPageLayout) ⇒ Boolean): DetailedPageLayout

def ensuring(cond: Boolean, msg: ⇒ Any): DetailedPageLayout

def ensuring(cond: Boolean): DetailedPageLayout

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def favIcon(args: Arguments): Option[String]

def finalize(): Unit

def formatted(fmtstr: String): String

def generator(args: Arguments): Option[String]

final def getClass(): Class[_]

def hashCode(): Int

def headTag(args: Arguments): HtmlElement

def iconLink(args: Arguments): Option[IconLinkTag]

def imports(args: Arguments): Seq[String]

final def isInstanceOf[T0]: Boolean

def isRegistered: Boolean

def javascriptLinks(args: Arguments): Seq[String]

def keywords(args: Arguments): Seq[String]

lazy val label: String

def layout(args: Arguments): HtmlElement

def level: Level

def licenseLink(args: Arguments): Option[String]

def links(args: Arguments): List[HtmlElement]

lazy val log: Logger

def loggerName: String

def metas(args: Arguments): List[HtmlElement]

def mkThrowable(msg: String, cause: Option[Throwable] = None): ThrowableWithComponent

final def ne(arg0: AnyRef): Boolean

def notImplemented(what: String): Nothing

final def notify(): Unit

final def notifyAll(): Unit

def otherLinks(args: Arguments): Seq[LinkTag]

def otherMeta(args: Arguments): Map[String, String]

def page(context: Context, arrangement: Arrangement): Future[String]

def pageTitle(args: Arguments): String

def reference: RegistryReference[Layout]

def refresh(args: Arguments): Int

def register(): Unit

def registry: LayoutRegistry

def registryName: String

def scripts(args: Arguments): Seq[String]

def sheets(args: Arguments): Seq[String]

def stylesheetLinks(args: Arguments): Seq[String]

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

implicit val timeout: FiniteDuration

def toParArray: ParArray[T]

def toString(): String

def toss(msg: ⇒ String, cause: Option[Throwable]): Nothing