org.deegree.portal.context
Class GUIArea

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

public class GUIArea
extends Object

this interface describes the content of an area of a GUI. a GUI area contains zero ... n modules described by the Module interface. A GUI area may be can be switched to be invisible. indicated by the hidden attribute.

Version:

$Revision: 6957 $

Author:

Andreas Poth

Field Summary

static int	CENTER
static int	EAST
static int	NORTH
static int	SOUTH
static int	WEST

Constructor Summary

GUIArea(int area, boolean hidden, Module[] modules)
Creates a new GUIArea_Impl object.

Method Summary

void	addModul(Module module) adds a module to a GUIArea
int	getArea() returns area (north, west, east ...) assigned to an instance
Module	getModule(String name) returns a module identified by its name
Module[]	getModules() returns all modules of a GUIArea
boolean	isHidden() returns true if the GUIArea is hidden.
Module	removeModule(String name) reomes a module identified by its name from the GUIArea
void	setArea(int area) sets the name of a module
void	setHidden(boolean hidden) sets the GUIArea to be hidden or visible.
void	setModules(Module[] modules) sets the modules of a GUIArea

Methods inherited from class java.lang.Object

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

Field Detail

WEST

public static final int WEST

See Also:

Constant Field Values

EAST

public static final int EAST

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

See Also:

Constant Field Values

NORTH

public static final int NORTH

See Also:

Constant Field Values

CENTER

public static final int CENTER

See Also:

Constant Field Values

Constructor Detail

GUIArea

public GUIArea(int area,
               boolean hidden,
               Module[] modules)

Creates a new GUIArea_Impl object.

Parameters:

area -

hidden -

modules -

Method Detail

getArea

public int getArea()

returns area (north, west, east ...) assigned to an instance

Returns:

area

setArea

public void setArea(int area)

sets the name of a module

Parameters:

area -

isHidden

public boolean isHidden()

returns true if the GUIArea is hidden.

Returns:

true if area is hidden

setHidden

public void setHidden(boolean hidden)

sets the GUIArea to be hidden or visible.

Parameters:

hidden -

getModule

public Module getModule(String name)

returns a module identified by its name

Parameters:

name -

Returns:

named module

getModules

public Module[] getModules()

returns all modules of a GUIArea

Returns:

all modules

setModules

public void setModules(Module[] modules)

sets the modules of a GUIArea

Parameters:

modules -

addModul

public void addModul(Module module)

adds a module to a GUIArea

Parameters:

module -

removeModule

public Module removeModule(String name)

reomes a module identified by its name from the GUIArea

Parameters:

name -

Returns:

removed module