org.deegree.portal.context
Class Module

java.lang.Object
  org.deegree.portal.context.Module

public class Module
extends java.lang.Object

this class encapsulates the basic informations of a module that is part of an area of the GUI. Other classes may extent this class by adding special attributes for more specialazied GUIs.

Version:

$Revision: 23790 $, $Date: 2010-04-23 14:22:04 +0200 (Fr, 23 Apr 2010) $

Author:

Andreas Poth, last edited by: $Author: jmays $

Constructor Summary

Module(java.lang.String name, java.lang.String title, java.lang.String content, boolean hidden, java.lang.String type, int left, int top, int right, int bottom, int width, int height, boolean overlay, boolean header, boolean closable, boolean collapsed, java.lang.String scrolling, java.lang.String[] moduleJSList, ModuleConfiguration moduleConfiguration, ParameterList parameterList)
Creates a new Module object.

Module(java.lang.String name, java.lang.String title, java.lang.String content, boolean hidden, java.lang.String type, int left, int top, int right, int bottom, int width, int height, boolean overlay, boolean header, boolean closable, java.lang.String scrolling, java.lang.String[] moduleJSList, ModuleConfiguration moduleConfiguration, ParameterList parameterList)
Deprecated. use other constructor with extra parameter for collapsed state

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
int	getBottom()
java.lang.String	getContent() returns the name of the page/class/file etc. containing the content of the module
int	getHeight() returns the height of the module in the GUI.
int	getLeft()
ModuleConfiguration	getModuleConfiguration() returns the a specific confguration for a module.
java.lang.String[]	getModuleJSList()
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. that represents a module
int	getRight()
java.lang.String	getScrolling() return true is the module should has scrollbars in the GUI possible values are no yes auto default is auto
java.lang.String	getTitle()
int	getTop()
java.lang.String	getType() see also org.deegree.clients.context.Module#getType()
int	getWidth() returns the width of the module in the GUI.
boolean	hasHeader()
boolean	isClosable()
boolean	isCollapsed()
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.
boolean	isOverlay()
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	setBottom(int bottom)
void	setClosable(boolean closable)
void	setCollapsed(boolean collapsed)
void	setContent(java.lang.String content) sets the name of the page/class/file etc. containing the content of the module
void	setHeader(boolean header)
void	setHeight(int height) sets the desired height of the module in the GUI.
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	setLeft(int left)
void	setModuleConfiguration(ModuleConfiguration configuration) sets the specific configuration for a module.
void	setModuleJSList(java.lang.String[] list)
void	setName(java.lang.String name) sets the name of a module
void	setOverlay(boolean overlay)
void	setParameter(ParameterList parameterList) sets a list of parameters that will be passed to a class/object etc. that represents a module
void	setRight(int right)
void	setScrolling(java.lang.String scrollable)
void	setTitle(java.lang.String title)
void	setTop(int top)
void	setType(java.lang.String type) see also org.deegree.clients.context.Module#setType(java.lang.String)
void	setWidth(int width) sets the desired width of the module in the GUI.

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

@Deprecated
public Module(java.lang.String name,
                         java.lang.String title,
                         java.lang.String content,
                         boolean hidden,
                         java.lang.String type,
                         int left,
                         int top,
                         int right,
                         int bottom,
                         int width,
                         int height,
                         boolean overlay,
                         boolean header,
                         boolean closable,
                         java.lang.String scrolling,
                         java.lang.String[] moduleJSList,
                         ModuleConfiguration moduleConfiguration,
                         ParameterList parameterList)

Deprecated. use other constructor with extra parameter for collapsed state

Module

public Module(java.lang.String name,
              java.lang.String title,
              java.lang.String content,
              boolean hidden,
              java.lang.String type,
              int left,
              int top,
              int right,
              int bottom,
              int width,
              int height,
              boolean overlay,
              boolean header,
              boolean closable,
              boolean collapsed,
              java.lang.String scrolling,
              java.lang.String[] moduleJSList,
              ModuleConfiguration moduleConfiguration,
              ParameterList parameterList)

Creates a new Module object.

Parameters:

name - name of the module

title - title of the module

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

hidden - indicates if the module is visible or not

type -

left -

top -

right -

bottom -

width -

height -

overlay -

header -

closable -

collapsed - the state of the module in table layout of ExtJS. default is false

scrolling -

moduleJSList -

moduleConfiguration - encapsulates the access to the modules configuration (may be null)

parameterList -

Method Detail

getName

public java.lang.String getName()

returns the name of a module

Returns:

the name of a module

setName

public void setName(java.lang.String name)

sets the name of a module

Parameters:

name -

getTitle

public java.lang.String getTitle()

Returns:

the title

setTitle

public void setTitle(java.lang.String title)

Parameters:

title - the title to set; if title == null the modules name will be used as title

getContent

public java.lang.String getContent()

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

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:

true if the module is hidden.

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:

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

setModuleConfiguration

public void setModuleConfiguration(ModuleConfiguration configuration)

sets the specific configuration for a module.

Parameters:

configuration -

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 -

setType

public void setType(java.lang.String type)

see also org.deegree.clients.context.Module#setType(java.lang.String)

Parameters:

type - to set

getType

public java.lang.String getType()

see also org.deegree.clients.context.Module#getType()

Returns:

the type.

getWidth

public int getWidth()

returns the width of the module in the GUI. If '0' will be returned the GUI can set the with like it is best

Returns:

the width of the module in the GUI. If '0' will be returned the GUI can set the with like it is best

setWidth

public void setWidth(int width)

sets the desired width of the module in the GUI. If '0' ist passed the GUI can set the with like it is best

Parameters:

width - desired width of the module

getHeight

public int getHeight()

returns the height of the module in the GUI. If '0' will be returned the GUI can set the with like it is best

Returns:

the height of the module in the GUI. If '0' will be returned the GUI can set the with like it is best

setHeight

public void setHeight(int height)

sets the desired height of the module in the GUI. If '0' ist passed the GUI can set the with like it is best

Parameters:

height - desired width of the module

getBottom

public int getBottom()

Returns:

the bottom

setBottom

public void setBottom(int bottom)

Parameters:

bottom - the bottom to set

getLeft

public int getLeft()

Returns:

the left

setLeft

public void setLeft(int left)

Parameters:

left - the left to set

getRight

public int getRight()

Returns:

the right

setRight

public void setRight(int right)

Parameters:

right - the right to set

getTop

public int getTop()

Returns:

the top

setTop

public void setTop(int top)

Parameters:

top - the top to set

isClosable

public boolean isClosable()

Returns:

the closable

setClosable

public void setClosable(boolean closable)

Parameters:

closable - the closable to set

hasHeader

public boolean hasHeader()

Returns:

the header

setHeader

public void setHeader(boolean header)

Parameters:

header - the header to set

isOverlay

public boolean isOverlay()

Returns:

the overlay

setOverlay

public void setOverlay(boolean overlay)

Parameters:

overlay - the overlay to set

getModuleJSList

public java.lang.String[] getModuleJSList()

Returns:

moduleJSList

setModuleJSList

public void setModuleJSList(java.lang.String[] list)

Parameters:

list -

getScrolling

public java.lang.String getScrolling()

return true is the module should has scrollbars in the GUI
possible values are

• no
• yes
• auto

default is auto

Returns:

true is the module should has scrollbars in the GUI possible values are

setScrolling

public void setScrolling(java.lang.String scrollable)

Parameters:

scrollable -

See Also:

getScrolling()

setCollapsed

public void setCollapsed(boolean collapsed)

Parameters:

collapsed - default value is false

isCollapsed

public boolean isCollapsed()

Returns:

collapsed