net.sf.navigator.displayer
Interface MenuDisplayer

All Known Implementing Classes:

AbstractMenuDisplayer, CoolMenuDisplayer, CoolMenuDisplayer4, CSSListMenuDisplayer, DropDownMenuDisplayer, ListMenuDisplayer, MessageResourcesMenuDisplayer, PermissionsFormMenuDisplayer, SimpleMenuDisplayer, TabbedMenuDisplayer, VelocityMenuDisplayer, XtreeMenuDisplayer

public interface MenuDisplayer

Version:

Author:

ssayles

Field Summary

static String	_SELF
static String	DEFAULT_CONFIG
static String	EMPTY
static String	NBSP

Method Summary

void	display(MenuComponent menu)
void	end(javax.servlet.jsp.PageContext pageContext) Lifecycle method that should be called when the MenuDisplayer is done being used.
String	getConfig() Returns the name of the message resources bundle that contains display and/or configuration definitions.
String	getName() Returns the name of the MenuDisplayer.
PermissionsAdapter	getPermissionsAdapter() Getter for property permissionsAdapter.
String	getTarget() Returns the target name for any hrefs that may be generated.
void	init(javax.servlet.jsp.PageContext pageContext, MenuDisplayerMapping mapping) Lifecycle method that should be called when the MenuDisplayer is being prepared for use.
void	setConfig(String config) Sets the name of the message resources bundle that contains display and/or configuration definitions.
void	setName(String name) Sets the name of the MenuDisplayer
void	setPermissionsAdapter(PermissionsAdapter permissionsAdapter) Setter for property permissionsAdapter.
void	setTarget(String target) Setter for property target.

Field Detail

DEFAULT_CONFIG

static final String DEFAULT_CONFIG

See Also:

Constant Field Values

_SELF

static final String _SELF

See Also:

Constant Field Values

NBSP

static final String NBSP

See Also:

Constant Field Values

EMPTY

static final String EMPTY

See Also:

Constant Field Values

Method Detail

display

void display(MenuComponent menu)
             throws javax.servlet.jsp.JspException,
                    IOException

Throws:

javax.servlet.jsp.JspException

IOException

getName

String getName()

Returns the name of the MenuDisplayer.

Returns:

Value of property name.

setName

void setName(String name)

Sets the name of the MenuDisplayer

Parameters:

name - New value of property name.

getConfig

String getConfig()

Returns the name of the message resources bundle that contains display and/or configuration definitions.

Returns:

Value of property config.

setConfig

void setConfig(String config)

Sets the name of the message resources bundle that contains display and/or configuration definitions.

Parameters:

config - New value of property config.

getTarget

String getTarget()

Returns the target name for any hrefs that may be generated.

Returns:

the value for target.

setTarget

void setTarget(String target)

Setter for property target.

Parameters:

target - New value of property target.

init

void init(javax.servlet.jsp.PageContext pageContext,
          MenuDisplayerMapping mapping)

Lifecycle method that should be called when the MenuDisplayer is being prepared for use.

Parameters:

pageContext - The JSP pageContext to give the displayer access to any resources it may need.

mapping - The menu displayer mapping used to embody the xml definition.

end

void end(javax.servlet.jsp.PageContext pageContext)

Lifecycle method that should be called when the MenuDisplayer is done being used.

Parameters:

pageContext - The JSP pageContext to give the displayer access to any resources it may need.

getPermissionsAdapter

PermissionsAdapter getPermissionsAdapter()

Getter for property permissionsAdapter.

Returns:

Value of property permissionsAdapter.

setPermissionsAdapter

void setPermissionsAdapter(PermissionsAdapter permissionsAdapter)

Setter for property permissionsAdapter.

Parameters:

permissionsAdapter - New value of property permissionsAdapter.