net.liftweb.sitemap

Loc

trait Loc[T] extends AnyRef

A menu location

Linear Supertypes
AnyRef, Any
Known Subclasses
DataLoc
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Loc
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type LocRewrite = Box[PartialFunction[RewriteRequest, (RewriteResponse, T)]]

  2. type SnippetTest = PartialFunction[(String, Box[T]), (NodeSeq) ⇒ NodeSeq]

    A PartialFunction that maps a snippet name, and an optional Loc value, in a Tuple2, to a snippet function (NodeSeq => NodeSeq).

Abstract Value Members

  1. abstract def defaultValue: Box[T]

  2. abstract def link: Link[T]

  3. abstract def name: String

  4. abstract def params: List[LocParam[T]]

  5. abstract def text: LinkText[T]

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. lazy val _foundStatelessCalc: (Box[CalcStateless], Box[CalcParamStateless[T]])

    The cached Loc params

    The cached Loc params

    Attributes
    protected

  5. lazy val _frozenStateless: Boolean

    A lazy val used to track statelessness for non-dev mode.

    A lazy val used to track statelessness for non-dev mode. By default, it calls calcStateless().

    Attributes
    protected

  6. def _testAccess: Either[Boolean, Box[() ⇒ LiftResponse]]

    Attributes
    protected

  7. object accessTestRes extends RequestVar[Either[Boolean, Box[() ⇒ LiftResponse]]]

    Attributes
    protected

  8. def allParams: List[AnyLocParam]

  9. def appendQueryParameters(in: String, what: Box[T]): String

    Attributes
    protected

  10. def appendQueryParams(what: T)(nodeSeq: NodeSeq): NodeSeq

    Attributes
    protected

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. def breadCrumbs: List[Loc[_]]

  13. def buildKidMenuItems(kids: Seq[Menu]): List[MenuItem]

  14. def buildMenu: CompleteMenu

  15. lazy val cacheCssClassForMenuItem: Box[() ⇒ String]

    By default, this lazy val looks for the MenuCssClass LocParam and uses it.

    By default, this lazy val looks for the MenuCssClass LocParam and uses it.

    Attributes
    protected

  16. def calcDefaultHref: String

    Calculate HREF to this item using currentValue

  17. def calcHidden(kids: List[MenuItem]): Boolean

    Attributes
    protected

  18. def calcHref(in: T): String

    Given a value calculate the HREF to this item

  19. lazy val calcSnippets: SnippetTest

    The snippets provided by LocParams

  20. def calcStateless(): Boolean

    The method to calculate if this Loc is stateless.

    The method to calculate if this Loc is stateless. By default looks for the Loc.Stateless Param

    Attributes
    protected

  21. def calcTemplate: Box[NodeSeq]

    This method can be overridden to provide a template for this Loc

  22. def childValues: List[T]

  23. def clone(): AnyRef

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

  24. def createDefaultLink: Option[NodeSeq]

  25. def createLink(in: T): Option[NodeSeq]

  26. def cssClassForMenuItem: Box[String]

    When the menu item is displayed, what CSS class do we add to the node?

  27. def currentValue: Box[T]

    The current value of the cell: overrideValue or requestValue.

    The current value of the cell: overrideValue or requestValue.is or defaultValue oe paramValue

  28. def defaultRequestValue: Box[T]

    Override this if the default request value should be something other than Empty

    Override this if the default request value should be something other than Empty

    Attributes
    protected

  29. def doesMatch_?(req: Req): Boolean

  30. def earlyResponse: Box[LiftResponse]

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

    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  33. def finalize(): Unit

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

  34. def findStatelessCalc: (Box[CalcStateless], Box[CalcParamStateless[T]])

    Find the stateless calculation Loc params

    Find the stateless calculation Loc params

    Attributes
    protected

  35. def foundStatelessCalc: (Box[CalcStateless], Box[CalcParamStateless[T]])

    Attributes
    protected

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

    Definition Classes
    AnyRef → Any

  37. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  38. def hidden: Boolean

  39. def hideIfNoKids_?: Boolean

  40. def inGroup_?(group: String): Boolean

  41. def init(): Unit

  42. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  43. def linkText: Box[NodeSeq]

    The title of the location given the current value associated with this Loc

  44. def linkText(in: T): NodeSeq

    The link text to be displayed for a value of type T

  45. def menu: Menu

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

    Definition Classes
    AnyRef

  47. final def notify(): Unit

    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  49. def overrideValue: Box[T]

  50. def paramTemplate: Box[NodeSeq]

    The first Loc.

    The first Loc.Template or Loc.ValueTemplate in the param list.

  51. lazy val paramTitle: Box[(T) ⇒ NodeSeq]

    The first Loc.

    The first Loc.Title in the param list.

  52. def paramValue: Box[T]

    The value of the Loc based on params (either Loc.

    The value of the Loc based on params (either Loc.Value or Loc.CalcValue)

  53. def placeHolder_?: Boolean

  54. def queryParameters(what: Box[T]): List[(String, String)]

    Calculate the Query parameters

  55. def reqCalcStateless(): Boolean

    run the stateless calculation

    run the stateless calculation

    Attributes
    protected

  56. object requestValue extends RequestVar[Box[T]]

  57. def rewrite: LocRewrite

  58. def rewritePF: Box[RewritePF]

  59. def siteMap: SiteMap

  60. def snippet(name: String): Box[(NodeSeq) ⇒ NodeSeq]

    Look up a snippet by name, taking into account the current Loc value.

  61. def snippets: SnippetTest

    The snippets defined by the Loc class itself, as opposed to those provided by its LocParams.

  62. def stateless_?: Boolean

    Is the Loc marked as Stateless (this will force rendering of the page into stateless mode)

  63. def supplementalKidMenuItems: List[MenuItem]

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

    Definition Classes
    AnyRef

  65. def template: Box[NodeSeq]

    The template assocaited with this Loc, if any.

    The template assocaited with this Loc, if any. Any Loc.Template or Loc.ValueTemplate parameter will take precedence over a value returned by the calcTemplate method.

  66. def testAccess: Either[Boolean, Box[() ⇒ LiftResponse]]

  67. def title: NodeSeq

    The title of the location given the current value associated with this Loc.

    The title of the location given the current value associated with this Loc. If no current value is available, this will use the name of this Loc as the title.

  68. def title(in: T): NodeSeq

    The title to be displayed for the value associated with this Loc.

    The title to be displayed for the value associated with this Loc. Any Loc.Title parameter will take precedence over the value returned by the linkText method.

  69. def toString(): String

    Definition Classes
    Loc → AnyRef → Any

  70. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. final def supplimentalKidMenuItems: List[MenuItem]

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6) Use supplementalKidMenuItems with an 'e'. This misspelled variant will be removed in Lift 3.0.

Inherited from AnyRef

Inherited from Any

Ungrouped