com.waveset.ui
Class PageNavigation

java.lang.Object
  extended bycom.waveset.ui.PageNavigation

public class PageNavigation
extends java.lang.Object

Generates navigation according to the "wavesetnav.properties" file. Makes generic titles if page isn't in props.


Nested Class Summary
 class PageNavigation.ControlTopAccessFilter
          Extends PageNavigation.DefaultAccessFilter to confirm not only required permissions, but also that the specified subject controls Top (the global Organization folder).
 class PageNavigation.DefaultAccessFilter
           
 
Field Summary
static java.lang.String code_id
           
protected static Trace trace
           
 
Constructor Summary
PageNavigation()
           
PageNavigation(java.lang.String title, java.lang.String url)
           
PageNavigation(java.lang.String title, java.lang.String url, boolean forceURLMapping)
           
PageNavigation(java.lang.String title, java.lang.String url, boolean forceURLMapping, int andRequiredPerms, int checkAuthTypeSubTypes)
           
PageNavigation(java.lang.String title, java.lang.String url, int andRequiredPerms)
           
PageNavigation(java.lang.String title, java.lang.String url, int andRequiredPerms, int checkAuthTypeSubTypes)
           
PageNavigation(java.lang.String title, java.lang.String url, Permission[] perms)
           
 
Method Summary
 void addContainedURL(java.lang.String URL)
           
 void addSubPage(PageNavigation p)
           
 boolean andRequiredPerms()
           
 void blockURL(java.lang.String URL)
           
 boolean checkAuthTypeSubTypes()
           
 boolean containsSubPage(java.lang.String url)
           
 boolean containsURL(javax.servlet.http.HttpServletRequest req)
           
 AccessFilter getAccessFilter()
           
 java.lang.String getIcon()
           
 java.lang.String[] getProducts()
           
 java.util.List getRequiredAdmins()
           
 Permission[] getRequiredPerms()
           
 PageNavigation[] getSubPages()
           
 java.lang.String getTitle()
           
 java.lang.String getUrl()
           
 boolean isBlank()
           
 void removeAllSubPages()
           
 void removeSubPage(PageNavigation p)
           
 void setAccessFilter(AccessFilter af)
          Specifies an PageNavigation.DefaultAccessFilter to determine whether a specific Session should be allowed to access this navigation item ("tab").
 void setBlank(boolean blank)
           
 void setIcon(java.lang.String icon)
           
 void setProducts(java.lang.String[] p)
           
 void setRequiredPerms(Permission[] perms)
           
 void setTitle(java.lang.String title)
           
 void setURL(java.lang.String url)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

trace

protected static final Trace trace
Constructor Detail

PageNavigation

public PageNavigation()

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url)

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url,
                      Permission[] perms)

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url,
                      boolean forceURLMapping)

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url,
                      int andRequiredPerms)

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url,
                      int andRequiredPerms,
                      int checkAuthTypeSubTypes)

PageNavigation

public PageNavigation(java.lang.String title,
                      java.lang.String url,
                      boolean forceURLMapping,
                      int andRequiredPerms,
                      int checkAuthTypeSubTypes)
Method Detail

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getUrl

public java.lang.String getUrl()

setURL

public void setURL(java.lang.String url)

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)

isBlank

public boolean isBlank()

setBlank

public void setBlank(boolean blank)

getRequiredPerms

public Permission[] getRequiredPerms()

setRequiredPerms

public void setRequiredPerms(Permission[] perms)

checkAuthTypeSubTypes

public boolean checkAuthTypeSubTypes()

andRequiredPerms

public boolean andRequiredPerms()

getAccessFilter

public AccessFilter getAccessFilter()

setAccessFilter

public void setAccessFilter(AccessFilter af)
Specifies an PageNavigation.DefaultAccessFilter to determine whether a specific Session should be allowed to access this navigation item ("tab").

The default behavior is to allow access to any Session whose Subject has the "required permissions".


getRequiredAdmins

public java.util.List getRequiredAdmins()

getSubPages

public PageNavigation[] getSubPages()

addSubPage

public void addSubPage(PageNavigation p)

removeSubPage

public void removeSubPage(PageNavigation p)

removeAllSubPages

public void removeAllSubPages()

getProducts

public java.lang.String[] getProducts()

setProducts

public void setProducts(java.lang.String[] p)

containsURL

public boolean containsURL(javax.servlet.http.HttpServletRequest req)
Returns:
true if this navigation item "owns" this URL; otherwise false. This method is used to highlight the menus and to pick which subnav items to include.

containsSubPage

public boolean containsSubPage(java.lang.String url)

addContainedURL

public void addContainedURL(java.lang.String URL)

blockURL

public void blockURL(java.lang.String URL)

toString

public java.lang.String toString()