org.deegree.clients.context
Interface Module

All Known Implementing Classes:

Module_Impl

public interface Module

describes the common access to modules embedded into the GUI described by general extension section of a web map context document within the deegree framework.

a module encapsulates GUI elements and/or functions that are used by the GUI. The concrete implementation of the GUI (e.g. as JSP pages) is responsible for enabling the commuication between the different modules of a context.

Version:

$Revision: 1.2 $

Author:

Andreas Poth

Method Summary

void	addParameter(Parameter parameter) adds a parameter to the list of parameters that will be passed to a class/object etc. that represents a module
java.lang.String	getContent() returns the name of the page/class/file etc. containing the content of the module
ModuleConfiguration	getModuleConfiguration() returns the a specific confguration for a module.
java.lang.String	getName() returns the name of a module
ParameterList	getParameter() returns a list of parameters that will be passed to a class/object etc.
boolean	isHidden() returns true if the module is hidden. this will always be the case for modules that just offers functions to the context. visible modules may offere the capability to be turned to visible or not.
void	removeParameter(java.lang.String name) removes a parameter to the list of parameters that will be passed to a class/object etc. that represents a module
void	setContent(java.lang.String content) sets the name of the page/class/file etc. containing the content of the module
void	setHidden(boolean hidden) sets the module to be hidden or visible. modules that only adds functions to a context will ignore this because they are always hidden
void	setModuleConfiguration(ModuleConfiguration configuration) sets the specific configuration for a module.
void	setName(java.lang.String name) sets the name of a module
void	setParameter(ParameterList parameterList) sets a list of parameters that will be passed to a class/object etc.

Method Detail

getName

public java.lang.String getName()

returns the name of a module

Returns:

setName

public void setName(java.lang.String name)

sets the name of a module

Parameters:

name -

getContent

public java.lang.String getContent()

returns the name of the page/class/file etc. containing the content of the module

setContent

public void setContent(java.lang.String content)

sets the name of the page/class/file etc. containing the content of the module

Parameters:

content -

isHidden

public boolean isHidden()

returns true if the module is hidden. this will always be the case for modules that just offers functions to the context. visible modules may offere the capability to be turned to visible or not.

Returns:

setHidden

public void setHidden(boolean hidden)

sets the module to be hidden or visible. modules that only adds functions to a context will ignore this because they are always hidden

Parameters:

hidden -

getParameter

public ParameterList getParameter()

returns a list of parameters that will be passed to a class/object etc. that represents a module

Returns:

parameters

setParameter

public void setParameter(ParameterList parameterList)

sets a list of parameters that will be passed to a class/object etc. that represents a module

Parameters:

parameterList -

addParameter

public void addParameter(Parameter parameter)

adds a parameter to the list of parameters that will be passed to a class/object etc. that represents a module

Parameters:

parameter -

removeParameter

public void removeParameter(java.lang.String name)

removes a parameter to the list of parameters that will be passed to a class/object etc. that represents a module

Parameters:

name -

getModuleConfiguration

public ModuleConfiguration getModuleConfiguration()

returns the a specific confguration for a module. This may be null if the module doesn't need to be configured.

Returns:

setModuleConfiguration

public void setModuleConfiguration(ModuleConfiguration configuration)

sets the specific configuration for a module.

Parameters:

configuration -