net.liftweb.sitemap

SiteMap

object SiteMap extends SiteMapSingleton

go to: companion
linear super types: SiteMapSingleton, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SiteMap
  2. SiteMapSingleton
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. trait UnapplyLocMatcher extends AnyRef

    In the PartialFunction for sitemapMutator, you may want to look for a particular Loc in the menu to determine if you want to (1) replace it, (2) add your menus after it or (3) insert your menus under it.

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. def addMenusAtEndMutator (menus: List[Menu]) : (SiteMap) ⇒ SiteMap

    Create a mutator that simply appends the menus to the SiteMap at the end of the sitemap.

    Create a mutator that simply appends the menus to the SiteMap at the end of the sitemap. This is a good default mutator that appends the menu items at the end of the sitemap

    definition classes: SiteMapSingleton
  9. def apply (kids: ConvertableToMenu*) : SiteMap

    definition classes: SiteMapSingleton
  10. 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
  11. def build (kids: Array[ConvertableToMenu]) : SiteMap

    A Java-callable method that builds a SiteMap

    A Java-callable method that builds a SiteMap

    definition classes: SiteMapSingleton
  12. def buildLink (name: String) : NodeSeq

    definition classes: SiteMapSingleton
  13. def buildLink (name: String, text: NodeSeq) : NodeSeq

    definition classes: SiteMapSingleton
  14. def buildMenuMatcher (matchFunc: (net.liftweb.sitemap.Loc.LocParam[_]) ⇒ Boolean) : UnapplyLocMatcher

    Builds an UnapplyLocMatcher

    Builds an UnapplyLocMatcher

    For example:
    <code class="scala">

    val MyMarkerLocParam = new Loc.LocParam[Any]
    val MyMatcher = SiteMap.buildMenuMatcher(_ == MyMarkerLocParam)
    </code>

    definition classes: SiteMapSingleton
  15. 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
  16. var enforceUniqueLinks : Boolean

    By default, Lift enforced unique links in a SiteMap.

    By default, Lift enforced unique links in a SiteMap. However, you can disable this feature by setting enforceUniqueLinks to false

    definition classes: SiteMapSingleton
  17. 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
  18. 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
  19. 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
  20. def findAndTestLoc (name: String) : Box[net.liftweb.sitemap.Loc[_]]

    definition classes: SiteMapSingleton
  21. def findLoc (name: String) : Box[net.liftweb.sitemap.Loc[_]]

    definition classes: SiteMapSingleton
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. var rawIndex_? : Boolean

    Should the top level /index path be rendered as / By default this value is false.

    Should the top level /index path be rendered as / By default this value is false. You may set it to true, but this may confuse some application servers when the application is not running in the root context.

    definition classes: SiteMapSingleton
  29. def readResolve () : AnyRef

    attributes: protected
  30. def simpleSitemapMutator (pf: PartialFunction[Menu, List[Menu]]) : (SiteMap) ⇒ SiteMap

    Builds a function that successively tests the partial function against the Menu.

    Builds a function that successively tests the partial function against the Menu. If the PartialFunction is matched, it is applied and a new Menu is created. This is generally used by modules to insert their menus at locations in the menu hierarchy denoted by a marker Loc.LocParam. If the function does not fire, a copy of the original sitemap is returned.

    pf

    the partial function (pattern match) to test against the Menu, if it matches, apply it which causes menu mutation.

    definition classes: SiteMapSingleton
  31. def sitemapMutator (pf: PartialFunction[Menu, List[Menu]])(or: (SiteMap) ⇒ SiteMap) : (SiteMap) ⇒ SiteMap

    Builds a function that successively tests the partial function against the Menu.

    Builds a function that successively tests the partial function against the Menu. If the PartialFunction is matched, it is applied and a new Menu is created. This is generally used by modules to insert their menus at locations in the menu hierarchy denoted by a marker Loc.LocParam. If the function does not fire, the 'or' function is applied, which allows trying alternative strategies (e.g., if the marker LocParam is not found, append the menus to the root SiteMap.) This method returns a function so that the strategy can be returned from a module and chained: (module1 andThen module2 andThen module3)(baseSitemap).

    pf

    the partial function (pattern match) to test against the Menu, if it matches, apply it which causes menu mutation.

    or

    the function to apply if none of the patterns match

    definition classes: SiteMapSingleton
  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 SiteMapSingleton

Inherited from AnyRef

Inherited from Any