ERXNavigationComponent.java

//
//  ERXNavigationComponent.java
//  ERExtensions
//
//  Created by Max Muller on Wed Oct 30 2002.
//
package er.extensions.appserver.navigation;

import com.webobjects.appserver.WOComponent;
import com.webobjects.appserver.WOContext;
import com.webobjects.appserver.WOResponse;
import com.webobjects.foundation.NSArray;

/** Please read "Documentation/Navigation.html" to fnd out how to use the navigation components.*/

public abstract class ERXNavigationComponent extends WOComponent {
	/**
	 * Do I need to update serialVersionUID?
	 * See section 5.6 <cite>Type Changes Affecting Serialization</cite> on page 51 of the 
	 * <a href="http://java.sun.com/j2se/1.4/pdf/serial-spec.pdf">Java Object Serialization Spec</a>
	 */
	private static final long serialVersionUID = 1L;

    public ERXNavigationComponent(WOContext context) {
        super(context);
    }
    
    @Override
    public void appendToResponse(WOResponse r, WOContext c) {
        ERXNavigationState state = ERXNavigationManager.manager().navigationStateForSession(session());
        if (shouldSetNavigationState()) {
            state.setState(navigationState());
        } else if (shouldSetNavigationLevel()) {
            state.setStateForLevel(navigationLevelState(), navigationLevel());
        }
        state.setAdditionalState(additionalNavigationState());
        super.appendToResponse(r,c);
    }

    public NSArray navigationState() { return null; }
    public NSArray additionalNavigationState() { return null; }
    public boolean shouldSetNavigationState() { return true; }

    // Support for setting nav levels by themselves.  Nav levels are 1, 2, 3 ...
    public boolean shouldSetNavigationLevel() { return false; }
    public int navigationLevel() { return 0; }
    public String navigationLevelState() { return ""; }
        
}