org.jaffa.components.navigation
Class NavOption

java.lang.Object
  org.jaffa.components.navigation.NavOption

public class NavOption

extends Object

This object represents a node in the menu structure

Author:

JonnyR

Field Summary

static String	TYPE_COMPONENT
static String	TYPE_DESKTOP
static String	TYPE_SUB_MENU
static String	TYPE_URL

Constructor Summary

NavOption(NavAccessor nav, MenuOption mOpt)
Creates a new instance of NavOption from a menu option.

Method Summary

List	getChildren() Returns a list of children (navOptions) that are under this node in the structure
String	getComponent() Returns the component's ID in case the URL has to be built my hand.
String	getDesktopId() Returns the unique Id assigned to this desktop.
String	getLabel() Method returns the String for the menu option
String	getParameters() Returns a string of any parameters necessary for the URL.
String	getStrutsTileTemplate() Returns the StrutsTileTemplate
String	getType() Returns the menu type
String	getURL() Returns a URL that will either be complete or partial.
boolean	isComponent() Returns the menu type
boolean	isDesktop() Returns the menu type
boolean	isSubMenu() Returns the menu type
boolean	isURL() Returns the menu type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_COMPONENT

public static final String TYPE_COMPONENT

See Also:

Constant Field Values

TYPE_DESKTOP

public static final String TYPE_DESKTOP

See Also:

Constant Field Values

TYPE_URL

public static final String TYPE_URL

See Also:

Constant Field Values

TYPE_SUB_MENU

public static final String TYPE_SUB_MENU

See Also:

Constant Field Values

Constructor Detail

NavOption

public NavOption(NavAccessor nav,
                 MenuOption mOpt)
          throws SecurityException

Creates a new instance of NavOption from a menu option.

Throws:

SecurityException - if the user should not have access to this option

Method Detail

getChildren

public List getChildren()

Returns a list of children (navOptions) that are under this node in the structure

Returns:

List continaing navOption objects

getLabel

public String getLabel()

Method returns the String for the menu option

Returns:

String that is the text to be displayed on the menu

getURL

public String getURL()

Returns a URL that will either be complete or partial.

Returns:

The String to build the URL on the HTML page.

getParameters

public String getParameters()

Returns a string of any parameters necessary for the URL.

Returns:

Returns a string that is any paramaters necessary for the URL.

getComponent

public String getComponent()

Returns the component's ID in case the URL has to be built my hand.

Returns:

Returns a string that is the component's ID

getDesktopId

public String getDesktopId()

Returns the unique Id assigned to this desktop.

Returns:

Returns a string that is the desktop's ID

getType

public String getType()

Returns the menu type

Returns:

Returns the type of menu option

getStrutsTileTemplate

public String getStrutsTileTemplate()

Returns the StrutsTileTemplate

Returns:

Returns the StrutsTileTemplate of menu option

isDesktop

public boolean isDesktop()

Returns the menu type

Returns:

Returns true if this is a desktop

isSubMenu

public boolean isSubMenu()

Returns the menu type

Returns:

Returns true if this is a sub menu, either in the Global or Desktop menu

isComponent

public boolean isComponent()

Returns the menu type

Returns:

Returns true if this is a component action

isURL

public boolean isURL()

Returns the menu type

Returns:

Returns true if this is a url action