Package eu.bandm.tools.installer
Class DocumentedDistribution2.Configuration<MM extends Model,GG extends Gui>
java.lang.Object
eu.bandm.tools.installer.DocumentedDistribution2.Configuration<MM,GG>
- All Implemented Interfaces:
Cloneable
public abstract static class DocumentedDistribution2.Configuration<MM extends Model,GG extends Gui>
extends Object
implements Cloneable
Auxiliary data class to define the main operation parameters by a particular
instance of a particular application, realized as a subclass of
DocumentedDistribution2
.
An instance must be passed by the constructor code of the that subclass
when calling the super constructor
DocumentedDistribution2(Configuration)
.-
Field Summary
FieldsModifier and TypeFieldDescriptionThe current build date.int
Whether an exit by menu or window closing needs an explicit confirmation.The year and holders of the copyright.One instance of the options model class must be provided here by the derived sub-class(="the caller").The URL from which the "DEnS" jar file may be read.The name of the directory into which DEnS (= documentation, example and source) will be downloaded, relative toDocumentedDistribution2.DEnS_dir
(=the one single user-defined DEnS download point).Where to send bug reports.boolean
Whether a completely empty command line shows usage() and exits.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.Nick names under which the standard examples are presented in the Menu.Access to the cmd line option for clearing the persistency store.Access to the cmd line option for always starting the gui.Access to the cmd line option for printing the help text.Access to the cmd line option for language selection.Access to the cmd line option for printing the version.Relative path of a resource holding a middle-sized icon, used in message windows etc.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.The license under which the program and its sources may by used, distibuted etc.boolean
Whether the message pane is not on a tabbed pane (at the end of the row), but in a separate region of the top-level window which is always visible.boolean
Whether to print a metaools acknowledgement at the end of "about" textboolean
Whether to print a standard "no warranty" string.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.int
The subclass can change these geometric GUI parameters according to OS dependent heuristics.The name of a programming projet this program belongs to.The name of this program.The current version of this program.Prototype for instances employed in all graphic based modes of operation.boolean
Whether on start-up the parameters of the last payload run are reconstructed.boolean
Whether the program needs input data in the file system.boolean
Whether the program needs permanent internet access for running.boolean
Whether the run button click causes a switch to the message pane.boolean
Whether to start with the status info window.boolean
Whether to store the parameters into the persistent storage only after an execution without errors or exceptions.Each constructor call must provide by this field an instance ofCatalogByString
which contains the translations for all payload specific texts AND for the texts used here in this class (but NOT for those used inDownloadDialog
).List of optional flag icons in parallel withuser_languages
.List language codes. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
programName
The name of this program. -
iconRelativePath
Relative path of a resource holding a middle-sized icon, used in message windows etc. -
programContextName
The name of a programming projet this program belongs to. -
programVersionString
The current version of this program. A string of one or more numbers, according to POSIX/GNU NOT including spaces! -
buildDate
The current build date. -
copyrightString
The year and holders of the copyright. -
licenseString
The license under which the program and its sources may by used, distibuted etc. -
noWarranty
public boolean noWarrantyWhether to print a standard "no warranty" string. -
emailForBugReport
Where to send bug reports. -
metatoolsAck
public boolean metatoolsAckWhether to print a metaools acknowledgement at the end of "about" text -
runsOnFiles
public boolean runsOnFilesWhether the program needs input data in the file system. If true, an example data set is included in the DEnS distribution. -
runsOnlineOnly
public boolean runsOnlineOnlyWhether the program needs permanent internet access for running. -
startWithStatusInformationDialog
public boolean startWithStatusInformationDialogWhether to start with the status info window. -
DEnS_local_dir_name
The name of the directory into which DEnS (= documentation, example and source) will be downloaded, relative toDocumentedDistribution2.DEnS_dir
(=the one single user-defined DEnS download point). -
examplesShortNames
Nick names under which the standard examples are presented in the Menu. A singleton name will not be printed. An empty or missing list makes no menu entries. -
DEnS_download_position
The URL from which the "DEnS" jar file may be read. For instance "http://bandm.eu/metatools/download/bandmBooking-DEnS.jar" May be ==null for very simple programs with online documentation only. -
translations
Each constructor call must provide by this field an instance ofCatalogByString
which contains the translations for all payload specific texts AND for the texts used here in this class (but NOT for those used inDownloadDialog
). This can be achieved by either extending an instance ofTranslations
(i.e. adding the specific texts) or, vice versa, by creating a freshCatalogByString
and adding all translations defined here bymyCatalog.putAll(new Translations())
.
The keys of the "generic" texts are found inTranslations
; for a complete list see the XML source inTranslations.muli
. Translations into further languages must be provided by the subclass if more than the languages "la", "en" and "de" shall be supported.
A third category are the few specific texts which vary with the application but the KEYS of which are defined here. These areDocumentedDistribution2.KEY_PATH_local_userdocumentation
,DocumentedDistribution2.KEY_URL_web_userdocumentation
andDocumentedDistribution2.KEY_ultra_short_description
. -
defaultOptionsModel
One instance of the options model class must be provided here by the derived sub-class(="the caller"). It is needed for creating clones byModel.makeDefaultInstance()
. -
prototypeOptionsGui
Prototype for instances employed in all graphic based modes of operation. Cannot be used directly but must be cloned byGui.makeInstance(Model)
, because some sub-classes of DocumentedDistribution2 may allow multiple instantiations of their specific payload code, while all share this Configuration object. -
user_languages
List language codes. Must contain at least one language. Codes are in the ISO endcoding with two lower case characters. More than one code contained enables language switching. -
user_language_icons
List of optional flag icons in parallel withuser_languages
. -
insetsOptionsHorizontal
public int insetsOptionsHorizontalThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
insetsOptionsVertical
public int insetsOptionsVerticalThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
insetsLabelsHorizontal
public int insetsLabelsHorizontalThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
insetsLabelsVertical
public int insetsLabelsVerticalThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
overallHeight
public int overallHeightThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
overallWidth
public int overallWidthThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
parameterControlFlowWidth
public int parameterControlFlowWidthThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
enumSetFlowWidth
public int enumSetFlowWidthThe subclass can change these geometric GUI parameters according to OS dependent heuristics. -
messageListAlwaysVisible
public boolean messageListAlwaysVisibleWhether the message pane is not on a tabbed pane (at the end of the row), but in a separate region of the top-level window which is always visible. -
messagesPopUp
-
confirmExit
public int confirmExitWhether an exit by menu or window closing needs an explicit confirmation. 0=no confirmation, 1=on window close, 2=even on menu close -
resumeLastRunOptions
public boolean resumeLastRunOptionsWhether on start-up the parameters of the last payload run are reconstructed. -
storeOnlySuccessful
public boolean storeOnlySuccessfulWhether to store the parameters into the persistent storage only after an execution without errors or exceptions. -
runSwitchesToMessageTab
public boolean runSwitchesToMessageTabWhether the run button click causes a switch to the message pane. -
emptyOptionsCauseOnlyUsage
public boolean emptyOptionsCauseOnlyUsageWhether a completely empty command line shows usage() and exits. (If no set, the GUI mode will be entered.) -
getOpt_version
Access to the cmd line option for printing the version. -
getOpt_help
Access to the cmd line option for printing the help text. -
getOpt_gui
Access to the cmd line option for always starting the gui. -
getOpt_language
Access to the cmd line option for language selection. Returning null must indicate: option not present = no language selected. -
getOpt_clearPersistency
Access to the cmd line option for clearing the persistency store.
-
-
Constructor Details
-
Configuration
public Configuration()
-
-
Method Details
-
freshInstance
-