|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.theme.NavItem
public class NavItem
Represents a portal navigation item, providing access to layouts and metadata
from templates, which can be found in a theme's
portal-normal.vm.
| Constructor Summary | |
|---|---|
NavItem(javax.servlet.http.HttpServletRequest request,
Layout layout,
Map<String,Object> contextObjects)
|
|
| Method Summary | |
|---|---|
boolean |
equals(Object obj)
|
static List<NavItem> |
fromLayouts(javax.servlet.http.HttpServletRequest request,
List<Layout> layouts,
Map<String,Object> contextObjects)
Creates a single level of navigation items from the layouts. |
List<NavItem> |
getBrowsableChildren()
Returns all of the browsable child layouts that the current user has permission to access from this navigation item's layout. |
List<NavItem> |
getChildren()
Returns all of child layouts that the current user has permission to access from this navigation item's layout. |
Layout |
getLayout()
Returns the navigation item's layout. |
long |
getLayoutId()
Returns the ID of the navigation item's layout. |
String |
getName()
Returns the HTML-escaped name of the navigation item's layout. |
String |
getRegularFullURL()
Returns the full, absolute URL (including the portal's URL) of the navigation item's layout. |
String |
getRegularURL()
Returns the regular URL of the navigation item's layout. |
String |
getResetLayoutURL()
|
String |
getResetMaxStateURL()
|
String |
getTarget()
Returns the target of the navigation item's layout. |
String |
getTitle()
Returns the title of the navigation item's layout in the current request's locale. |
String |
getUnescapedName()
Returns the unescaped name of the navigation item's layout in the current request's locale. |
String |
getURL()
Returns the URL of the navigation item's layout, in a format that makes it safe to use the URL as an HREF attribute value |
boolean |
hasBrowsableChildren()
Returns true if the navigation item's layout has browsable
child layouts. |
boolean |
hasChildren()
Returns true if the navigation item's layout has child
layouts. |
int |
hashCode()
|
String |
iconURL()
|
boolean |
isBrowsable()
|
boolean |
isChildSelected()
|
boolean |
isInNavigation(List<NavItem> navItems)
|
boolean |
isSelected()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public NavItem(javax.servlet.http.HttpServletRequest request,
Layout layout,
Map<String,Object> contextObjects)
| Method Detail |
|---|
public static List<NavItem> fromLayouts(javax.servlet.http.HttpServletRequest request,
List<Layout> layouts,
Map<String,Object> contextObjects)
No permission checks are performed in this method. Permissions of child
layouts are honored when accessing them via getChildren().
request - the currently served HttpServletRequestlayouts - the layouts from which to create the navigation items
null if the collection of layouts was
null.public boolean equals(Object obj)
equals in class Object
public List<NavItem> getBrowsableChildren()
throws Exception
Exception - if an exception occurred
public List<NavItem> getChildren()
throws Exception
Exception - if an exception occurredpublic Layout getLayout()
public long getLayoutId()
public String getName()
public String getRegularFullURL()
throws Exception
Exception - if an exception occurred
public String getRegularURL()
throws Exception
Exception - if an exception occurred
public String getResetLayoutURL()
throws Exception
Exception
public String getResetMaxStateURL()
throws Exception
Exceptionpublic String getTarget()
public String getTitle()
public String getUnescapedName()
public String getURL()
throws Exception
Exception - if an exception occurred
public boolean hasBrowsableChildren()
throws Exception
true if the navigation item's layout has browsable
child layouts.
true if the navigation item's layout has browsable
child layouts; false otherwise
Exception - if an exception occurred
public boolean hasChildren()
throws Exception
true if the navigation item's layout has child
layouts.
true if the navigation item's layout has child
layouts; false otherwise
Exception - if an exception occurredpublic int hashCode()
hashCode in class Object
public String iconURL()
throws Exception
Exceptionpublic boolean isBrowsable()
public boolean isChildSelected()
throws PortalException
PortalExceptionpublic boolean isInNavigation(List<NavItem> navItems)
public boolean isSelected()
throws Exception
Exception
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||