se.entra.phantom.server

Class GofOutputTextIdentifier

java.lang.Object

se.entra.phantom.server.GofControlIdentifierAdapter

se.entra.phantom.server.GofOutputTextIdentifier

All Implemented Interfaces:

GofControlIdentifier, PhantomControlType

public class GofOutputTextIdentifier
extends GofControlIdentifierAdapter
implements PhantomControlType

This class identifies output text/static text controls for the Gui-on-the-fly, from unused GofHostFields.

Author:

J. Bergström

Field Summary

Fields inherited from class se.entra.phantom.server.GofControlIdentifierAdapter

templPanel

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

CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

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

GOF_GUIUNITX, GOF_GUIUNITY, GOF_MARGINX, GOF_MARGINY, GOF_OFFSETX, GOF_OFFSETY, GOF_STEPX, GOF_STEPY

Constructor Summary

Constructors

Constructor and Description
GofOutputTextIdentifier()

Method Summary

Modifier and Type	Method and Description
void	getControlSettings(IniFile confFile, String subsection) Loads setting for the controll from the server ini-file.
void	identifyCtrls(GuiOnTheFlyRuntime gofRuntime, GofHostAreaIdentifier areaIdentifier, PhantomHostScreen phantomHostScreen, HostScreen hostScreen, PhantomPanelData templPanel, PhantomPanelData newPanel, int offsetX, int offsetY) Identifies all the output text controls from the GofHostFields.

Methods inherited from class se.entra.phantom.server.GofControlIdentifierAdapter

getVirtualSessionManager, identifyCtrls

Methods inherited from class java.lang.Object

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

Constructor Detail

GofOutputTextIdentifier

public GofOutputTextIdentifier()

Method Detail

getControlSettings

public void getControlSettings(IniFile confFile,
                               String subsection)

Loads setting for the controll from the server ini-file.

There is one setting for this class that makes it possible to remove trailing punctuation marks. These punctuation marks are either dots (.) or colons (:). The setting looks like this:

    deltrailingpunctmark=1
 

Remember that if the text is changed, the control that will be created will always be a static text, not output text.

It is also possible to specify that the controls created by this class should always be static texts. To do this, set the alwaysusestatictext setting to 1, otherwise to 0. In the example below, static texts will always be used.

    alwaysusestatictext=1
 

There is also a setting that affects the look of the output texts/static texts. This is the outputtextlayout setting. Valid values for this setting are:

    outputtextlayout=DEFAULT
    outputtextlayout=FONT
    outputtextlayout=COLOR
    outputtextlayout=FONTANDCOLOR
 

DEFAULT means that no settings are taken from the template panel, default values are used.

FONT means that the font is taken from template panel, from an output text with the id=O, id=OR, id=ONL or id=ONR (depending on the host fields justification, and if the host field is numeric or not). If this control cannot be found, or if it is not an output text control, default values will be used.

COLOR means that the color is taken from template panel, from an output text with the id=O, id=OR, id=ONL or id=ONR (depending on the host fields justification, and if the host field is numeric or not). If this control cannot be found, or if it is not an output text control, default values will be used.

FONTANDCOLOR means that the font and color are taken from template panel, from an output text with the id=O, id=OR, id=ONL or id=ONR (depending on the host fields justification, and if the host field is numeric or not). If this control cannot be found, or if it is not an output text control, default values will be used.

Any other value will be treated as DEFAULT.

Remember that default color for an output text is black, and for a static text it is dark blue. This means that if the color for the output text with id=O is set to default, output texts and static texts will receive different colors on the created panel.

Specified by:

getControlSettings in interface GofControlIdentifier

Overrides:

getControlSettings in class GofControlIdentifierAdapter

Parameters:

confFile - The server ini file.

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

identifyCtrls

public void identifyCtrls(GuiOnTheFlyRuntime gofRuntime,
                          GofHostAreaIdentifier areaIdentifier,
                          PhantomHostScreen phantomHostScreen,
                          HostScreen hostScreen,
                          PhantomPanelData templPanel,
                          PhantomPanelData newPanel,
                          int offsetX,
                          int offsetY)

Identifies all the output text controls from the GofHostFields.

Every unused GofHostField that is protected, and not empty, will result in either a output text or a static text. The type of control that will be created depends on the settings for this class in the server.ini file.

If the setting alwaysusestatictext has been set to 1 in the configuration file, all identified output texts will be created as static texts. Otherwise only those whose text's that has to be changed, will created as static texts.

Specified by:

identifyCtrls in interface GofControlIdentifier

Parameters:

gofRuntime - The GuiOnTheFlyRuntime instance.

areaIdentifier - The areaIdentifier in which the controls should be identified.

phantomHostScreen - The Phantom host screen corresponding to the host screen.

hostScreen - The host screen that we are trying to build a GOF panel for.

newPanel - The newly created Gui-on-the-fly runtime panel.

offsetX - The offset in columns for popup window.

offsetY - The offset in lines for popup window.