org.apache.turbine.modules
Class Navigation

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Navigation

Direct Known Subclasses:

DefaultBottomNavigation, DefaultTopNavigation, TemplateNavigation

public abstract class Navigation

extends Assembler

This is the base class that defines what a Navigation module is.

Version:

$Id: Navigation.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson, Henning P. Schmiedehausen

Constructor Summary

Navigation()

Method Summary

protected org.apache.ecs.ConcreteElement	build(RunData data) Subclasses can override this method to add additional functionality.
protected abstract org.apache.ecs.ConcreteElement	doBuild(RunData data) A subclass must override this method to build itself.
static java.lang.String	prepareText(java.lang.String s) Deprecated. Use InputFilterUtils.prepareText(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigation

public Navigation()

Method Detail

doBuild

protected abstract org.apache.ecs.ConcreteElement doBuild(RunData data)
                                                   throws java.lang.Exception

A subclass must override this method to build itself. Subclasses override this method to store the navigation in RunData or to write the navigation to the output stream referenced in RunData.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

build

protected org.apache.ecs.ConcreteElement build(RunData data)
                                        throws java.lang.Exception

Subclasses can override this method to add additional functionality. This method is protected to force clients to use NavigationLoader to build a Navigation.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

prepareText

public static java.lang.String prepareText(java.lang.String s)

Deprecated. Use InputFilterUtils.prepareText(String s)

This function can/should be used in any screen that will output User entered text. This will help prevent users from entering html ( SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.