er.extensions.appserver.navigation
Class ERXNavigationItem

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

public class ERXNavigationItem
extends 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 String	_action
protected NSArray	_children
protected String	_childrenBinding
protected NSDictionary	_childrenChoices
protected NSArray	_childrenConditions
protected NSArray	_conditions
protected String	_directActionClass
protected String	_directActionName
protected String	_displayName
protected String	_hasActivity
protected int	_height
protected String	_name
protected String	_pageName
protected EOQualifier	_qualifier
protected NSDictionary	_queryBindings
String	_uniqueID
protected int	_width
static Logger	log logging supprt

Constructor Summary

ERXNavigationItem(NSDictionary values)

Method Summary

String	action()
NSArray	childItemsInContext(NSKeyValueCodingAdditions context)
NSArray	children()
String	childrenBinding()
NSDictionary	childrenChoices()
NSArray	childrenConditions()
NSArray	conditions()
String	directActionClass()
String	directActionName()
String	displayName()
String	hasActivity()
int	height()
boolean	isRootNode()
boolean	meetsDisplayConditionsInComponent(WOComponent component) Decides whether the item gets displayed at all.
String	name()
String	pageName()
EOQualifier	qualifier()
NSDictionary	queryBindings()
String	toString()
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 Logger log

logging supprt

_uniqueID

public String _uniqueID

_action

protected String _action

_conditions

protected NSArray _conditions

_qualifier

protected 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 _children

_childrenConditions

protected NSArray _childrenConditions

_childrenBinding

protected String _childrenBinding

_childrenChoices

protected NSDictionary _childrenChoices

_queryBindings

protected NSDictionary _queryBindings

_height

protected int _height

_width

protected int _width

Constructor Detail

ERXNavigationItem

public ERXNavigationItem(NSDictionary values)

Method Detail

meetsDisplayConditionsInComponent

public boolean meetsDisplayConditionsInComponent(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 NSArray childItemsInContext(NSKeyValueCodingAdditions context)

isRootNode

public boolean isRootNode()

children

public NSArray children()

qualifier

public EOQualifier qualifier()

childrenBinding

public String childrenBinding()

childrenConditions

public NSArray childrenConditions()

childrenChoices

public NSDictionary childrenChoices()

queryBindings

public NSDictionary queryBindings()

action

public String action()

conditions

public NSArray conditions()

directActionName

public String directActionName()

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