uk.ac.ed.epcc.webapp.servlet.navigation

Class Node

java.lang.Object

uk.ac.ed.epcc.webapp.servlet.navigation.NodeContainer

uk.ac.ed.epcc.webapp.servlet.navigation.Node

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ExactNode, ExternalNode, ParentNode

public abstract class Node
extends NodeContainer
implements java.io.Externalizable

This represents a node in the navigational menu. Its a lightweight representation of the information built by the NavigationMenuService. It can be sub-classed to support different matching methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	AUTO_LANDING_FEATURE

Fields inherited from class uk.ac.ed.epcc.webapp.servlet.navigation.NodeContainer

children

Constructor Summary

Constructors

Constructor and Description
Node()

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor vis)
char	getAccessKey(AppContext conn)
java.lang.String	getDisplayClass(AppContext conn)
java.lang.String	getHelpText()
java.lang.String	getImage()
java.lang.String	getMenuText(AppContext conn) get the menu text
NodeContainer	getParent()
java.lang.String	getPostImageText()
java.lang.String	getTargetAttr()
java.lang.String	getTargetPath(AppContext conn) get the location (url not including the context path) the menu item should navigate to.
java.lang.String	getTargetURL(ServletService servlet_service) get the full url for the target location
abstract boolean	matches(ServletService serv) does the original requested page match the target space
void	readExternal(java.io.ObjectInput in)
void	setAccessKey(char key)
void	setDisplayClass(java.lang.String text)
void	setHelpText(java.lang.String help_text)
void	setImage(java.lang.String image)
void	setMenuText(java.lang.String text)
void	setParent(NodeContainer parent)
void	setPostImageText(java.lang.String text)
void	setTargetPath(java.lang.String target) set the location (notmally not including the context path the menu item should navigate to.
java.lang.String	toString()
boolean	useLandingPage(AppContext conn)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class uk.ac.ed.epcc.webapp.servlet.navigation.NodeContainer

addChild, getChildren, getDate, getID, isEmpty, setID

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_LANDING_FEATURE

public static final Feature AUTO_LANDING_FEATURE

Constructor Detail

Node

public Node()

Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class NodeContainer

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class NodeContainer

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getTargetPath

public java.lang.String getTargetPath(AppContext conn)

get the location (url not including the context path) the menu item should navigate to.

Returns:

getTargetAttr

public java.lang.String getTargetAttr()

useLandingPage

public boolean useLandingPage(AppContext conn)

Parameters:

conn -

Returns:

getTargetURL

public java.lang.String getTargetURL(ServletService servlet_service)

get the full url for the target location

Parameters:

request -

Returns:

getMenuText

public java.lang.String getMenuText(AppContext conn)

get the menu text

Returns:

getDisplayClass

public java.lang.String getDisplayClass(AppContext conn)

getAccessKey

public char getAccessKey(AppContext conn)

setTargetPath

public void setTargetPath(java.lang.String target)

set the location (notmally not including the context path the menu item should navigate to.

Parameters:

target -

setMenuText

public void setMenuText(java.lang.String text)

setDisplayClass

public void setDisplayClass(java.lang.String text)

setAccessKey

public void setAccessKey(char key)

matches

public abstract boolean matches(ServletService serv)

does the original requested page match the target space

Parameters:

serv -

Returns:

getImage

public java.lang.String getImage()

getPostImageText

public java.lang.String getPostImageText()

setImage

public void setImage(java.lang.String image)

setPostImageText

public void setPostImageText(java.lang.String text)

setParent

public void setParent(NodeContainer parent)

getParent

public NodeContainer getParent()

accept

public void accept(Visitor vis)

Overrides:

accept in class NodeContainer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHelpText

public java.lang.String getHelpText()

Returns:

the help_text

setHelpText

public void setHelpText(java.lang.String help_text)

Parameters:

help_text - the help_text to set