org.vishia.gral.cfg

Class GralCfgBuilder

java.lang.Object

org.vishia.gral.cfg.GralCfgBuilder

public class GralCfgBuilder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private GralCfgData	cfgData
private java.io.File	currentDir The current directory is that directory, where the config file is located.
private GralPos	currPos The current position for building all widgets.
private GralMng	gralMng
private java.util.Map<java.lang.String,java.lang.String>	indexAlias
static java.lang.String	version Version and history 2023-08-08 Hartmut chg: The content is back moved from GralCfgZbnf, tested, improved there since 2022-08.
java.util.List<GralWidget>	widgets
GralWindow	window

Constructor Summary

Constructors

Constructor and Description
GralCfgBuilder(GralCfgData cfgData, GralMng gui, java.io.File currentDir)

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildGui(GralCfgData guiCfgData, GralPanelContent dstPanel) Builds the appearance of the whole graphic with the given GralCfgData cfgData.
java.lang.String	buildGui(java.lang.String sWinTitle) Builds the appearance of the whole graphic with the given GralCfgData cfgData.
java.lang.String	buildPanel(GralCfgPanel cfgPanel, GralPanelContent parentPanel) Builds the appearance of one panel with the given GralCfgPanel cfgData.
java.lang.String	buildWidget(GralCfgElement cfge, GralPanelContent currPanel) Builds the instance of one of the GralWidget from the read ZBNF data.
(package private) java.lang.String	replaceAlias(java.lang.String src)
(package private) void	stop()
void	updatePanel(java.lang.String panelName)

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version and history

• 2023-08-08 Hartmut chg: The content is back moved from GralCfgZbnf, tested, improved there since 2022-08. It is comparable. It is yet here the new concept to build the Gui, so this class can be used yet.
• 2015-04-27 Hartmut chg: #buildGui(LogMessage, int) Now regards only one panel in the window, not only tabbed panels.
• 2014-02-24 Hartmut new element help now also in config.
• 2012-09-17 Hartmut chg: showMethod now split functionName and parameters. The function name is used to get the GralUserAction for GralWidget.setActionShow(GralUserAction, String[]). The parameter are stored in GralWidget.cfg as GralWidget.ConfigData#showParam.
• 2011-05-00 Hartmut created, the old ZbnfCfg.. class is obsolte now.

Copyright/Copyleft:
For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

cfgData

private final GralCfgData cfgData

gralMng

private final GralMng gralMng

currPos

private GralPos currPos

The current position for building all widgets. This current position holds the value from the last built widget which can be changed relative to always the next widget. It means this current position is really the current while building. Note that the aggregated internal widget position is always a clone of this with the current values whilce building.

window

public GralWindow window

widgets

public java.util.List<GralWidget> widgets

currentDir

private final java.io.File currentDir

The current directory is that directory, where the config file is located. It is used if other files are given with relative path.

indexAlias

private final java.util.Map<java.lang.String,java.lang.String> indexAlias

Constructor Detail

GralCfgBuilder

public GralCfgBuilder(GralCfgData cfgData,
                      GralMng gui,
                      java.io.File currentDir)

Method Detail

buildGui

public java.lang.String buildGui(java.lang.String sWinTitle)

Builds the appearance of the whole graphic with the given GralCfgData cfgData. The cfgData can be filled manually per programming, or especially by #configureWithZbnf(CharSequence, GralCfgData). Calls #buildPanel(org.vishia.gral.cfg.GralCfgPanel) for the any panel in the GralCfgData.idxPanels. Fills the panels one after another.

Parameters:

log - maybe null, errors and warnings are written

msgIdent - The message identification for output.

Returns:

null if ok, elsewhere the error hints which maybe written to log too, one per line. The window can be gotten by #window. The rest of this class may be not furthermore used.

buildGui

public java.lang.String buildGui(GralCfgData guiCfgData,
                                 GralPanelContent dstPanel)

Builds the appearance of the whole graphic with the given GralCfgData cfgData. The cfgData can be filled manually per programming, or especially by #configureWithZbnf(CharSequence, GralCfgData). Calls #buildPanel(org.vishia.gral.cfg.GralCfgPanel) for the any panel in the GralCfgData.idxPanels. Fills the panels one after another.

Parameters:

log - maybe null, errors and warnings are written

msgIdent - The message identification for output.

Returns:

null if ok, elsewhere the error hints which maybe written to log too, one per line. The window can be gotten by #window. The rest of this class may be not furthermore used.

buildPanel

public java.lang.String buildPanel(GralCfgPanel cfgPanel,
                                   GralPanelContent parentPanel)

Builds the appearance of one panel with the given GralCfgPanel cfgData.

Parameters:

cfgDataPanel -

Returns:

null if ok, elsewhere the error hints, one per line.

buildWidget

public java.lang.String buildWidget(GralCfgElement cfge,
                                    GralPanelContent currPanel)
                             throws java.text.ParseException

Builds the instance of one of the GralWidget from the read ZBNF data. This operation does nothing with the Graphic Implementation (SWT, AWT,...). Hence it can run in the main thread (or any other thread).
It is new since 2022-08. History: First the GralMng creates also the Implementation widgets calling GralMng.addSwitchButton(String, String, String, org.vishia.gral.ifc.GralColor, org.vishia.gral.ifc.GralColor) and the other operations. This was the originally concept. Hence the building of the GUI should run only in the GUI thread and was a little bit more difficult to debug. Since ~2014 more and more only the GralWidget instances without GUI Implementation are firstly created on manual building of the GUI, for example in GitGui. This is better to manage, better to debug. The graphical implementation is created with all given GralWidgets later based on even this given GralWidgets. That is more simple. - Now this concept is also used for the configured GralWidgets .

Parameters:

cfge - The configuration element data read from config file or set from the GUI-editor.

Returns:

null if OK, an error String for a user info message on warning or error. It is possible that a named user action is not found etc.

Throws:

java.text.ParseException

updatePanel

public void updatePanel(java.lang.String panelName)

replaceAlias

java.lang.String replaceAlias(java.lang.String src)

stop

void stop()