se.entra.phantom.server

Interface GofHostAreaIdentifier

All Known Implementing Classes:

GofButtonAreaIdentifier, GofHostAreaIdentifierAdapter, GofMainAreaIdentifier, GofTitleAreaIdentifier

public interface GofHostAreaIdentifier

The GofHostAreaIdentifier is an interface that must be implemented by all the classes that will be used to identify different areas on the host screen.

By splitting the host screen into different areas, it will be possible to use different rules for control identification for these areas, and in some areas only identify certain controls.

Examples of areas that might be identified are:

• Title area
• Function key area
• Message area
• Status area
• Main area (the rest of the screen)

Each of the classes implementing this interface can load their own settings from the server.ini file.

The GofHostAreaIdentifier classes will also get a reference to all the controls created in their area, and will be able to implement their own layout rules.

The class implementing this interface must have a default constructor, without any parameters, since it will be created dynamically from the class name.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLOW_LAYOUT Constant used to inform an area's layout method to layout the controls in a flow layout.

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 adds a new PhantomControl 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.

Field Detail

FLOW_LAYOUT

static final int FLOW_LAYOUT

Constant used to inform an area's layout method to layout the controls in a flow layout.

See Also:

Constant Field Values

Method Detail

getAreaSettings

void getAreaSettings(IniFile confFile,
                     String subsection)

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

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

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.

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 method must return a Vector with all unused GofHostFields, that is the GofHostFields from the first parameter, not belonging to this area.

getAreasGofHostFields

Vector<GofHostField> getAreasGofHostFields()

This method adds a new PhantomControl to this area. The method should store the control internally in the class. This makes it possible for this class to implement the laying out of the components.

Returns:

This area's GofHostFields.

addControl

void addControl(PhantomControl phantomControl)

Adds a new PhantomControl to the area.

Parameters:

phantomControl - The control to add to this area.

layout

void layout()

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