net.liftweb.sitemap.Loc

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Loc
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Type Members

type LocRewrite = Box[PartialFunction[RewriteRequest, (RewriteResponse, T)]]
type SnippetTest = PartialFunction[(String, Box[T]), (NodeSeq) ⇒ NodeSeq]

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
lazy val _frozenStateless : Boolean

attributes: protected
def _testAccess : Either[Boolean, Box[() ⇒ LiftResponse]]

attributes: protected
object accessTestRes extends RequestVar[Either[Boolean, Box[() ⇒ LiftResponse]]]

attributes: protected
lazy val allParams : List[AnyLocParam]
def appendQueryParameters (in: String, what: Box[T]) : String

attributes: protected
def appendQueryParams (what: T)(nodeSeq: NodeSeq) : NodeSeq

attributes: protected
def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def breadCrumbs : List[net.liftweb.sitemap.Loc[_]]
def buildKidMenuItems (kids: Seq[Menu]) : List[MenuItem]
def buildMenu : CompleteMenu
lazy val cacheCssClassForMenuItem : Box[() ⇒ String]

attributes: protected
def calcHidden (kids: List[MenuItem]) : Boolean

attributes: protected
def calcHref (in: T) : String

Given a value calculate the HREF to this item

Given a value calculate the HREF to this item
lazy val calcSnippets : SnippetTest
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
def calcTemplate : Box[NodeSeq]

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

This method can be overridden to provide a template for this Loc
def childValues : List[T]
def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def createDefaultLink : Option[NodeSeq]
def createLink (in: T) : Option[NodeSeq]
def cssClassForMenuItem : Box[String]

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

When the menu item is displayed, what CSS class do we add to the node?
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
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
def defaultValue : Box[T]

attributes: abstract
def doesMatch_? (req: Req) : Boolean
def earlyResponse : Box[LiftResponse]
def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (arg0: Any) : Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getClass () : java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def hashCode () : Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
def hidden : Boolean
def hideIfNoKids_? : Boolean
def inGroup_? (group: String) : Boolean
def init () : Unit
def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def link : Link[T]

attributes: abstract
def linkText : Box[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
def linkText (in: T) : NodeSeq

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

The link text to be displayed for a value of type T
def menu : Menu
def name : String

attributes: abstract
def ne (arg0: AnyRef) : Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def notify () : Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll () : Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def overrideValue : Box[T]
def paramTemplate : Box[NodeSeq]

The first Loc.

The first Loc.Template or Loc.ValueTemplate in the param list.
lazy val paramTitle : Box[(T) ⇒ NodeSeq]
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)
def params : List[LocParam[T]]

attributes: abstract
def placeHolder_? : Boolean
def queryParameters (what: Box[T]) : List[(String, String)]

Calculate the Query parameters

Calculate the Query parameters
object requestValue extends RequestVar[Box[T]]
def rewrite : LocRewrite
def rewritePF : Box[RewritePF]
def siteMap : SiteMap
def snippet (name: String) : Box[(NodeSeq) ⇒ NodeSeq]
def snippets : SnippetTest
def stateless_? : Boolean

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

Is the Loc marked as Stateless (this will force rendering of the page into stateless mode)
def supplimentalKidMenuItems : List[MenuItem]
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
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.
def testAccess : Either[Boolean, Box[() ⇒ LiftResponse]]
def text : LinkText[T]

attributes: abstract
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.
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.
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: Loc → AnyRef → Any
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef

Loc

trait Loc [T] extends AnyRef

Type Members

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

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

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

lazy val _frozenStateless : Boolean

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

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

lazy val allParams : List[AnyLocParam]

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

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

def asInstanceOf [T0] : T0

def breadCrumbs : List[net.liftweb.sitemap.Loc[_]]

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

def buildMenu : CompleteMenu

lazy val cacheCssClassForMenuItem : Box[() ⇒ String]

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

def calcHref (in: T) : String

lazy val calcSnippets : SnippetTest

def calcStateless () : Boolean

def calcTemplate : Box[NodeSeq]

def childValues : List[T]

def clone () : AnyRef

def createDefaultLink : Option[NodeSeq]

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

def cssClassForMenuItem : Box[String]

def currentValue : Box[T]

def defaultRequestValue : Box[T]

def defaultValue : Box[T]

def doesMatch_? (req: Req) : Boolean

def earlyResponse : Box[LiftResponse]

def eq (arg0: AnyRef) : Boolean

def equals (arg0: Any) : Boolean

def finalize () : Unit

def getClass () : java.lang.Class[_]

def hashCode () : Int

def hidden : Boolean

def hideIfNoKids_? : Boolean

def inGroup_? (group: String) : Boolean

def init () : Unit

def isInstanceOf [T0] : Boolean

def link : Link[T]

def linkText : Box[NodeSeq]

def linkText (in: T) : NodeSeq

def menu : Menu

def name : String

def ne (arg0: AnyRef) : Boolean

def notify () : Unit

def notifyAll () : Unit

def overrideValue : Box[T]

def paramTemplate : Box[NodeSeq]

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

def paramValue : Box[T]

def params : List[LocParam[T]]

def placeHolder_? : Boolean

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

object requestValue extends RequestVar[Box[T]]

def rewrite : LocRewrite

def rewritePF : Box[RewritePF]

def siteMap : SiteMap

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

def snippets : SnippetTest

def stateless_? : Boolean

def supplimentalKidMenuItems : List[MenuItem]

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

def template : Box[NodeSeq]

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

def text : LinkText[T]

def title : NodeSeq

def title (in: T) : NodeSeq

def toString () : String

def wait () : Unit