DocumentedDistribution (BandM metatools API doc)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Frame
      - javax.swing.JFrame
        
        eu.bandm.tools.installer.DocumentedDistribution<M,G>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Deprecated.
uses jawaws/JNLP, which is deprecated since jse 9 and no more contained in jse 11. Use instead.
```
@Deprecated
public abstract class DocumentedDistribution<M extends Model,G extends Gui>
extends JFrame
```
Jnlp-based distribution of code (as binary), plus documentation, example(s) and sources. Contains
1. global public constant definitions
2. the top-level control flow for the very different use cases, including jnlp interfacing, reading the data files, writing the result files and starting the GUI.
3. A gui with menu, options panel, message panel.
Further graphic panels, menu points and the executive functionality must be added by sub-classing.
(Is an abstraction from bandm/book2 Main, Gui, etc.)
The extension of this class can be used as "main class" for calls by jnlp/jar and by command line:
```
       class Program extends DocumentedDistribution {
         @Override void executeBatchOperation( [*glo in optionsModel*] ){
           ...
         }
         public static void main (final String[] args){
           new Program(new DocumentedDistribution.Configuration(){
                         {programName = ...; 
                          ..}}).execute(args);
         }
       }
    
```
The type parameters of this class are one class derived from Model and a corresponding class derived from Gui, as generated by the Compiler. See the BandM metatools user doc for details.
Flag icons by FamFamFam http:famfamfam.com/lab/icons/flags (Mark James)
TODO, MISSING, NICE-TO-HAVES:
1. (_) "nosplash" in Configuration to suppress greeting window.
2. (_) keyboard shortcuts (close window by escape, accelerators, html-dialog etc.) EVERYWHERE
3. (_) "menu_languages_name" configurable ? / language switch ?
  (See projekte2010/src/eu/bandm/gongmachine/AllGui.java)
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DocumentedDistribution.Configuration<MM extends Model,GG extends Gui>` Deprecated. Auxiliary class to pass the main operation parameters from a particular application, realized as a subclass of `DocumentedDistribution`.
`static class`	`DocumentedDistribution.executeModes` Deprecated.

Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActionListener`	`al_lang_select` Deprecated.
`protected Map<Component,String>`	`anyTabbedPane2textKey` Deprecated.
`protected Map<AbstractButton,String>`	`button2textKey` Deprecated.
`DocumentedDistribution.Configuration<M,G>`	`configuration` Deprecated.
`protected byte[]`	`DES_cs` Deprecated. Checksum of all files in DES.
`protected String`	`DES_dir` Deprecated. Common root position of documentation, examples and sources.
`static String[]`	`emptyArgs` Deprecated.
`protected SwingMessageField<SimpleMessage<String>>`	`errorMsgField` Deprecated. Text label showing always the last message sent to , iff it is an error.
`protected JButton`	`executeButton` Deprecated.
`protected boolean`	`hasCmdlineParameters` Deprecated.
`static ImageIcon`	`icon_flag_de` Deprecated.
`static ImageIcon`	`icon_flag_en` Deprecated.
`static ImageIcon`	`icon_flag_es` Deprecated.
`static ImageIcon`	`icon_flag_la` Deprecated.
`protected String`	`initialStatusInformation` Deprecated.
`protected boolean`	`interactiveIsRequested` Deprecated. HACK, required that the `errorMsgField` does not collapse visually if its text contents are emmpty !-)
`protected boolean`	`isInitialCall` Deprecated.
`protected boolean`	`isMuli` Deprecated.
`protected JnlpAdapter`	`jnlpAdapter` Deprecated.
`protected boolean`	`jnlpMode` Deprecated.
`protected JTabbedPane`	`jTabbedPane` Deprecated.
`static String`	`KEY_about_additional_text` Deprecated. This is a key string pointing into the translation `CatalogByString`, to an OPTIONAL additional text shown after the first two sentences of the about window.
`static String`	`KEY_PATH_local_userdocumentation` Deprecated. This is a key string pointing into the translation `CatalogByString`, which is required because the language of the document may depend on the current language preferences.
`static String`	`KEY_ultra_short_description` Deprecated. This is a key string pointing into the translation `CatalogByString`, to a three-word explanation of the program's purpose, in different languages.
`static String`	`KEY_URL_web_userdocumentation` Deprecated. This is a key string pointing into the translation `CatalogByString`, which is required because the language of the document may depend on the current language preferences.
`protected Map<JLabel,String>`	`label2textKey` Deprecated.
`protected ButtonGroup`	`langButtons` Deprecated.
`static String`	`lf` Deprecated.
`protected JMenu`	`menu_lang` Deprecated.
`static String`	`menu_languages_name` Deprecated.
`static char`	`menu_languages_short` Deprecated.
`protected MessageStore<SimpleMessage<String>>`	`messageStore` Deprecated.
`protected List<String>`	`modified_user_languages` Deprecated. This is a copy of the original list of languages `#user_languages`, which duplicates the first element and allows by later overriding this very first position to switch language preferences dynamically.
`MuLiMessageReceiver<String>`	`msg` Deprecated. The message receiver for all error messages.
`protected MessageTee<SimpleMessage<String>>`	`msgtee` Deprecated.
`protected M`	`optionsModel` Deprecated.

Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`DocumentedDistribution(DocumentedDistribution.Configuration<M,G> configuration)` Deprecated. Only constructor, which stores the `DocumentedDistribution.Configuration` value and initializes `msg`, `messageStore` and `modified_user_languages`,

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`add_lang_select(String text)` Deprecated. FIXME generic protocol for finding flag icons.
`protected void`	`addMenu()` Deprecated. Add a new Menu, currently only with "close year", "quit", and "help" See http://docs.oracle.com/javase/tutorial/uiswing/
`protected void`	`addMuli_jTabbedPane(Component p, String text)` Deprecated. Adds the component to the top-level JTabbedPane and memorizes it for later language switch.
`protected abstract void`	`addUserMenuItems()` Deprecated. Call-back method to be overridden whenever a derived class wants to add further items to the main menu bar.
`protected abstract void`	`addUserPagesToTabbedPane()` Deprecated. Call-back method to be overridden whenever a derived class wants to add further tabbed panes to the main windows tabbed stack.
`protected void`	`clearErrorMsg()` Deprecated.
`String`	`closeDialogLink()` Deprecated.
`protected void`	`executeBatchOperation_caught()` Deprecated.
`protected abstract void`	`executeBatchOperation()` Deprecated. Call-back main execution method, called with all parameters entered into `optionsModel`, coming from the GUI or command line.
`int`	`getCriticalCount()` Deprecated.
`JnlpAdapter`	`getJnlpAdapter()` Deprecated.
`protected String`	`insitu(String key, List<String> translations)` Deprecated. Makes an "in.situ" definition using `Catalog.insitu(Object,List,List)` of the current muli messages catalog, with the current language preferences.
`protected String`	`insitu(String key, List<String> translations, Object... args)` Deprecated. Makes an "in situ" definition using `Catalog.insitu(Object,List,List,Object...)` of the current muli messages catalog, with the current language preferences.
`protected String`	`insitu(String key, String... translations)` Deprecated.
`protected boolean`	`isInitialCall()` Deprecated.
`protected JMenuItem`	`make_JMenuItem_lang(String text, Icon icon)` Deprecated.
`protected TextDialog`	`makeAboutDialog(String title, boolean modal)` Deprecated.
`protected void`	`makeMuli_anyTabbedPane(Component p, String text)` Deprecated. Memorizes the component as being contained in ANY JTabbedPane for later language switch.
`protected JButton`	`makeMuli_JButton(String text)` Deprecated. use `makeMuli(AbstractButton,String)` instead.
`protected JLabel`	`makeMuli_JLabel(String text)` Deprecated.
`protected JMenu`	`makeMuli_JMenu(String text)` Deprecated. use `makeMuli(AbstractButton,String)` instead.
`protected JMenuItem`	`makeMuli_JMenuItem(String text)` Deprecated. use `makeMuli(AbstractButton,String)` instead.
`protected <X extends AbstractButton> X`	`makeMuli(X button, String text)` Deprecated. Should work for JButton, JMenu, JMenuItem, JRadioButton, JCheckBox.
`void`	`non_static_main(String[] args)` Deprecated. Main entry for command line and for GUI operation.
`protected void`	`populate()` Deprecated.
`protected void`	`requestInteraction(boolean rq)` Deprecated. A call-back to be called from `executeBatchOperation()` to switch on/off gui mode, according to the analysed options, or to performance results, etc.
`protected void`	`setErrorMsg(String s)` Deprecated.
`void`	`setNewExampleDir(File file, byte[] cs)` Deprecated. Write new example path into persistent storage, after new selection by the user from the GUI.
`void`	`setUserLanguages(List<String> preferences)` Deprecated.
`boolean`	`switchLanguage(String lang)` Deprecated. Only let pass languages which have a menu entry.
`void`	`terminateApplicationDueToSevereErrors()` Deprecated.
`void`	`terminateApplicationDueToSevereErrors(MessageCounter<?> m)` Deprecated. Prints a text to the terminal of the command line and exits the application.
`String`	`translate(String t)` Deprecated. Translate the input String as defined by the catalog object and the language code priority sequence, both from `msg`.
`String`	`translate(String t, Object... args)` Deprecated. Translate the input String as defined by the catalog object and the language code priority sequence, both from `msg`.
`protected String[]`	`translateAndExtractShortcut(String text)` Deprecated. Make a translation, then eliminate the shortcutIndication Character and set the one-key mnemonic to its successor.
`@Opt String`	`translateNonRobust(String t)` Deprecated.
`protected abstract boolean`	`updateExampleOptionsModel(boolean changed)` Deprecated. Call-back method to adapt the example options when the DES-files have been downloaded.
`protected void`	`updateLanguage_anyTabbedPane(Component p)` Deprecated. Switcht the text and the mnemonic of the tab of the JTabbedPane, containing the component.
`void`	`user_requests_documentation()` Deprecated.

Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

- Field Detail
  - configuration
```
public final DocumentedDistribution.Configuration<M extends Model,G extends Gui> configuration
```
    Deprecated.
  - isMuli
```
protected boolean isMuli
```
    Deprecated.
  - menu_languages_name
```
public static final String menu_languages_name
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - menu_languages_short
```
public static final char menu_languages_short
```
    Deprecated.
  - KEY_PATH_local_userdocumentation
```
public static final String KEY_PATH_local_userdocumentation
```
    Deprecated.
    
    This is a key string pointing into the translation CatalogByString, which is required because the language of the document may depend on the current language preferences.
    
    See Also:
    
    Constant Field Values
  - KEY_URL_web_userdocumentation
```
public static final String KEY_URL_web_userdocumentation
```
    Deprecated.
    
    This is a key string pointing into the translation CatalogByString, which is required because the language of the document may depend on the current language preferences.
    
    See Also:
    
    Constant Field Values
  - KEY_ultra_short_description
```
public static final String KEY_ultra_short_description
```
    Deprecated.
    
    This is a key string pointing into the translation CatalogByString, to a three-word explanation of the program's purpose, in different languages.
    
    See Also:
    
    Constant Field Values
  - KEY_about_additional_text
```
public static final String KEY_about_additional_text
```
    Deprecated.
    
    This is a key string pointing into the translation CatalogByString, to an OPTIONAL additional text shown after the first two sentences of the about window.
    
    See Also:
    
    Constant Field Values
  - lf
```
public static final String lf
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - icon_flag_de
```
public static final ImageIcon icon_flag_de
```
    Deprecated.
  - icon_flag_en
```
public static final ImageIcon icon_flag_en
```
    Deprecated.
  - icon_flag_la
```
public static final ImageIcon icon_flag_la
```
    Deprecated.
  - icon_flag_es
```
public static final ImageIcon icon_flag_es
```
    Deprecated.
  - msg
```
public final MuLiMessageReceiver<String> msg
```
    Deprecated.
    
    The message receiver for all error messages.
  - msgtee
```
protected final MessageTee<SimpleMessage<String>> msgtee
```
    Deprecated.
  - messageStore
```
protected final MessageStore<SimpleMessage<String>> messageStore
```
    Deprecated.
  - modified_user_languages
```
protected final List<String> modified_user_languages
```
    Deprecated.
    
    This is a copy of the original list of languages #user_languages, which duplicates the first element and allows by later overriding this very first position to switch language preferences dynamically.
  - jnlpMode
```
protected boolean jnlpMode
```
    Deprecated.
  - hasCmdlineParameters
```
protected boolean hasCmdlineParameters
```
    Deprecated.
  - DES_dir
```
protected String DES_dir
```
    Deprecated.
    
    Common root position of documentation, examples and sources.
  - DES_cs
```
protected byte[] DES_cs
```
    Deprecated.
    
    Checksum of all files in DES.
  - jnlpAdapter
```
protected JnlpAdapter jnlpAdapter
```
    Deprecated.
  - emptyArgs
```
public static final String[] emptyArgs
```
    Deprecated.
  - optionsModel
```
protected M extends Model optionsModel
```
    Deprecated.
  - executeButton
```
protected JButton executeButton
```
    Deprecated.
  - jTabbedPane
```
protected JTabbedPane jTabbedPane
```
    Deprecated.
  - initialStatusInformation
```
protected String initialStatusInformation
```
    Deprecated.
  - errorMsgField
```
protected SwingMessageField<SimpleMessage<String>> errorMsgField
```
    Deprecated.
    
    Text label showing always the last message sent to , iff it is an error. Is positioned at the bottom of the main window and always visible, on each tab. FIXME currently only in "options" tab ?!?
  - interactiveIsRequested
```
protected boolean interactiveIsRequested
```
    Deprecated.
    
    HACK, required that the errorMsgField does not collapse visually if its text contents are emmpty !-)
  - isInitialCall
```
protected boolean isInitialCall
```
    Deprecated.
  - al_lang_select
```
protected ActionListener al_lang_select
```
    Deprecated.
  - button2textKey
```
protected Map<AbstractButton,String> button2textKey
```
    Deprecated.
  - label2textKey
```
protected Map<JLabel,String> label2textKey
```
    Deprecated.
  - anyTabbedPane2textKey
```
protected Map<Component,String> anyTabbedPane2textKey
```
    Deprecated.
  - langButtons
```
protected final ButtonGroup langButtons
```
    Deprecated.
  - menu_lang
```
protected JMenu menu_lang
```
    Deprecated.
- Constructor Detail
  - DocumentedDistribution
```
public DocumentedDistribution(DocumentedDistribution.Configuration<M,G> configuration)
```
    Deprecated.
    
    Only constructor, which stores the DocumentedDistribution.Configuration value and initializes msg, messageStore and modified_user_languages,
- Method Detail
  - closeDialogLink
```
public String closeDialogLink()
```
    Deprecated.
  - translate
```
public String translate(String t)
```
    Deprecated.
    
    Translate the input String as defined by the catalog object and the language code priority sequence, both from msg. If no translation is defined, the KEY ITSELF is returned! The work is done by the method Catalog.translateRobust(Object,List)
  - translateNonRobust
```
@Opt
public @Opt String translateNonRobust(String t)
```
    Deprecated.
  - translate
```
public String translate(String t,
                        Object... args)
```
    Deprecated.
    
    Translate the input String as defined by the catalog object and the language code priority sequence, both from msg. The work is done by the method Catalog.translateAllAndFormatRobust(Object,List,List)
  - insitu
```
protected String insitu(String key,
                        List<String> translations,
                        Object... args)
```
    Deprecated.
    
    Makes an "in situ" definition using Catalog.insitu(Object,List,List,Object...) of the current muli messages catalog, with the current language preferences. That means it delivers the selected text immediately, but stores the translations as a side effect, for later retrieval.
    
    Parameters:
    
    translations - list of PAIRS of String, each language code and text
    
    args - objects formatted into the translated text by printf codes
  - insitu
```
protected String insitu(String key,
                        List<String> translations)
```
    Deprecated.
    
    Makes an "in.situ" definition using Catalog.insitu(Object,List,List) of the current muli messages catalog, with the current language preferences. That means it delivers the selected text immediately, but stores the translations as a side effect, for later retrieval. This is the variant for constant texts, i.e. without printf embedding.
    
    Parameters:
    
    translations - list of PAIRS of String, each language code and text
  - insitu
```
protected String insitu(String key,
                        String... translations)
```
    Deprecated.
    
    See Also:
    
    insitu(String,List)
  - terminateApplicationDueToSevereErrors
```
public void terminateApplicationDueToSevereErrors(MessageCounter<?> m)
```
    Deprecated.
    
    Prints a text to the terminal of the command line and exits the application. May only be called in command-line mode!
  - terminateApplicationDueToSevereErrors
```
public void terminateApplicationDueToSevereErrors()
```
    Deprecated.
  - getCriticalCount
```
public int getCriticalCount()
```
    Deprecated.
  - getJnlpAdapter
```
public JnlpAdapter getJnlpAdapter()
```
    Deprecated.
  - setUserLanguages
```
public void setUserLanguages(List<String> preferences)
```
    Deprecated.
  - updateExampleOptionsModel
```
protected abstract boolean updateExampleOptionsModel(boolean changed)
```
    Deprecated.
    
    Call-back method to adapt the example options when the DES-files have been downloaded. Accesses globally Configuration.exampleOptionsModel and DES_dir. The application can decide NOT to change the option settings.
    
    Parameters:
    
    changed - whether the call is caused by an explicit download request by the user.
    
    Returns:
    
    whether a change in Configuration.exampleOptionsModel must be reflected in the GUI
  - executeBatchOperation
```
protected abstract void executeBatchOperation()
```
    Deprecated.
    Call-back main execution method, called with all parameters entered into optionsModel, coming from the GUI or command line. Must be called by one of the user-defined GUI field entries, or a button like "go!-)".
    Situations:
```
   cmd-line-parameters filled in | startup with example data       | interactively filled,
                                 |   derived from DES position     |    GO button pressed
                                 |                                 |
   isInitialCall=true            | =true                           | =false 
                                 |                                 |
   execute (possibly skip GUI)   | process data or not !?!? FIXME  | process data, return
                                 |                                 |  to GUI
                            
  
```
  - addUserPagesToTabbedPane
```
protected abstract void addUserPagesToTabbedPane()
```
    Deprecated.
    
    Call-back method to be overridden whenever a derived class wants to add further tabbed panes to the main windows tabbed stack. Must in turn call the service access point addMuli_jTabbedPane(Component, String), with "String" being the key for MuLi Translation. FIXME SOME applications still call "jTabbedPane.add()", which is DEPRECATED!
  - addUserMenuItems
```
protected abstract void addUserMenuItems()
```
    Deprecated.
    
    Call-back method to be overridden whenever a derived class wants to add further items to the main menu bar.
  - requestInteraction
```
protected void requestInteraction(boolean rq)
```
    Deprecated.
    
    A call-back to be called from executeBatchOperation() to switch on/off gui mode, according to the analysed options, or to performance results, etc.
  - isInitialCall
```
protected boolean isInitialCall()
```
    Deprecated.
  - non_static_main
```
public void non_static_main(String[] args)
```
    Deprecated.
    Main entry for command line and for GUI operation. Can be started
    1 locally from command line (jar file as executive)
    2 by java web start.
    It shows different behaviours according to the combination of the following parameters:
    1. Jnlp-mode or cmd-line start
    2. jnlp library accessible wo error (requires Jnlp-mode)
    3. D+E+S already downloaded (can be found out only if jnlp lib is accessible)
    4. command line arguments present/empty
    The common operations are always ..
    1. Set up message channels.
    2. If there are command line options: Parse command line options
    3. If options indicate input/output data, then execute main functionality by applying executeBatchOperation() on this data, controlled by the global input optionsModel
    4. iff interactive mode has been asked for explicitly, -- go to GUI mode.
    Possible use cases:
```
 X cmd line not empty
   - parsed w/o errors    --> execute cmd line 
   - parsed with errors   --> signal (gui/non-gui)
 X cmd line empty
   - non jnlp mode        --> signal situation, start with an empty Gui
   - jnlp mode
     x example downloaded --> signal situation, start with example
     x example not downloaded --> signal situation, start with an empty Gui
 
```
    The states (and possible transitions) are as follows:
```
      (_)no data loaded        (_)notJnlpMode        (_)cmdLineEmpty
       |                  
       |                       (_)jnlpMode:          (_)cmdLineGiven:
       V                  +----------------------+ +---------------  
       /\                 |    (_)DES_notLocal   | | (_)cmdLine task=A
      /  \                |     |                | | (_)cmdLine task=B
     /   (_)loaded_ok     |     V                | | (_)cmdLine task=... 
     |   /                |    (_)DES_onLocalDisk
     |  /
     | /
    (_) loaded_error
 
```
  - makeAboutDialog
```
protected TextDialog makeAboutDialog(String title,
                                     boolean modal)
```
    Deprecated.
  - setNewExampleDir
```
public void setNewExampleDir(File file,
                             byte[] cs)
```
    Deprecated.
    
    Write new example path into persistent storage, after new selection by the user from the GUI.
  - setErrorMsg
```
protected void setErrorMsg(String s)
```
    Deprecated.
  - clearErrorMsg
```
protected void clearErrorMsg()
```
    Deprecated.
  - populate
```
protected void populate()
```
    Deprecated.
  - executeBatchOperation_caught
```
protected void executeBatchOperation_caught()
```
    Deprecated.
  - makeMuli_JLabel
```
protected JLabel makeMuli_JLabel(String text)
```
    Deprecated.
  - translateAndExtractShortcut
```
protected String[] translateAndExtractShortcut(String text)
```
    Deprecated.
    Make a translation, then eliminate the shortcutIndication Character and set the one-key mnemonic to its successor.
```
         !be!enden   long=beenden   short=e
         $$quit      long=quit      short=q
         !quit            quit      short=null
         !$quit           $quit     short=null
         !$qui!t          $quit     short=t
  
```
  - addMuli_jTabbedPane
```
protected void addMuli_jTabbedPane(Component p,
                                   String text)
```
    Deprecated.
    
    Adds the component to the top-level JTabbedPane and memorizes it for later language switch.
    
    Parameters:
    
    text - text to translate, in "Mnemomic format": First character is deleted and its second appearance marks the mnemonic, as in "%e%xit" or "&&File"
  - makeMuli_anyTabbedPane
```
protected void makeMuli_anyTabbedPane(Component p,
                                      String text)
```
    Deprecated.
    
    Memorizes the component as being contained in ANY JTabbedPane for later language switch. This version is NOT related to the top-level jTabbedPane and does not insert the component anywhere. Instead, the component must already be inserted in some JTabbedPane.
    
    Parameters:
    
    text - text to translate, in "Mnemomic format": First character is deleted and its second appearance marks the mnemonic, as in "%e%xit" or "&&File"
    
    Throws:
    
    IllegalArgumentException - in case "p" is not directly contained in a JTabbedPane.
  - updateLanguage_anyTabbedPane
```
protected void updateLanguage_anyTabbedPane(Component p)
```
    Deprecated.
    
    Switcht the text and the mnemonic of the tab of the JTabbedPane, containing the component. See JTabbedPane api doc: " A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent or one of the extended keycodes obtained through java.awt.event.KeyEvent.getExtendedKeyCodeForChar." so "jt.setMnemonicAt(i, res[1].charAt(0));" seems FALSE !?!
  - makeMuli_JMenu
```
@Deprecated
protected JMenu makeMuli_JMenu(String text)
```
    Deprecated. use makeMuli(AbstractButton,String) instead.
  - makeMuli_JMenuItem
```
@Deprecated
protected JMenuItem makeMuli_JMenuItem(String text)
```
    Deprecated. use makeMuli(AbstractButton,String) instead.
  - makeMuli_JButton
```
@Deprecated
protected JButton makeMuli_JButton(String text)
```
    Deprecated. use makeMuli(AbstractButton,String) instead.
  - makeMuli
```
protected <X extends AbstractButton> X makeMuli(X button,
                                                String text)
```
    Deprecated.
    
    Should work for JButton, JMenu, JMenuItem, JRadioButton, JCheckBox. Typical usage pattern: myPanel.add(makeMuli(new JButton(), "$button$text"));
    
    Parameters:
    
    text - text to translate, in "Mnemomic format": First character is deleted and its second appearance marks the mnemonic, as in "%e%xit" or "&&File"
  - add_lang_select
```
protected void add_lang_select(String text)
```
    Deprecated.
    
    FIXME generic protocol for finding flag icons.
  - make_JMenuItem_lang
```
protected JMenuItem make_JMenuItem_lang(String text,
                                        Icon icon)
```
    Deprecated.
  - switchLanguage
```
public boolean switchLanguage(String lang)
```
    Deprecated.
    
    Only let pass languages which have a menu entry.
  - addMenu
```
protected void addMenu()
```
    Deprecated.
    
    Add a new Menu, currently only with "close year", "quit", and "help" See http://docs.oracle.com/javase/tutorial/uiswing/
  - user_requests_documentation
```
public void user_requests_documentation()
```
    Deprecated.

Class DocumentedDistribution<M extends Model,G extends Gui>

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

Nested classes/interfaces inherited from class java.awt.Frame

Nested classes/interfaces inherited from class java.awt.Window

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JFrame

Fields inherited from class java.awt.Frame

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.WindowConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JFrame

Methods inherited from class java.awt.Frame

Methods inherited from class java.awt.Window

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface java.awt.MenuContainer

Field Detail

configuration

isMuli

menu_languages_name

menu_languages_short

KEY_PATH_local_userdocumentation

KEY_URL_web_userdocumentation

KEY_ultra_short_description

KEY_about_additional_text

lf

icon_flag_de

icon_flag_en

icon_flag_la

icon_flag_es

msg

msgtee

messageStore

modified_user_languages

jnlpMode

hasCmdlineParameters

DES_dir

DES_cs

jnlpAdapter

emptyArgs

optionsModel

executeButton

jTabbedPane

initialStatusInformation

errorMsgField

interactiveIsRequested

isInitialCall

al_lang_select

button2textKey

label2textKey

anyTabbedPane2textKey

langButtons

menu_lang

Constructor Detail

DocumentedDistribution

Method Detail

closeDialogLink

translate

translateNonRobust

translate

insitu

insitu

insitu

terminateApplicationDueToSevereErrors

terminateApplicationDueToSevereErrors

getCriticalCount

getJnlpAdapter

setUserLanguages

updateExampleOptionsModel

executeBatchOperation

addUserPagesToTabbedPane

addUserMenuItems

requestInteraction

isInitialCall