Object/Class

net.liftweb.sitemap

SiteMap

Related Docs: class SiteMap | package sitemap

Permalink

object SiteMap extends SiteMapSingleton with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SiteMap
  2. Serializable
  3. Serializable
  4. SiteMapSingleton
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait UnapplyLocMatcher extends AnyRef

    Permalink

    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.

    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. You can create a pattern matcher via buildMenuMatcher which returns an instance of UnapplyLocMatcher.

    For example:

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

    Definition Classes
    SiteMapSingleton

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addMenusAtEndMutator(menus: List[Menu]): (SiteMap) ⇒ SiteMap

    Permalink

    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
  5. def apply(kids: ConvertableToMenu*): SiteMap

    Permalink
    Definition Classes
    SiteMapSingleton
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def build(kids: Array[ConvertableToMenu]): SiteMap

    Permalink

    A Java-callable method that builds a SiteMap

    A Java-callable method that builds a SiteMap

    Definition Classes
    SiteMapSingleton
  8. def buildLink(name: String): NodeSeq

    Permalink
    Definition Classes
    SiteMapSingleton
  9. def buildLink(name: String, text: NodeSeq): NodeSeq

    Permalink
    Definition Classes
    SiteMapSingleton
  10. def buildMenuMatcher(matchFunc: (LocParam[_]) ⇒ Boolean): UnapplyLocMatcher

    Permalink

    Builds an UnapplyLocMatcher

    Builds an UnapplyLocMatcher

    For example:

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

    Definition Classes
    SiteMapSingleton
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. var enforceUniqueLinks: Boolean

    Permalink

    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
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def findAndTestLoc(name: String): Box[Loc[_]]

    Permalink
    Definition Classes
    SiteMapSingleton
  17. def findLoc(name: String): Box[Loc[_]]

    Permalink
    Definition Classes
    SiteMapSingleton
  18. final def getClass(): Class[_]

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. var rawIndex_?: Boolean

    Permalink

    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
  25. def simpleSitemapMutator(pf: PartialFunction[Menu, List[Menu]]): (SiteMap) ⇒ SiteMap

    Permalink

    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.

    returns

    a function which will apply the changes to a SiteMap

    Definition Classes
    SiteMapSingleton
  26. def sitemapMutator(pf: PartialFunction[Menu, List[Menu]])(or: (SiteMap) ⇒ SiteMap): (SiteMap) ⇒ SiteMap

    Permalink

    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

    returns

    a function which will apply the changes to a SiteMap

    Definition Classes
    SiteMapSingleton
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from SiteMapSingleton

Inherited from AnyRef

Inherited from Any

Ungrouped