Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

info.crossbar.model.sitemap
Class Menu  view Menu download Menu.java

java.lang.Object
  extended byinfo.crossbar.model.sitemap.Menu

public class Menu
extends java.lang.Object

Class used only within the Sitemap class.


Field Summary
(package private)  java.util.HashMap displayNames
           
private static java.util.logging.Logger log
          Set up logging.
(package private)  java.lang.String name
           
(package private)  java.util.ArrayList roles
           
(package private)  java.util.TreeMap sortOrdering
           
 
Constructor Summary
Menu()
           
 
Method Summary
private static boolean accessAllowed(javax.servlet.http.HttpServletRequest request, java.util.List roles)
          Checks if the user is in a role allowed access to an element, unless the element is designated as accessible to a "public" role.
 java.lang.String getDisplayName(java.lang.String locale)
           
 java.util.ArrayList getItems()
           
 java.util.ArrayList getItems(javax.servlet.http.HttpServletRequest request, java.util.HashMap categories)
          Return a list of menu categories.
 java.lang.String getName()
           
 java.util.ArrayList getRoles()
           
 java.lang.String getSortOrder(java.lang.String sortOrder)
           
 void setDisplayName(java.lang.String locale, java.lang.String displayName)
           
 void setName(java.lang.String value)
           
 void setRole(java.lang.String role)
           
 void setSortOrder(java.lang.String sortOrder, java.lang.String name)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

private static java.util.logging.Logger log
Set up logging.


name

java.lang.String name

displayNames

java.util.HashMap displayNames

sortOrdering

java.util.TreeMap sortOrdering

roles

java.util.ArrayList roles
Constructor Detail

Menu

public Menu()
Method Detail

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


getName

public java.lang.String getName()

setName

public void setName(java.lang.String value)

getDisplayName

public java.lang.String getDisplayName(java.lang.String locale)

setDisplayName

public void setDisplayName(java.lang.String locale,
                           java.lang.String displayName)

getSortOrder

public java.lang.String getSortOrder(java.lang.String sortOrder)

setSortOrder

public void setSortOrder(java.lang.String sortOrder,
                         java.lang.String name)

getRoles

public java.util.ArrayList getRoles()

setRole

public void setRole(java.lang.String role)

getItems

public java.util.ArrayList getItems()

getItems

public java.util.ArrayList getItems(javax.servlet.http.HttpServletRequest request,
                                    java.util.HashMap categories)
Return a list of menu categories. By default, the HttpServletRequest will be null and the user will not be allowed to see any categories meant for users in a specific role.


accessAllowed

private static boolean accessAllowed(javax.servlet.http.HttpServletRequest request,
                                     java.util.List roles)
Checks if the user is in a role allowed access to an element, unless the element is designated as accessible to a "public" role.