de.ipcon.gui

Class ClientProfileSettingsHelper

java.lang.Object

de.ipcon.gui.ClientProfileSettingsHelper

All Implemented Interfaces:

de.ipcon.db.core.StrukturParameterDefaultApplierI

public class ClientProfileSettingsHelper
extends java.lang.Object
implements de.ipcon.db.core.StrukturParameterDefaultApplierI

Manages user preferences, profile XML configurations, and window state.

Encapsulates parsing, querying, mutating, and persisting user and group profile settings in Benutzer, decoupling UI coordinators from direct XML DOM handling.

See Also:

Benutzer, Client, StrukturParameterDefaultApplierI

Constructor Summary

Constructors

Constructor and Description
ClientProfileSettingsHelper(ClientContextI _ctx, SessionI _session, ClientDialogHelper _dialogHelper, ClientServerEventHandler _serverEventHandler) Constructs a new settings helper bound to the active client runtime.

Method Summary

Modifier and Type	Method and Description
void	applyDefaults(electric.xml.Element e, java.lang.Object[] l10nPath)
void	applyMultiWindowManagerLayout() Configures the user profile for multi-window manager mode and persists preferences.
void	applySingleWindowManagerLayout() Configures the user profile for single-window manager mode and persists preferences.
java.awt.geom.Rectangle2D.Double	getInitialWindowBounds() Resolves the stored window bounds rectangle from the profile.
int	getInitialWindowState() Resolves the initial extended window state from user profile settings.
java.util.List<electric.xml.Element>	getPluginConfigurations() Returns the list of configured plugin XML elements from the active profile.
de.ipcon.swing.WindowManagerType	getWindowManagerType() Resolves the configured window manager type from the user profile.
boolean	hasNonDefaultGuiTheme() Indicates whether the user profile defines a custom GUI theme that differs from the default theme.
void	loadSettingsFromProfiles(boolean reload) Loads and applies settings across prioritized group profiles and individual user preferences.
void	loadSettingsFromProfiles(electric.xml.Element elProfile, boolean reload) Loads and applies settings from a specific profile element and merges group defaults.
void	onLogon() Initializes user preferences and profile configurations upon successful authentication.
void	processLoginScript(java.lang.String executionPhase, boolean executeUntimed) Dispatches and runs lifecycle scripts defined in the user and group profile configurations.
void	reloadProfile() Reloads the authenticated user’s profile from the database and reapplies all settings.
void	resetGuiThemeToDefault() Resets the profile's configured GUI theme to the platform default and persists preferences.
de.ipcon.swing.ThemeWrapper	resolveConfiguredTheme(ClientLoginDialog cld, float lastZoom) Resolves and populates the Look and Feel theme according to profile settings and user preferences.
java.lang.Integer	resolveConfiguredWindowState() Extracts and parses the window state attribute from the profile, if present and valid.
void	saveUserPreferences(ClientStateSaveReason reason) Persists the active user preferences into the persistent user BO (Benutzer) within a dedicated transaction.
void	saveWindowPosition(de.ipcon.swing.WindowState state) Records the live window geometry and state in the user profile and persists preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientProfileSettingsHelper

public ClientProfileSettingsHelper(ClientContextI _ctx,
                                   SessionI _session,
                                   ClientDialogHelper _dialogHelper,
                                   ClientServerEventHandler _serverEventHandler)

Constructs a new settings helper bound to the active client runtime.

Parameters:

_ctx - context providing access to loaders, sessions, and environment services

_session - current active user session

_dialogHelper - helper for presenting user dialogs and error alerts

_serverEventHandler - handler for server push events and broadcast messages

Method Detail

onLogon

public void onLogon()

Initializes user preferences and profile configurations upon successful authentication.

Retrieves the active authenticated user from the session, parses their serialized preference XML document, and triggers the loading of prioritized group profiles and defaults.

Throws:

java.lang.IllegalArgumentException - if the user is set and its preferences XML string is malformed

reloadProfile

public void reloadProfile()

Reloads the authenticated user’s profile from the database and reapplies all settings.

Fetches an uncached instance of the current user to guarantee latest state, re-initializes preferences, and triggers profile reconfiguration across groups.

loadSettingsFromProfiles

public void loadSettingsFromProfiles(boolean reload)

Loads and applies settings across prioritized group profiles and individual user preferences.

Merges script hooks, message display rules, and bookmark/form defaults. Settings from higher-priority groups override lower-priority groups, while user-specific settings take final precedence.

Parameters:

reload - true to force a fresh fetch from the server; false to use cached profile data

loadSettingsFromProfiles

public void loadSettingsFromProfiles(electric.xml.Element elProfile,
                                     boolean reload)

Loads and applies settings from a specific profile element and merges group defaults.

Parameters:

elProfile - XML profile element containing settings to apply

reload - true to force a fresh fetch from the server; false to use cached profile data

saveUserPreferences

public void saveUserPreferences(ClientStateSaveReason reason)

Persists the active user preferences into the persistent user BO (Benutzer) within a dedicated transaction.

Serializes the in-memory preferences payload to the Voreinstellungen field of the user BO, commits the transaction, and updates the session's cached user instance.

Parameters:

reason - the trigger context defining the cause of this save operation

processLoginScript

public void processLoginScript(java.lang.String executionPhase,
                               boolean executeUntimed)

Dispatches and runs lifecycle scripts defined in the user and group profile configurations.

Traverses configured profile script elements (such as VoreinstellungenElemente) and evaluates matching scripts within the active client interpreter environment. Script execution proceeds on a best-effort basis and requires an active backend server connection.

Parameters:

executionPhase - lifecycle timing phase trigger to match (e.g. 'gui.login' or 'gui.logoff')

executeUntimed - if true, scripts lacking an explicit phase definition are also evaluated

applyDefaults

public void applyDefaults(electric.xml.Element e,
                          java.lang.Object[] l10nPath)

Specified by:

applyDefaults in interface de.ipcon.db.core.StrukturParameterDefaultApplierI

resolveConfiguredTheme

public de.ipcon.swing.ThemeWrapper resolveConfiguredTheme(ClientLoginDialog cld,
                                                          float lastZoom)

Resolves and populates the Look and Feel theme according to profile settings and user preferences.

Determines the target theme from login selections, stored preferences, or platform defaults, and applies window decoration flags, zoom factors, and SVG icon settings before returning it.

Parameters:

cld - optional login dialog reference; may be null

lastZoom - previously cached zoom factor; non-positive values fall back to defaults

Returns:

prepared ThemeWrapper ready for application, or null if no theme could be resolved

hasNonDefaultGuiTheme

public boolean hasNonDefaultGuiTheme()

Indicates whether the user profile defines a custom GUI theme that differs from the default theme.

Returns:

true if a non-default theme is explicitly configured; false otherwise

resetGuiThemeToDefault

public void resetGuiThemeToDefault()

Resets the profile's configured GUI theme to the platform default and persists preferences.

getWindowManagerType

public de.ipcon.swing.WindowManagerType getWindowManagerType()

Resolves the configured window manager type from the user profile.

Returns:

the active WindowManagerType, or null if none is configured or matches.

applySingleWindowManagerLayout

public void applySingleWindowManagerLayout()

Configures the user profile for single-window manager mode and persists preferences.

Replaces existing MDI desktop plugin configurations with standard single-window manager and navigation tree plugins, resets window position and state attributes to maximized defaults, and saves the updated preferences.

applyMultiWindowManagerLayout

public void applyMultiWindowManagerLayout()

Configures the user profile for multi-window manager mode and persists preferences.

Replaces existing MDI desktop plugin configurations with a native window manager, main toolbar, and centered navigation tree plugin, adjusts default window geometry for multi-window workflows, and saves the updated preferences.

getInitialWindowState

public int getInitialWindowState()

Resolves the initial extended window state from user profile settings.

Inspects the WindowPosition profile configuration for an explicit state attribute. Falls back to mode-specific defaults: maximized for single-window manager mode, or normal state for multi-window manager mode.

Returns:

extended window state integer (e.g. Frame.MAXIMIZED_BOTH or Frame.NORMAL)

resolveConfiguredWindowState

public java.lang.Integer resolveConfiguredWindowState()

Extracts and parses the window state attribute from the profile, if present and valid.

getInitialWindowBounds

public java.awt.geom.Rectangle2D.Double getInitialWindowBounds()

Resolves the stored window bounds rectangle from the profile.

Returns:

configured bounds as Rectangle2D.Double, or null if missing or incomplete

saveWindowPosition

public void saveWindowPosition(de.ipcon.swing.WindowState state)

Records the live window geometry and state in the user profile and persists preferences.

Updates the WindowPosition element attributes with current coordinates and extended state. Omits explicit width or height attributes when the window is maximized along the corresponding axis. This prevents Mutter/GNOME from serializing 100% screen bounds as normal window geometry, which triggers its legacy fullscreen heuristic ("Quake III" behavior) and breaks un-maximization (see ticket 197127922).

Parameters:

state - live snapshot of window bounds and extended state; ignored if null

getPluginConfigurations

public java.util.List<electric.xml.Element> getPluginConfigurations()

Returns the list of configured plugin XML elements from the active profile.

Returns:

list of Element instances representing declared plugins; empty list if none or if profile is null