com.liferay.portal.kernel.theme

Class NavItem

java.lang.Object

com.liferay.portal.kernel.theme.NavItem

All Implemented Interfaces:

java.io.Serializable

public class NavItem
extends java.lang.Object
implements java.io.Serializable

Represents a portal navigation item, providing access to layouts and metadata from templates, which can be found in a theme's portal-normal.vm.

Author:

Brian Wing Shun Chan, Shuyang Zhou

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NavItem(javax.servlet.http.HttpServletRequest request, Layout layout, java.util.Map<java.lang.String,java.lang.Object> contextObjects)
NavItem(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, Layout layout, java.util.Map<java.lang.String,java.lang.Object> contextObjects)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static java.util.List<NavItem>	fromLayouts(javax.servlet.http.HttpServletRequest request, java.util.List<Layout> layouts, java.util.Map<java.lang.String,java.lang.Object> contextObjects) Deprecated. As of Judson (7.1.x), replaced by fromLayouts(HttpServletRequest, ThemeDisplay, Map)
static java.util.List<NavItem>	fromLayouts(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, java.util.Map<java.lang.String,java.lang.Object> contextObjects)
java.util.List<NavItem>	getBrowsableChildren() Returns all of the browsable child layouts that the current user has permission to access from this navigation item's layout.
java.util.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.
java.lang.String	getName() Returns the HTML-escaped name of the navigation item's layout.
java.lang.String	getRegularFullURL() Returns the full, absolute URL (including the portal's URL) of the navigation item's layout.
java.lang.String	getRegularURL() Returns the regular URL of the navigation item's layout.
java.lang.String	getResetLayoutURL()
java.lang.String	getResetMaxStateURL()
java.lang.String	getTarget() Returns the target of the navigation item's layout.
java.lang.String	getTitle() Returns the title of the navigation item's layout in the current request's locale.
java.lang.String	getUnescapedName() Returns the unescaped name of the navigation item's layout in the current request's locale.
java.lang.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()
java.lang.String	iconURL()
boolean	isBrowsable()
boolean	isChildSelected()
boolean	isInNavigation(java.util.List<NavItem> navItems)
boolean	isSelected()

Methods inherited from class java.lang.Object

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

Constructor Detail

NavItem

public NavItem(javax.servlet.http.HttpServletRequest request,
               Layout layout,
               java.util.Map<java.lang.String,java.lang.Object> contextObjects)

NavItem

public NavItem(javax.servlet.http.HttpServletRequest request,
               ThemeDisplay themeDisplay,
               Layout layout,
               java.util.Map<java.lang.String,java.lang.Object> contextObjects)

Method Detail

fromLayouts

@Deprecated
public static java.util.List<NavItem> fromLayouts(javax.servlet.http.HttpServletRequest request,
                                                              java.util.List<Layout> layouts,
                                                              java.util.Map<java.lang.String,java.lang.Object> contextObjects)

Deprecated. As of Judson (7.1.x), replaced by fromLayouts(HttpServletRequest, ThemeDisplay, Map)

Creates a single level of navigation items from the layouts. Navigation items for nested layouts are only created when they are accessed.

No permission checks are performed in this method. Permissions of child layouts are honored when accessing them via getChildren().

Parameters:

request - the currently served HttpServletRequest

layouts - the layouts from which to create the navigation items

Returns:

a single level of navigation items from the layouts, or null if the collection of layouts was null.

fromLayouts

public static java.util.List<NavItem> fromLayouts(javax.servlet.http.HttpServletRequest request,
                                                  ThemeDisplay themeDisplay,
                                                  java.util.Map<java.lang.String,java.lang.Object> contextObjects)
                                           throws PortalException

Throws:

PortalException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBrowsableChildren

public java.util.List<NavItem> getBrowsableChildren()
                                             throws java.lang.Exception

Returns all of the browsable child layouts that the current user has permission to access from this navigation item's layout.

Returns:

the list of all browsable child layouts that the current user has permission to access from this navigation item's layout

Throws:

java.lang.Exception - if an exception occurred

getChildren

public java.util.List<NavItem> getChildren()
                                    throws java.lang.Exception

Returns all of child layouts that the current user has permission to access from this navigation item's layout.

Returns:

the list of all child layouts that the current user has permission to access from this navigation item's layout

Throws:

java.lang.Exception - if an exception occurred

getLayout

public Layout getLayout()

Returns the navigation item's layout.

Returns:

the navigation item's layout

getLayoutId

public long getLayoutId()

Returns the ID of the navigation item's layout.

Returns:

the ID of the navigation item's layout

getName

public java.lang.String getName()

Returns the HTML-escaped name of the navigation item's layout.

Returns:

the HTML-escaped name of the navigation item's layout

getRegularFullURL

public java.lang.String getRegularFullURL()
                                   throws java.lang.Exception

Returns the full, absolute URL (including the portal's URL) of the navigation item's layout.

Returns:

the full, absolute URL of the navigation item's layout

Throws:

java.lang.Exception - if an exception occurred

getRegularURL

public java.lang.String getRegularURL()
                               throws java.lang.Exception

Returns the regular URL of the navigation item's layout.

Returns:

the regular URL of the navigation item's layout

Throws:

java.lang.Exception - if an exception occurred

getResetLayoutURL

public java.lang.String getResetLayoutURL()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getResetMaxStateURL

public java.lang.String getResetMaxStateURL()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getTarget

public java.lang.String getTarget()

Returns the target of the navigation item's layout.

Returns:

the target of the navigation item's layout

getTitle

public java.lang.String getTitle()

Returns the title of the navigation item's layout in the current request's locale.

Returns:

the title of the navigation item's layout in the current request's locale

getUnescapedName

public java.lang.String getUnescapedName()

Returns the unescaped name of the navigation item's layout in the current request's locale.

Returns:

the unescaped name of the navigation item's layout in the current request's locale

getURL

public java.lang.String getURL()
                        throws java.lang.Exception

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

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

Throws:

java.lang.Exception - if an exception occurred

hasBrowsableChildren

public boolean hasBrowsableChildren()
                             throws java.lang.Exception

Returns true if the navigation item's layout has browsable child layouts.

Returns:

true if the navigation item's layout has browsable child layouts; false otherwise

Throws:

java.lang.Exception - if an exception occurred

hasChildren

public boolean hasChildren()
                    throws java.lang.Exception

Returns true if the navigation item's layout has child layouts.

Returns:

true if the navigation item's layout has child layouts; false otherwise

Throws:

java.lang.Exception - if an exception occurred

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

iconURL

public java.lang.String iconURL()
                         throws java.lang.Exception

Throws:

java.lang.Exception

isBrowsable

public boolean isBrowsable()

isChildSelected

public boolean isChildSelected()
                        throws PortalException

Throws:

PortalException

isInNavigation

public boolean isInNavigation(java.util.List<NavItem> navItems)

isSelected

public boolean isSelected()
                   throws java.lang.Exception

Throws:

java.lang.Exception