er.extensions.appserver.navigation
Class ERXModernNavigationMenu

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.components.ERXComponent
              er.extensions.components.ERXNonSynchronizingComponent
                  er.extensions.components.ERXStatelessComponent
                      er.extensions.appserver.navigation.ERXModernNavigationMenu

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, java.io.Serializable, java.lang.Cloneable

public class ERXModernNavigationMenu
extends ERXStatelessComponent

This is an updated ERXNavigationMenu component that should simplify common usage. Used in conjunction with the ERXModernNavigationMenuItem, it creates a navigation menu structure from the entries in the NavigationMenu.plist configuration file. This structure is a "standard" unordered list of (possibly nested) navigation links. Please read "Documentation/Navigation.html" to find out how to use the navigation components.

See Also:

Serialized Form

Author:

Travis Cripps

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

protected boolean	_menuIsSetUp
protected com.webobjects.foundation.NSKeyValueCoding	_navigationContext
protected ERXNavigationState	_navigationState
int	_renderLevelCount
ERXNavigationItem	aNavigationItem
static org.apache.log4j.Logger	log logging support

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERXModernNavigationMenu(com.webobjects.appserver.WOContext context)

Method Summary

void	appendToResponse(com.webobjects.appserver.WOResponse r, com.webobjects.appserver.WOContext c) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.
com.webobjects.appserver.WOActionResults	invokeAction(com.webobjects.appserver.WORequest r, com.webobjects.appserver.WOContext c) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.invokeAction.
com.webobjects.foundation.NSKeyValueCoding	navigationContext()
ERXNavigationState	navigationState()
void	reset()
ERXNavigationItem	rootNode()
void	setUpMenu()
void	takeValuesFromRequest(com.webobjects.appserver.WORequest r, com.webobjects.appserver.WOContext c) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.takeValuesFromRequest.

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless, valueForBooleanBinding, valueForBooleanBinding, valueForBooleanBinding, valueForIntBinding, valueForObjectBinding, valueForObjectBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

aNavigationItem

public ERXNavigationItem aNavigationItem

_navigationState

protected ERXNavigationState _navigationState

_navigationContext

protected com.webobjects.foundation.NSKeyValueCoding _navigationContext

_renderLevelCount

public int _renderLevelCount

_menuIsSetUp

protected boolean _menuIsSetUp

Constructor Detail

ERXModernNavigationMenu

public ERXModernNavigationMenu(com.webobjects.appserver.WOContext context)

Method Detail

reset

public void reset()

Overrides:

reset in class ERXStatelessComponent

navigationContext

public com.webobjects.foundation.NSKeyValueCoding navigationContext()

setUpMenu

public void setUpMenu()

navigationState

public ERXNavigationState navigationState()

rootNode

public ERXNavigationItem rootNode()

takeValuesFromRequest

public void takeValuesFromRequest(com.webobjects.appserver.WORequest r,
                                  com.webobjects.appserver.WOContext c)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.takeValuesFromRequest.

Overrides:

takeValuesFromRequest in class ERXNonSynchronizingComponent

Parameters:

r - from which the values will be taken

c - of the request

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse r,
                             com.webobjects.appserver.WOContext c)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.

Overrides:

appendToResponse in class ERXNonSynchronizingComponent

Parameters:

r - to which we are appending

c - context of the response

invokeAction

public com.webobjects.appserver.WOActionResults invokeAction(com.webobjects.appserver.WORequest r,
                                                             com.webobjects.appserver.WOContext c)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.invokeAction.

Overrides:

invokeAction in class ERXNonSynchronizingComponent

Parameters:

r - for which the action is invoked

c - of the request

Returns:

the result of invoking the action