se.entra.phantom.server

Class GofHostAreaIdentifierAdapter

java.lang.Object

se.entra.phantom.server.GofHostAreaIdentifierAdapter

All Implemented Interfaces:

GofHostAreaIdentifier

Direct Known Subclasses:

GofButtonAreaIdentifier, GofMainAreaIdentifier, GofTitleAreaIdentifier

public abstract class GofHostAreaIdentifierAdapter
extends Object
implements GofHostAreaIdentifier

This is an adapter class that must be used as a base class for classes implementing the GofHostAreaIdentifier interface.

Extending from this class, instead of directly implementing the interface, makes it possible to extend the interface with new methods in the future, without forcing a re-compilation of user written GofHostAreaIdentifier classes. Default versions of these new methods can instead be implemented in this adapter class.

Author:

J. Bergström

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector<GofHostField>	areaGofHostFields All the GofHostFields that belongs to this area.
protected Vector<PhantomControl>	phantomControls All the controls that have been added to this area.

Fields inherited from interface se.entra.phantom.server.GofHostAreaIdentifier

FLOW_LAYOUT

Constructor Summary

Constructors

Constructor and Description
GofHostAreaIdentifierAdapter() The constructor is a default constructor without any parameters.

Method Summary

Modifier and Type	Method and Description
void	addControl(PhantomControl phantomControl) Adds a new PhantomControl to the area.
void	getAreaSettings(IniFile confFile, String subsection) This method should get all the settings from the configuration file needed for this class.
Vector<GofHostField>	getAreasGofHostFields() This method gets all the GofHostFields belonging to this area.
Vector<GofHostField>	identifyArea(Vector<GofHostField> gofHostFields, int x, int y, int w, int h) This method must implement the code for identifying the area the class is supposed to identify.
void	layout() This method should layout the controls belonging to this area according to the layout rule specified by the parameter.

Methods inherited from class java.lang.Object

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

Field Detail

areaGofHostFields

protected Vector<GofHostField> areaGofHostFields

All the GofHostFields that belongs to this area.

phantomControls

protected Vector<PhantomControl> phantomControls

All the controls that have been added to this area.

Constructor Detail

GofHostAreaIdentifierAdapter

public GofHostAreaIdentifierAdapter()

The constructor is a default constructor without any parameters. This makes it possible to load this class dynamically. The constructor doesn't do anything more than create the instance.

Method Detail

getAreaSettings

public void getAreaSettings(IniFile confFile,
                            String subsection)

This method should get all the settings from the configuration file needed for this class.

Classes extending from this class that needs to read in their own settings from the configuration file, must implement this method, since this default implementation don't do anything.

Specified by:

getAreaSettings in interface GofHostAreaIdentifier

Parameters:

confFile - A reference to the IniFile instance that holds the current server configuration file's settings.

subsection - The name of the subsection used for the current Gui-on-the-Fly settings.

identifyArea

public Vector<GofHostField> identifyArea(Vector<GofHostField> gofHostFields,
                                         int x,
                                         int y,
                                         int w,
                                         int h)

This method must implement the code for identifying the area the class is supposed to identify. It should also store the GofHostFields that belong to this area in the areaGofHostFields Vector.

This adapter class only implements an empty method. Classes extending this class must extend this method.

Specified by:

identifyArea in interface GofHostAreaIdentifier

Parameters:

gofHostFields - A Vector containing all the GofHostFields in the part of the screen area to be analyzed.

x - The start column of the area to be analyzed.

y - The start line of the area to be analyzed.

w - The width of the area to be analyzed.

h - The height of the area to be analyzed.

Returns:

The adapters default method just returns null.

See Also:

areaGofHostFields

getAreasGofHostFields

public Vector<GofHostField> getAreasGofHostFields()

This method gets all the GofHostFields belonging to this area.

Specified by:

getAreasGofHostFields in interface GofHostAreaIdentifier

Returns:

This area's GofHostFields.

addControl

public void addControl(PhantomControl phantomControl)

Adds a new PhantomControl to the area. The method stores the control internally in a Vector in the class. This makes it possible for class extending this class to implement the laying out of the components.

Specified by:

addControl in interface GofHostAreaIdentifier

Parameters:

phantomControl - The control to add to this area.

layout

public void layout()

This method should layout the controls belonging to this area according to the layout rule specified by the parameter.

This adapter class only implements an empty method. Classes extending this class must extend this method.

Specified by:

layout in interface GofHostAreaIdentifier