com.plumtree.portaluiinfrastructure.navtype
Class NavAreaEnum

java.lang.Object
  com.plumtree.portaluiinfrastructure.navtype.NavAreaEnum

public class NavAreaEnum
extends java.lang.Object

Enumerates the view names, by area, of the page where you can supply navigation. View names must be unique and be defined in GetName() in the view implementation See dynamic loading, MVC names examples; must implement IView or extend of it The areas and their meanings are: ABOVEBODY: Return the name of the view for the area below the banner, or null if not implemented. RIGHTOFBODY: Return the name of the view for the area right of the page, or null if not implemented. LEFTOFBODY: Return the name of the view for the area left of the page, or null if not implemented. BELOWBODY: Return the name of the view for the area above the footer, or null if not implemented. BELOWBANNER: Return the name of the view for the area below the Header, or null if not implemented. ABOVEBANNER: Return the name of the view for the area above the Header, or null if not implemented. BELOWFOOTER: Return the name of the view for the area below the footer, or null if not implemented. ABOVEFOOTER: Return the name of the view for the area above the footer, or null if not implemented. TOPBAR: Return the name of the view for the topbar area, or null if not implemented.

Author:

DavidP, michaeld

Field Summary

static NavAreaEnum	ABOVEBANNER
static NavAreaEnum	ABOVEBODY
static NavAreaEnum	ABOVEFOOTER
static NavAreaEnum	BELOWBANNER
static NavAreaEnum	BELOWBODY
static NavAreaEnum	BELOWFOOTER
static NavAreaEnum	LEFTOFBODY
static NavAreaEnum[]	m_navAreaEnums
static NavAreaEnum	RIGHTOFBODY
static NavAreaEnum	TOPBAR

Method Summary

boolean	equals(java.lang.Object o)
int	GetID() Retrieves the integer ID for this navigation page area.
java.lang.String	GetName() Retrieves the String Name for this navigation page area.
static NavAreaEnum	GetNavArea(java.lang.String aName) Converts the NavArea Name provied as string to the integer id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ABOVEBANNER

public static final NavAreaEnum ABOVEBANNER

BELOWBANNER

public static final NavAreaEnum BELOWBANNER

ABOVEBODY

public static final NavAreaEnum ABOVEBODY

LEFTOFBODY

public static final NavAreaEnum LEFTOFBODY

RIGHTOFBODY

public static final NavAreaEnum RIGHTOFBODY

BELOWBODY

public static final NavAreaEnum BELOWBODY

ABOVEFOOTER

public static final NavAreaEnum ABOVEFOOTER

BELOWFOOTER

public static final NavAreaEnum BELOWFOOTER

TOPBAR

public static final NavAreaEnum TOPBAR

m_navAreaEnums

public static final NavAreaEnum[] m_navAreaEnums

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

GetNavArea

public static NavAreaEnum GetNavArea(java.lang.String aName)

Converts the NavArea Name provied as string to the integer id.

Returns:

areaId valid navarea id if exists or -1 if no NavArea name matched.

GetID

public int GetID()

Retrieves the integer ID for this navigation page area.

Returns:

int

GetName

public java.lang.String GetName()

Retrieves the String Name for this navigation page area.

Returns:

String

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)