Modul de.zocher_regel.util
Package de.zocher_regel.util

Klasse UtilAppl

java.lang.Object
javafx.application.Application
de.zocher_regel.util.UtilAppl
public abstract class UtilAppl extends javafx.application.Application
From this class the Main classes of the applications will inherit. It is the main interface to JavaFX GUI.

  • Verschachtelte Klassen - Übersicht

    Von Klasse geerbte verschachtelte Klassen/Schnittstellen javafx.application.Application

    javafx.application.Application.Parameters

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    protected UtilInterpreter
    interpreter
    The interpreter for commands.
    protected UtilMenuBar
    menuBar
    The menu bar, normally an instance of an implementation of UtilMenuBar.
    (Package privat) final StringBuilder
    textSb
    The StringBuider for collecting logging messages.

    Von Klasse geerbte Felder javafx.application.Application

    STYLESHEET_CASPIAN, STYLESHEET_MODENA

  • Konstruktorübersicht

    Konstruktoren
    Modifizierer
    Konstruktor
    Beschreibung
    protected
    UtilAppl()
    Create an instance of this class.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    protected void
    applSpecificUtilMenu()
    An inheriting application may override this to place special menu entries in the tools menu, e. g.: if(PROP.putIfEmpty(UtilSetting.MenuTools2,"explorer.exe"))refreshNecessary(); E. g.
    protected boolean
    checkProperty(PropertyEntry propertyEntry)
    If the property belongs to this package (to UtilSetting), check its value.
    (Package privat) final void
    clearLog()
    Clear the StringBuffer with logging messages.
    protected String
    getHelpContent()
    The help for a selected menu depends on the user's language.
    protected final String
    getHelpContentKey()
    To a selected menu belongs a special help in the help pane.
    protected abstract KeyAble
    getKeyAbleFromKey(String key)
    The function that gives the enum instance for its qualified name.
    protected KeyAble
    getKeyAbleFromKeyCode(javafx.scene.input.KeyCode keyCode)
    Instead of selecting a menu a function key may be pressed.
    protected static final KeyAble
    getKeyAbleFromKeyFunction(String key, Function<String,KeyAble> valueOfFunct)
    Because enums cannot be inherited, a function gives the enum instance for its name.
    protected abstract UtilMenuBar
    getMenuBar()
    Applications using this package have their own menu bar.
    (Package privat) final javafx.stage.Stage
    getStage()
    The application (this class or an implementing Main class) has a GUI with a stage.
    protected String
    getTitle()
    The title deplayed in the GUI.
    protected final void
    handleEvent(javafx.event.Event event)
    Events that are processed here are menu events and pressed function keys.
    protected abstract void
    initInterpreter()
    Create and assign the special interpreter of the application which uses this module.
    final boolean
    isInBatchPhase()
    In batch phase, before the GUI is started, missing parameters cannot be entered in the GUI.
    final void
    refresh()
    Refresh the GUI if necessary.
    final void
    refreshNecessary()
    Notify when a value displayed in the GUI has changed.
    final void
    setHelpContentKey(String helpContentKey)
    If another menu is selected, the help pane should be updated.
    final void
    start(javafx.stage.Stage stage)
     
    void
    stop()
     

    Von Klasse geerbte Methoden javafx.application.Application

    getHostServices, getParameters, getUserAgentStylesheet, init, launch, launch, notifyPreloader, setUserAgentStylesheet

    Von Klasse geerbte Methoden java.lang.Object

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

  • Felddetails

    • interpreter

      protected UtilInterpreter interpreter
      The interpreter for commands. This is normally an instance of an implementation of UtilInterpreter.

    • textSb

      final StringBuilder textSb
      The StringBuider for collecting logging messages.

  • Konstruktordetails

    • UtilAppl

      protected UtilAppl()
      Create an instance of this class.

  • Methodendetails

    • applSpecificUtilMenu

      protected void applSpecificUtilMenu()
      An inheriting application may override this to place special menu entries in the tools menu, e. g.: if(PROP.putIfEmpty(UtilSetting.MenuTools2,"explorer.exe"))refreshNecessary(); E. g. Photo application uses GIMP, Irfanview, Riot.

    • checkProperty

      protected boolean checkProperty(PropertyEntry propertyEntry)
      If the property belongs to this package (to UtilSetting), check its value. This method is called by UtilProperties after loading.
      Parameter:
      propertyEntry - , i. e. key (enum class name and enum instance name) and value)
      Gibt zurück:
      if valid

    • clearLog

      final void clearLog()
      Clear the StringBuffer with logging messages.

    • getHelpContent

      protected String getHelpContent()
      The help for a selected menu depends on the user's language. (en, de).
      Gibt zurück:
      the help fitting the selected menu

    • getHelpContentKey

      protected final String getHelpContentKey()
      To a selected menu belongs a special help in the help pane.
      Gibt zurück:
      the key (for NLS enabled help) of the selected menu

    • getKeyAbleFromKey

      protected abstract KeyAble getKeyAbleFromKey(String key)
      The function that gives the enum instance for its qualified name. It is necessary because setting as enums cannot be inherited
      Parameter:
      key - is a field used in KeyAble
      Gibt zurück:
      the enum instance as KeyAble, which is typically a setting

    • getKeyAbleFromKeyCode

      protected KeyAble getKeyAbleFromKeyCode(javafx.scene.input.KeyCode keyCode)
      Instead of selecting a menu a function key may be pressed.
      Parameter:
      keyCode - of the function key pressed
      Gibt zurück:
      a menu command KeyAble (Setting)

    • getKeyAbleFromKeyFunction

      protected static final KeyAble getKeyAbleFromKeyFunction(String key, Function<String,KeyAble> valueOfFunct)
      Because enums cannot be inherited, a function gives the enum instance for its name.
      Parameter:
      key - the qualified enum instance name
      valueOfFunct - the function the supplies the enum instance
      Gibt zurück:
      the enum instance as KeyAble

    • getMenuBar

      protected abstract UtilMenuBar getMenuBar()
      Applications using this package have their own menu bar.
      Gibt zurück:
      the instance of a descendant of UtilMenuBar

    • getStage

      final javafx.stage.Stage getStage()
      The application (this class or an implementing Main class) has a GUI with a stage.
      Gibt zurück:
      the stage if the GUI is already active

    • getTitle

      protected String getTitle()
      The title deplayed in the GUI.
      Gibt zurück:
      the module name as default

    • handleEvent

      protected final void handleEvent(javafx.event.Event event)
      Events that are processed here are menu events and pressed function keys. All other events are ignored. The interpreter is called.
      Parameter:
      event - like menu selection or function key

    • initInterpreter

      protected abstract void initInterpreter()
      Create and assign the special interpreter of the application which uses this module.

    • isInBatchPhase

      public final boolean isInBatchPhase()
      In batch phase, before the GUI is started, missing parameters cannot be entered in the GUI.
      Gibt zurück:
      is in batch phase, no GUI is available

    • refresh

      public final void refresh()
      Refresh the GUI if necessary.

    • refreshNecessary

      public final void refreshNecessary()
      Notify when a value displayed in the GUI has changed.

    • setHelpContentKey

      public final void setHelpContentKey(String helpContentKey)
      If another menu is selected, the help pane should be updated.
      Parameter:
      helpContentKey - of the new help content, used für @se UtilNls.

    • start

      public final void start(javafx.stage.Stage stage)
      Angegeben von:
      start in Klasse javafx.application.Application

    • stop

      public void stop()
      Setzt außer Kraft:
      stop in Klasse javafx.application.Application