pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.component.core.site.map
Class MenuResult

java.lang.Object
  extended by org.torweg.pulse.component.core.site.map.MenuResult
All Implemented Interfaces:
JDOMable, Result

public class MenuResult
extends java.lang.Object
implements Result

builds a menu for the website.

Version:
$Revision: 1631 $
Author:
Thomas Weber
See Also:
SitemapMenuController

Constructor Summary
MenuResult(SitemapNode base, java.util.List<SitemapNode> bc, ServiceRequest req)
          builds a new MenuResult.
 
Method Summary
 org.jdom.Element deserializeToJDOM()
          deserialises the menu to a JDOM representation.
 MenuResult setRootNode(SitemapNode root)
          adds the root node to the result.
 MenuResult setRootSelected(boolean flag)
          sets the flag, which indicates whether the selected node is the root node.
 MenuResult setThreeLevelBase(SitemapNode root)
          initialised base of the first three menu levels.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MenuResult

public MenuResult(SitemapNode base,
                  java.util.List<SitemapNode> bc, ServiceRequest req)
builds a new MenuResult.

Parameters:
base - the base node of the menu#
bc - the bread crumb
req - the current request
Method Detail

deserializeToJDOM

public org.jdom.Element deserializeToJDOM()
deserialises the menu to a JDOM representation.

Specified by:
deserializeToJDOM in interface JDOMable
Returns:
the menu as a JDOM representation
See Also:
JDOMable.deserializeToJDOM()

setRootSelected

public final MenuResult setRootSelected(boolean flag)
sets the flag, which indicates whether the selected node is the root node.

Parameters:
flag - the flag
Returns:
this

setRootNode

public final MenuResult setRootNode(SitemapNode root)
adds the root node to the result.

Parameters:
root - the root node
Returns:
this

setThreeLevelBase

public final MenuResult setThreeLevelBase(SitemapNode root)
initialised base of the first three menu levels.

Parameters:
root - the root node
Returns:
this instance