net.liftweb.sitemap

Loc

object Loc extends AnyRef

The Loc companion object, complete with a nice constructor

go to: companion
linear super types: 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
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type AnyLocParam = LocParam[Any]

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

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

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

    Calculate the value for the Loc.

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

  4. trait DispatchLocSnippets extends LocSnippets

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

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

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

  6. type FailMsg = () ⇒ LiftResponse

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

    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.

  8. case class If (test: () ⇒ Boolean, failMsg: FailMsg) extends LocParam[Any] with Product

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

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

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

    This defines the Link to the Loc.

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

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

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

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

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

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

  14. trait LocParam [-T] extends AnyRef

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

  15. case class LocQueryParameters [T] (f: (Box[T]) ⇒ List[(String, String)]) extends Product

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

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

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

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

    MenuCssClass is used to add css to the Menu node.

  18. case class QueryParameters (f: () ⇒ List[(String, String)]) extends Product

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

  19. class Snippet extends LocParam[Any]

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

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

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

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

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

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

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

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

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

    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.

  25. case class Unless (test: () ⇒ Boolean, failMsg: FailMsg) extends LocParam[Any] with Product

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

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

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

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

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

    Extension point for user-defined LocParam instances.

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

    The value of Loc

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

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. 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
  3. def ## () : Int

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

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

    attributes: final
    definition classes: AnyRef
  6. 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
  7. 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
  8. object ExtLink extends AnyRef

  9. object Hidden extends LocParam[Any] with Product

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

  10. object HideIfNoKids extends LocParam[Any] with Product

    If the Loc has no children, hide the Loc itself

  11. object Link extends AnyRef

  12. object LinkText extends AnyRef

    The companion object to LinkText that contains some helpful implicit conversion

  13. object PlaceHolder extends LocParam[Any] with Product

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

  14. object Snippet extends AnyRef

  15. object Stateless extends LocParam[Any] with Product

    Is the Loc a stateless Loc.

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

  17. 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.

  18. 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
  19. 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
  20. 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
  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. 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
  29. implicit def redirectToFailMsg (in: ⇒ RedirectResponse) : FailMsg

    attributes: implicit
  30. implicit def strFuncToFailMsg (in: () ⇒ String) : FailMsg

    attributes: implicit
  31. implicit def strToFailMsg (in: ⇒ String) : FailMsg

    attributes: implicit
  32. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  33. 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: AnyRef → Any
  34. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from AnyRef

Inherited from Any