org.deegree_impl.clients.context
Class AbstractModule

java.lang.Object
  org.deegree_impl.clients.context.AbstractModule

All Implemented Interfaces:

Marshallable

public abstract class AbstractModule

extends java.lang.Object

implements Marshallable

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

Field Summary

private java.lang.String	content
private boolean	hidden
private ModuleConfiguration	moduleConfiguration
private java.lang.String	name

Constructor Summary

AbstractModule(java.lang.String name, java.lang.String content, boolean hidden, ModuleConfiguration moduleConfiguration)
Creates a new AbstractModule object.

Method Summary

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
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	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.xml.Marshallable

exportAsXML

Field Detail

moduleConfiguration

private ModuleConfiguration moduleConfiguration

name

private java.lang.String name

content

private java.lang.String content

hidden

private boolean hidden

Constructor Detail

AbstractModule

public AbstractModule(java.lang.String name,
                      java.lang.String content,
                      boolean hidden,
                      ModuleConfiguration moduleConfiguration)

Creates a new AbstractModule object.

Parameters:

name -

hidden -

moduleConfiguration -

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 -

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 -