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 an interface that defines what a Navigation module is.

Version:
$Id: Navigation.java,v 1.1.1.1 2001/08/16 05:08:29 jvanzyl Exp $
Author:
Dave Bryson

Field Summary
private static org.apache.ecs.filter.CharacterFilter filter
           
 
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.
private static org.apache.ecs.filter.CharacterFilter htmlFilter()
          These attributes are supposed to be the default, but they are not, at least in ECS 1.2.
static java.lang.String prepareText(java.lang.String s)
          This function can/should be used in any screen that will output User entered text.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

filter

private static final org.apache.ecs.filter.CharacterFilter filter
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)
This function can/should be used in any screen that will output User entered text. This will help prevent users from entering html (