StandardMetadata

Represents metadata for a page.

layout: The fully-qualified class name for the layout to use
usingDefaultLayout: If true, indicates that the page is using the default layout
weight: A weight used for page ordering in menus and other structures
render: Whether or not to render the page
title: If not None, represents the title to associate with the page
link: If not None, represents an alternative link for the page used in menus and other renderings
redirect: If not None, represents the url the page will use as the destination for redirection (ignoring any other settings such as layout); does nothing if render is false
fake: If true, indicates that the page is fake and should not be rendered or used anywhere
other: All other metadata properties that were provided that do not match reserved properties

Linear Supertypes

Serializable, Serializable, Product, Equals, Metadata, AnyRef, Any

Instance Constructors

new StandardMetadata(layout: String, usingDefaultLayout: Boolean, weight: Double, render: Boolean, title: Option[String], link: Option[String], redirect: Option[String], fake: Boolean, other: Map[String, Seq[String]])

layout
The fully-qualified class name for the layout to use
usingDefaultLayout
If true, indicates that the page is using the default layout
weight
A weight used for page ordering in menus and other structures
render
Whether or not to render the page
title
If not None, represents the title to associate with the page
link
If not None, represents an alternative link for the page used in menus and other renderings
redirect
If not None, represents the url the page will use as the destination for redirection (ignoring any other settings such as layout); does nothing if render is false
fake
If true, indicates that the page is fake and should not be rendered or used anywhere
other
All other metadata properties that were provided that do not match reserved properties

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fake: Boolean

If true, indicates that the page is fake and should not be rendered or used anywhere
If true, indicates that the page is fake and should not be rendered or used anywhere

Definition Classes
StandardMetadata → Metadata
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val layout: String

The fully-qualified class name for the layout to use
The fully-qualified class name for the layout to use

Definition Classes
StandardMetadata → Metadata
val link: Option[String]

If not None, represents an alternative link for the page used in menus and other renderings
If not None, represents an alternative link for the page used in menus and other renderings

Definition Classes
StandardMetadata → Metadata
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val other: Map[String, Seq[String]]

All other metadata properties that were provided that do not match reserved properties
All other metadata properties that were provided that do not match reserved properties

Definition Classes
StandardMetadata → Metadata
val redirect: Option[String]

If not None, represents the url the page will use as the destination for redirection (ignoring any other settings such as layout); does nothing if render is false
If not None, represents the url the page will use as the destination for redirection (ignoring any other settings such as layout); does nothing if render is false

Definition Classes
StandardMetadata → Metadata
val render: Boolean

Whether or not to render the page
Whether or not to render the page

Definition Classes
StandardMetadata → Metadata
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val title: Option[String]

If not None, represents the title to associate with the page
If not None, represents the title to associate with the page

Definition Classes
StandardMetadata → Metadata
val usingDefaultLayout: Boolean

If true, indicates that the page is using the default layout
If true, indicates that the page is using the default layout

Definition Classes
StandardMetadata → Metadata
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( ... )
val weight: Double

A weight used for page ordering in menus and other structures
A weight used for page ordering in menus and other structures

Definition Classes
StandardMetadata → Metadata

Related Docs: object StandardMetadata | package structures

case class StandardMetadata(layout: String, usingDefaultLayout: Boolean, weight: Double, render: Boolean, title: Option[String], link: Option[String], redirect: Option[String], fake: Boolean, other: Map[String, Seq[String]]) extends Metadata with Product with Serializable

Instance Constructors

new StandardMetadata(layout: String, usingDefaultLayout: Boolean, weight: Double, render: Boolean, title: Option[String], link: Option[String], redirect: Option[String], fake: Boolean, other: Map[String, Seq[String]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val fake: Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val layout: String

val link: Option[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val other: Map[String, Seq[String]]

val redirect: Option[String]

val render: Boolean

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

val title: Option[String]

val usingDefaultLayout: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val weight: Double

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Metadata

Inherited from AnyRef

Inherited from Any

Ungrouped