net.liftweb.sitemap

Loc

object Loc extends AnyRef

The Loc companion object, complete with a nice constructor

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Loc
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Type Members

  1. type AnyLocParam = LocParam[Any]

    A type alias for LocParam instances that are applicable to any Loc

  2. case class CalcParamStateless[-T](f: (Box[T]) ⇒ Boolean) extends LocParam[T] with Product with Serializable

    A function that calculates the statelessness of the Loc for the given request with the parameterized type passed into the function

  3. case class CalcStateless(f: () ⇒ Boolean) extends LocParam[Any] with Product with Serializable

    A function that calculates the statelessness of the Loc for the given request

  4. case class CalcValue[T](func: () ⇒ Box[T]) extends LocParam[T] with Product with Serializable

    Calculate the value for the Loc.

  5. case class DataLoc[T](name: String, link: Link[T], text: LinkText[T], defaultValue: Box[T], xparams: LocParam[T]*) extends Loc[T] with Product with Serializable

  6. trait DispatchLocSnippets extends LocSnippets

    A subclass of LocSnippets with a built in dispatch method (no need to implement isDefinedAt or apply.

  7. case class EarlyResponse(func: () ⇒ Box[LiftResponse]) extends LocParam[Any] with Product with Serializable

    Allows you to generate an early response for the location rather than going through the whole Lift XHTML rendering pipeline

  8. type FailMsg = () ⇒ LiftResponse

  9. case class HttpAuthProtected(role: (Req) ⇒ Box[Role]) extends LocParam[Any] with Product with Serializable

    Indicates that the path denominated by Loc requires HTTP authentication and only a user assigned to this role or to a role that is child-of this role can access it.

  10. case class If(test: () ⇒ Boolean, failMsg: () ⇒ LiftResponse) extends LocParam[Any] with Product with Serializable

    If the test returns True, the page can be accessed, otherwise, the result of FailMsg will be sent as a response to the browser.

  11. case class IfValue[T](test: (Box[T]) ⇒ Boolean, failMsg: () ⇒ LiftResponse) extends LocParam[T] with Product with Serializable

  12. class Link[-T] extends PartialFunction[Req, Box[Boolean]]

    This defines the Link to the Loc.

  13. case class LinkText[-T](text: (T) ⇒ NodeSeq) extends Product with Serializable

    A function that can be used to calculate the link text from the current value encapsulated by the Loc.

  14. case class LocGroup(group: String*) extends LocParam[Any] with Product with Serializable

    If the Loc is in a group (or groups) like "legal" "community" etc.

  15. trait LocInfo[X] extends LocParam[Any]

    An extension point for adding arbitrary lazy values to a Loc.

  16. trait LocParam[-T] extends AnyRef

    Algebraic data type for parameters that modify handling of a Loc in a SiteMap

  17. case class LocQueryParameters[T](f: (Box[T]) ⇒ List[(String, String)]) extends LocParam[T] with Product with Serializable

    Calculate additional query parameters to add as a query string to the Loc

  18. trait LocSnippets extends PartialFunction[String, (NodeSeq) ⇒ NodeSeq] with AnyLocParam

    Allows you to create a handler for many snippets that are associated with a Loc

  19. case class MenuCssClass(cssClass: StringFunc) extends LocParam[Any] with Product with Serializable

    MenuCssClass is used to add css to the Menu node.

  20. case class QueryParameters(f: () ⇒ List[(String, String)]) extends LocParam[Any] with Product with Serializable

    Calculate additional query parameters to add as a query string to the Loc

  21. class Snippet extends LocParam[Any]

    A single snippet that's assocaited with a given location.

  22. case class Template(template: () ⇒ NodeSeq) extends LocParam[Any] with Product with Serializable

    Allows a user to specify a template based upon a function from the current value encapsulated in the Loc

  23. case class TemplateBox(template: () ⇒ Box[NodeSeq]) extends LocParam[Any] with Product with Serializable

    Allows a user to specify a template based upon a function from the current value encapsulated in the Loc.

  24. case class Test(test: (Req) ⇒ Boolean) extends LocParam[Any] with Product with Serializable

    Tests to see if the request actually matches the requirements for access to the page.

  25. case class TestAccess(func: () ⇒ Box[LiftResponse]) extends LocParam[Any] with Product with Serializable

    Allows extra access testing for a given menu location such that you can generically return a response during access control testing

  26. case class TestValueAccess[T](func: (Box[T]) ⇒ Box[LiftResponse]) extends LocParam[T] with Product with Serializable

  27. case class Title[T](title: (T) ⇒ NodeSeq) extends LocParam[T] with Product with Serializable

    This LocParam may be used to specify a function that calculates a title for the page based upon the current value encapsulated by this Loc.

  28. case class Unless(test: () ⇒ Boolean, failMsg: () ⇒ LiftResponse) extends LocParam[Any] with Product with Serializable

    Unless the test returns True, the page can be accessed, otherwise, the result of FailMsg will be sent as a response to the browser.

  29. case class UnlessValue[T](test: (Box[T]) ⇒ Boolean, failMsg: () ⇒ LiftResponse) extends LocParam[T] with Product with Serializable

  30. case class UseParentParams() extends LocParam[Any] with Product with Serializable

    If this is a submenu, use the parent Loc's params

  31. trait UserLocParam[-T] extends LocParam[T]

    Extension point for user-defined LocParam instances.

  32. case class Value[T](value: T) extends LocParam[T] with Product with Serializable

    The value of Loc

  33. case class ValueTemplate[T](template: (Box[T]) ⇒ NodeSeq) extends LocParam[T] with Product with Serializable

  34. case class ValueTemplateBox[T](template: (Box[T]) ⇒ Box[NodeSeq]) extends LocParam[T] with Product with Serializable

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. object ExtLink extends AnyRef

  7. object Hidden extends LocParam[Any] with Product with Serializable

    If this parameter is included, the item will not be visible in the menu, but will still be accessable.

  8. object HideIfNoKids extends LocParam[Any] with Product with Serializable

    If the Loc has no children, hide the Loc itself

  9. object Link extends AnyRef

  10. object LinkText extends Serializable

    The companion object to LinkText that contains some helpful implicit conversion

  11. object PlaceHolder extends LocParam[Any] with Product with Serializable

    The Loc does not represent a menu itself, but is the parent menu for children (implies HideIfNoKids)

  12. object Snippet extends AnyRef

  13. object Stateless extends LocParam[Any] with Product with Serializable

    Is the Loc a stateless Loc.

  14. def apply(name: String, link: Link[Unit], text: LinkText[Unit], params: List[LocParam[Unit]]): Loc[Unit]

  15. def apply(name: String, link: Link[Unit], text: LinkText[Unit], params: LocParam[Unit]*): Loc[Unit]

    Create a Loc (Location) instance

    Create a Loc (Location) instance

    name

    -- the name of the location. This must be unique across your entire sitemap. It's used to look up a menu item in order to create a link to the menu on a page.

    link

    -- the Link to the page

    text

    -- the text to display when the link is displayed

    params

    -- access test, title calculation, etc.

  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. def clone(): AnyRef

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

    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. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  22. def hashCode(): Int

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

    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. implicit def redirectToFailMsg(in: ⇒ RedirectResponse): () ⇒ LiftResponse

  28. implicit def strFuncToFailMsg(in: () ⇒ String): () ⇒ LiftResponse

  29. implicit def strToFailMsg(in: ⇒ String): () ⇒ LiftResponse

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

    Definition Classes
    AnyRef
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any