net.liftweb.builtin.snippet.Menu

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Menu
DispatchSnippet
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Type Members

type DispatchIt = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

definition classes: DispatchSnippet

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
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 builder (info: NodeSeq) : NodeSeq

This snippet method renders a menu representing your SiteMap contents.
This snippet method renders a menu representing your SiteMap contents. The menu is rendered as a set of nested unordered lists (<ul />). By default, it only renders nested child menus for menus that match the current request path. You can add the "expandAll" attribute to the snippet tag to force full expansion of all child menus. Additionally, you can use the following attribute prefixes to further customize the generated list and list item elements:
- top - Adds the specified attribute to the top-level <ul> element that makes up the menu
- ul - Adds the specified attribute to each <ul> element (top-level and nested children) that makes up the menu
- li - Adds the specified attribute to each <li> element for the menu
- li_item - Adds the specified attribute to the current page’s menu item
- outer_tag - the tag for the outer XML element (ul by default)
- inner_tag - the tag for the inner XML element (li by default)
- li_path - Adds the specified attribute to the current page’s breadcrumb path. The breadcrumb path is the set of menu items leading to this one.
- linkToSelf - False by default, but available as 'true' to generate link to the current page
- level - Controls the level of menus that will be output. "0" is the top-level menu, "1" is children of the current menu item, and so on. Child menus will be expanded unless the "expand" attribute is set to
```
false
```
  .
- expand - Controls whether or not to expand child menus. Defaults to
```
true
```
  .
For a simple, default menu, simply add
```
  &lt;lift:Menu.builder /&gt;
```
To your template. You can render the entire sitemap with
```
   &lt;lift:Menu.builder expandAll="true" /&gt;
```
Customizing the elements is handled through the prefixed attributes described above. For instance, you could make the current page menu item red:
```
   &lt;lift:Menu.builder li_item:style="color: red;" /&gt;
```
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 dispatch : DispatchIt

definition classes: Menu → DispatchSnippet
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 group (template: NodeSeq) : NodeSeq

Renders a group of menu items.
Renders a group of menu items. You specify a group using the LocGroup LocItem case class on your Menu Loc:
```
val menus =
  Menu(Loc("a",...,...,LocGroup("test"))) ::
  Menu(Loc("b",...,...,LocGroup("test"))) ::
  Menu(Loc("c",...,...,LocGroup("test"))) :: Nil
```
You can then render with the group snippet:
```
&lt;lift:Menu.group group="test" /&gt;
```
Each menu item is rendered as an anchor tag (&lta />), and you can customize the tag using attributes prefixed with "a":
```
&lt;lift:Menu.group group="test" a:class="menulink" /&gt;
```
You can also specify your own template within the Menu.group snippet tag, as long as you provide a <menu:bind /> element where the snippet can place each menu item:
```
&lt;ul&gt;
&lt;lift:Menu.group group="test" &gt;
  &lt;li&gt;&lt;menu:bind /&gt;&lt;/li&gt;
&lt;/lift:Menu.group&gt;
```
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 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 item (text: NodeSeq) : NodeSeq

Renders a specific, named item, based on the name given in the Menu's Loc paramter:
Renders a specific, named item, based on the name given in the Menu's Loc paramter:
```
val menus =
  Menu(Loc("a",...,...,LocGroup("test"))) ::
  Menu(Loc("b",...,...,LocGroup("test"))) ::
  Menu(Loc("c",...,...,LocGroup("test"))) :: Nil
```
You can then select the item using the name attribute:
```
&lt;lift:Menu.item name="b" /&gt;
```
The menu item is rendered as an anchor tag (&lta />). The text for the link defaults to the named Menu's Loc.linkText, but you can specify your own link text by providing contents to the tag:
```
&lt;lift:Menu.item name="b"&gt;This is a link&lt;/lift:Menu.item&gt;
```
Additionally you can customize the tag using attributes prefixed with "a":
```
&lt;lift:Menu.item name="b" a:style="color: red;" /&gt;
```
The param attribute may be used with Menu Locs that are CovertableLoc to parameterize the link
Normally, the Menu item is not shown on pages that match its Menu's Loc. You can set the "donthide" attribute on the tag to force it to show text only (same text as normal, but not in an anchor tag)
Alternatively, you can set the "linkToSelf" attribute to "true" to force a link. You can specify your own link text with the tag's contents. Note that case is significant, so make sure you specify "linkToSelf" and not "linktoself".
def jsonMenu (ignore: NodeSeq) : NodeSeq
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 synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
def title (text: NodeSeq) : NodeSeq

Renders the title for the current request path (location).
Renders the title for the current request path (location). You can use this to automatically set the title for your page based on your SiteMap:
```
...
&lt;head&gt;
  &lt;title&gt;&lt;lift:Menu.title /&gt;&lt;/title&gt;
&lt;/head&gt;
...
```
HTML5 does not support tags inside the <title> tag, so you must do:
```
   * &lt;head&gt;
  &lt;title class=&quot;lift:Menu.title&quote;&gt;The page named %*% is being displayed&lt;/title&gt;
&lt;/head&gt;
```
And Lift will substitute the title at the %*% marker, alternative, Lift will append the Menu.title to the contents of the <title> tag.
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
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

Menu

object Menu extends DispatchSnippet

Type Members

type DispatchIt = PartialFunction[String, (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

def asInstanceOf [T0] : T0

def builder (info: NodeSeq) : NodeSeq

def clone () : AnyRef

def dispatch : DispatchIt

def eq (arg0: AnyRef) : Boolean

def equals (arg0: Any) : Boolean

def finalize () : Unit

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

def group (template: NodeSeq) : NodeSeq

def hashCode () : Int

def isInstanceOf [T0] : Boolean

def item (text: NodeSeq) : NodeSeq

def jsonMenu (ignore: NodeSeq) : NodeSeq

def ne (arg0: AnyRef) : Boolean

def notify () : Unit

def notifyAll () : Unit

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

def title (text: NodeSeq) : NodeSeq

def toString () : String

def wait () : Unit

def wait (arg0: Long, arg1: Int) : Unit

def wait (arg0: Long) : Unit

Inherited from DispatchSnippet

Inherited from AnyRef

Inherited from Any