ERXNavigationItem (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.appserver.navigation.ERXNavigationItem

All Implemented Interfaces:

Serializable
```
public class ERXNavigationItem
extends Object
implements Serializable
```
A "backing store" for the properties of a single navigation item in the tree of navigation items. Configured by the ERXNavigationManager from a dictionary stored in the navigation menu plist file. Please read "Documentation/Navigation.html" to fnd out how to use the navigation components.

See Also:

ERXNavigationManager, ERXNavigationMenuItem, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_action`
`protected NSArray<String>`	`_children`
`protected String`	`_childrenBinding`
`protected NSDictionary`	`_childrenChoices`
`protected NSArray`	`_childrenConditions`
`protected NSArray`	`_conditions`
`protected String`	`_defaultChild`
`protected String`	`_directActionClass`
`protected String`	`_directActionName`
`protected String`	`_displayName`
`protected String`	`_hasActivity`
`protected int`	`_height`
`protected String`	`_href`
`protected String`	`_name`
`protected String`	`_pageName`
`protected ERXNavigationItem`	`_parent`
`protected com.webobjects.eocontrol.EOQualifier`	`_qualifier`
`protected NSDictionary`	`_queryBindings`
`protected String`	`_secure`
`String`	`_uniqueID`
`protected int`	`_width`

Constructor Summary

Constructors
Constructor and Description

ERXNavigationItem(NSDictionary values)

Constructors
Constructor and Description
`ERXNavigationItem(NSDictionary values)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`action()`
`NSArray`	`childItemsInContext(com.webobjects.foundation.NSKeyValueCodingAdditions context)`
`NSArray<String>`	`children()`
`String`	`childrenBinding()`
`NSDictionary`	`childrenChoices()`
`NSArray`	`childrenConditions()`
`NSArray`	`conditions()`
`String`	`defaultChild()`
`String`	`directActionClass()`
`String`	`directActionName()`
`String`	`displayName()`
`String`	`hasActivity()`
`int`	`height()`
`String`	`href()`
`boolean`	`isRootNode()`
`boolean`	`meetsDisplayConditionsInComponent(com.webobjects.foundation.NSKeyValueCodingAdditions context)` Decides whether the item gets displayed at all.
`String`	`name()`
`String`	`navigationPath()` Returns path of this navigationMenuItem starting from the top menu except the root navigation item separated by /.
`String`	`pageName()`
`ERXNavigationItem`	`parent()`
`com.webobjects.eocontrol.EOQualifier`	`qualifier()`
`NSDictionary`	`queryBindings()`
`Boolean`	`secureInContext(com.webobjects.foundation.NSKeyValueCodingAdditions context)`
`void`	`setDefaultChild(String name)`
`void`	`setParent(ERXNavigationItem item)`
`String`	`toString()`
`String`	`uneditedDirectActionName()`
`String`	`uniqueID()`
`int`	`width()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_uniqueID
```
public String _uniqueID
```

_action
```
protected String _action
```

_conditions
```
protected NSArray _conditions
```

_qualifier

protected com.webobjects.eocontrol.EOQualifier _qualifier

_directActionName
```
protected String _directActionName
```

_directActionClass
```
protected String _directActionClass
```

_name
```
protected String _name
```

_pageName
```
protected String _pageName
```

_displayName
```
protected String _displayName
```

_hasActivity
```
protected String _hasActivity
```

_children
```
protected NSArray<String> _children
```

_defaultChild
```
protected String _defaultChild
```

_childrenConditions
```
protected NSArray _childrenConditions
```

_childrenBinding
```
protected String _childrenBinding
```

_childrenChoices

protected NSDictionary _childrenChoices

_queryBindings
```
protected NSDictionary _queryBindings
```

_href
```
protected String _href
```

_secure
```
protected String _secure
```

_parent
```
protected ERXNavigationItem _parent
```

_height
```
protected int _height
```

_width
```
protected int _width
```

Constructor Detail

ERXNavigationItem

public ERXNavigationItem(NSDictionary values)

Method Detail

meetsDisplayConditionsInComponent
```
public boolean meetsDisplayConditionsInComponent(com.webobjects.foundation.NSKeyValueCodingAdditions context)
```
Decides whether the item gets displayed at all. This is done by evaluating the boolean value of a "conditions" array in the definition file. eg: conditions = ("session.user.canEditThisStuff", "session.user.isEditor") will display the item only if the user can edit this stuff *and* is an editor. You can set OR conditions with conditions = (("session.user.canEditThisStuff", "session.user.isEditor"))

Parameters:

context - in which to evaluate visibility

Returns:

true if the item meets display conditions

childItemsInContext

public NSArray childItemsInContext(com.webobjects.foundation.NSKeyValueCodingAdditions context)

secureInContext

public Boolean secureInContext(com.webobjects.foundation.NSKeyValueCodingAdditions context)

isRootNode
```
public boolean isRootNode()
```

children
```
public NSArray<String> children()
```

qualifier

public com.webobjects.eocontrol.EOQualifier qualifier()

childrenBinding
```
public String childrenBinding()
```

childrenConditions
```
public NSArray childrenConditions()
```

childrenChoices
```
public NSDictionary childrenChoices()
```

defaultChild
```
public String defaultChild()
```

setDefaultChild

public void setDefaultChild(String name)

queryBindings
```
public NSDictionary queryBindings()
```

action
```
public String action()
```

conditions
```
public NSArray conditions()
```

href
```
public String href()
```

directActionName
```
public String directActionName()
```

uneditedDirectActionName

public String uneditedDirectActionName()

directActionClass
```
public String directActionClass()
```

height
```
public int height()
```

width
```
public int width()
```

name
```
public String name()
```

pageName
```
public String pageName()
```

uniqueID
```
public String uniqueID()
```

displayName
```
public String displayName()
```

hasActivity
```
public String hasActivity()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

parent
```
public ERXNavigationItem parent()
```

setParent

public void setParent(ERXNavigationItem item)

navigationPath
```
public String navigationPath()
```
Returns path of this navigationMenuItem starting from the top menu except the root navigation item separated by /. ex: topMenuItem/secondlevelmenuitem/thirdlevelnavItem NOTE: navigationPath doesn't include rootNavigationItem.

Returns:

String navigationPath

Class ERXNavigationItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_uniqueID

_action

_conditions

_qualifier

_directActionName

_directActionClass

_name

_pageName

_displayName

_hasActivity

_children

_defaultChild

_childrenConditions

_childrenBinding

_childrenChoices

_queryBindings

_href

_secure

_parent

_height

_width

Constructor Detail

ERXNavigationItem

Method Detail

meetsDisplayConditionsInComponent

childItemsInContext

secureInContext

isRootNode

children

qualifier

childrenBinding

childrenConditions

childrenChoices

defaultChild

setDefaultChild

queryBindings

action

conditions

href

directActionName

uneditedDirectActionName

directActionClass

height

width

name

pageName

uniqueID

displayName

hasActivity

toString

parent

setParent

navigationPath