Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.grails.plugin.platform
[Groovy] Class NavigationTagLib

java.lang.Object
  org.grails.plugin.platform.NavigationTagLib

class NavigationTagLib

todo:
TEST impl custom on nav:menu/breadcrumb

Property Summary
java.lang.Object activeNode

Return the current active navigation node, or the node specified by the path attribute
java.lang.Object activePath

Return the current active path
java.lang.Object firstActiveNode

Return the first node in the activation path specified, or based on current activation path @attr path Optional activation path
java.lang.Object grailsApplication

java.lang.Object grailsNavigation

java.lang.Object items

java.lang.Object menu

Render a menu for a given scope and path

attr:
scope Optional scope to render menu for.
static java.lang.Object namespace

java.lang.Object primary

Render a primary navigation menu

attr:
path Optional activation path.
static java.lang.Object returnObjectForTags

java.lang.Object scopeForActivationPath

Return the name of the root scope of the supplied or default activation path @attr path Optional activation path
java.lang.Object secondary

Render the secondary navigation menu

attr:
path Optional activation path.
java.lang.Object set

Set a value on the current request.

java.lang.Object title

Render the i18n title of a navigation item

attr:
item The navigation item (instance of NavigationItem)
attr:
codec Optional codec to apply.
 
Constructor Summary
NavigationTagLib()

 
Method Summary
private NavigationScope findNode(java.lang.String activePath)

private java.util.List findNodes(java.lang.String activePath)

private java.lang.Object findScopeForActivationPath(java.lang.Object path)

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

activeNode

java.lang.Object activeNode
Return the current active navigation node, or the node specified by the path attribute

activePath

java.lang.Object activePath
Return the current active path

firstActiveNode

java.lang.Object firstActiveNode
Return the first node in the activation path specified, or based on current activation path
attr:
path Optional activation path

grailsApplication

java.lang.Object grailsApplication

grailsNavigation

java.lang.Object grailsNavigation

items

java.lang.Object items

menu

java.lang.Object menu
Render a menu for a given scope and path
attr:
scope Optional scope to render menu for. Defaults to "app", but could be any valid scope i.e. "app/messages/archive"
attr:
path Optional activation path indicating what is currently active.
attr:
class Optional

namespace

static java.lang.Object namespace

primary

java.lang.Object primary
Render a primary navigation menu
attr:
path Optional activation path. If not specified, uses current request's activation path
attr:
scope Optional scope of menu to render. If not specified, uses default scope determined by activation path or "app"
attr:
class Optional css class for the outer

    returnObjectForTags

    static java.lang.Object returnObjectForTags

    scopeForActivationPath

    java.lang.Object scopeForActivationPath
    Return the name of the root scope of the supplied or default activation path
    attr:
    path Optional activation path

    secondary

    java.lang.Object secondary
    Render the secondary navigation menu
    attr:
    path Optional activation path. If not specified, uses current request's activation path ONLY IF current activation path is in the same scope used for nav:primary
    attr:
    scope Optional scope of menu to render. If not specified, uses default scope determined by activation path or "app"
    attr:
    class Optional css class for the outer

      set

      java.lang.Object set
      Set a value on the current request. You can set the default scope to make menu/primary default to something other than "app" or the current active path's scope, and you can set the active path for this request.
      attr:
      scope Optional - scope to default to
      attr:
      path Optional - active path to use

      title

      java.lang.Object title
      Render the i18n title of a navigation item
      attr:
      item The navigation item (instance of NavigationItem)
      attr:
      codec Optional codec to apply. If none specified defaults to HTML

       
      Constructor Detail

      NavigationTagLib

      NavigationTagLib()

       
      Method Detail

      findNode

      private NavigationScope findNode(java.lang.String activePath)

      findNodes

      private java.util.List findNodes(java.lang.String activePath)

      findScopeForActivationPath

      private java.lang.Object findScopeForActivationPath(java.lang.Object path)

       

      Groovy Documentation