er.extensions.appserver.navigation
Class ERXNavigationItem

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

public class ERXNavigationItem
extends java.lang.Object

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:

er.extensions.ERXNavigationManager, er.extensions.ERXNavigationMenuItem

Field Summary

protected java.lang.String	_action
protected com.webobjects.foundation.NSArray	_children
protected java.lang.String	_childrenBinding
protected com.webobjects.foundation.NSDictionary	_childrenChoices
protected com.webobjects.foundation.NSArray	_childrenConditions
protected com.webobjects.foundation.NSArray	_conditions
protected java.lang.String	_directActionClass
protected java.lang.String	_directActionName
protected java.lang.String	_displayName
protected java.lang.String	_hasActivity
protected int	_height
protected java.lang.String	_href
protected java.lang.String	_name
protected java.lang.String	_pageName
protected com.webobjects.eocontrol.EOQualifier	_qualifier
protected com.webobjects.foundation.NSDictionary	_queryBindings
java.lang.String	_uniqueID
protected int	_width
static org.apache.log4j.Logger	log logging supprt

Constructor Summary

ERXNavigationItem(com.webobjects.foundation.NSDictionary values)

Method Summary

java.lang.String	action()
com.webobjects.foundation.NSArray	childItemsInContext(com.webobjects.foundation.NSKeyValueCodingAdditions context)
com.webobjects.foundation.NSArray	children()
java.lang.String	childrenBinding()
com.webobjects.foundation.NSDictionary	childrenChoices()
com.webobjects.foundation.NSArray	childrenConditions()
com.webobjects.foundation.NSArray	conditions()
java.lang.String	directActionClass()
java.lang.String	directActionName()
java.lang.String	displayName()
java.lang.String	hasActivity()
int	height()
java.lang.String	href()
boolean	isRootNode()
boolean	meetsDisplayConditionsInComponent(com.webobjects.appserver.WOComponent component) Decides whether the item gets displayed at all.
java.lang.String	name()
java.lang.String	pageName()
com.webobjects.eocontrol.EOQualifier	qualifier()
com.webobjects.foundation.NSDictionary	queryBindings()
java.lang.String	toString()
java.lang.String	uniqueID()
int	width()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.apache.log4j.Logger log

logging supprt

_uniqueID

public java.lang.String _uniqueID

_action

protected java.lang.String _action

_conditions

protected com.webobjects.foundation.NSArray _conditions

_qualifier

protected com.webobjects.eocontrol.EOQualifier _qualifier

_directActionName

protected java.lang.String _directActionName

_directActionClass

protected java.lang.String _directActionClass

_name

protected java.lang.String _name

_pageName

protected java.lang.String _pageName

_displayName

protected java.lang.String _displayName

_hasActivity

protected java.lang.String _hasActivity

_children

protected com.webobjects.foundation.NSArray _children

_childrenConditions

protected com.webobjects.foundation.NSArray _childrenConditions

_childrenBinding

protected java.lang.String _childrenBinding

_childrenChoices

protected com.webobjects.foundation.NSDictionary _childrenChoices

_queryBindings

protected com.webobjects.foundation.NSDictionary _queryBindings

_href

protected java.lang.String _href

_height

protected int _height

_width

protected int _width

Constructor Detail

ERXNavigationItem

public ERXNavigationItem(com.webobjects.foundation.NSDictionary values)

Method Detail

meetsDisplayConditionsInComponent

public boolean meetsDisplayConditionsInComponent(com.webobjects.appserver.WOComponent component)

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:

component - context to evaluate visibility in

childItemsInContext

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

isRootNode

public boolean isRootNode()

children

public com.webobjects.foundation.NSArray children()

qualifier

public com.webobjects.eocontrol.EOQualifier qualifier()

childrenBinding

public java.lang.String childrenBinding()

childrenConditions

public com.webobjects.foundation.NSArray childrenConditions()

childrenChoices

public com.webobjects.foundation.NSDictionary childrenChoices()

queryBindings

public com.webobjects.foundation.NSDictionary queryBindings()

action

public java.lang.String action()

conditions

public com.webobjects.foundation.NSArray conditions()

href

public java.lang.String href()

directActionName

public java.lang.String directActionName()

directActionClass

public java.lang.String directActionClass()

height

public int height()

width

public int width()

name

public java.lang.String name()

pageName

public java.lang.String pageName()

uniqueID

public java.lang.String uniqueID()

displayName

public java.lang.String displayName()

hasActivity

public java.lang.String hasActivity()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object