ClientActionHelper (MyTISM API Documentation)

java.lang.Object
- de.ipcon.gui.AbstractClientHelper
- - de.ipcon.gui.ClientActionHelper

```
public class ClientActionHelper
extends AbstractClientHelper
```
Manages action registrations, hierarchy construction, and EDT dispatching for the client UI.
Coordinates global and MDI-scoped FormAction instances, builds the action definition tree from XML configuration, and synchronizes action states with ClientPluginHelper.

Constructor Summary

Constructors
Constructor and Description

ClientActionHelper(Client _client)
Constructs a new action helper bound to the specified client context and plugin subsystem.

Constructors
Constructor and Description
`ClientActionHelper(Client _client)` Constructs a new action helper bound to the specified client context and plugin subsystem.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`action_about()`
`boolean`	`action_changeGuiThemeToDefault_available()` Indicates whether the action to reset the GUI theme to default is currently available.
`void`	`action_changeGuiThemeToDefault()` Resets the user's configured GUI theme back to the platform default.
`void`	`action_changeLocale()`
`void`	`action_changePW()`
`void`	`action_exportSystemObjects()`
`void`	`action_flatlafDefaults()`
`void`	`action_flatlafInspector(java.awt.event.ActionEvent event)` Triggers the FlatLaf UI inspector for runtime visual debugging of any current UI LAF.
`void`	`action_flushCaches()`
`void`	`action_groovyConsole()`
`boolean`	`action_importLicense_available()`
`void`	`action_importLicense()`
`void`	`action_importSystemObjects()`
`boolean`	`action_installDawn_available()`
`void`	`action_installDawn()` Action installDawn will download the binary fitting to the current os/arch and call it the "-install $codebase/solstice.ds"
`void`	`action_keys()`
`void`	`action_openL10n()`
`void`	`action_quit()`
`void`	`action_reloadProfile()`
`void`	`action_reportAnIssue(FormAction action)` Opens the issue report form from the global menu (desktop screenshot).
`void`	`action_reportAnIssueFromMDIElement(FormAction action, java.awt.event.ActionEvent event)` Opens the issue report form from an MDI element toolbar (captures the specific element).
`void`	`action_saveProfile()` Captures current window geometry and persists profile preferences and session state.
`void`	`action_schemaTool()`
`void`	`action_serverConsole()`
`void`	`action_showReportIssueForm(BO sourceBO, Struktur sourceStruktur, java.awt.event.ActionEvent ae)` Deprecated.
`boolean`	`action_switchToMultiWindowDesktopManager_available()`
`void`	`action_switchToMultiWindowDesktopManager()`
`boolean`	`action_switchToSingleWindowDesktopManager_available()`
`void`	`action_switchToSingleWindowDesktopManager()`
`void`	`action_syncNG()`
`void`	`action_takeScreenshot()` Convenience overload that captures a screenshot without a triggering action event.
`void`	`action_takeScreenshot(java.awt.event.ActionEvent ae)` Captures a screenshot of the currently focused desktop component and exports it as a PNG file.
`void`	`action_toggleBOProperties(FormAction action)`
`void`	`action_toggleHiddenProperties(FormAction action)`
`void`	`action_toggleHistory(FormAction action)`
`void`	`action_zoomIn()`
`void`	`action_zoomOut()`
`void`	`action_zoomReset()`
`void`	`addAction(FormAction fa, MDIElementI mdie)` Registers an action either globally or scoped to a specific MDI element.
`void`	`checkActionsEnabledStatus()` Evaluates and updates the enablement state of all active actions.
`java.util.Map<java.lang.String,FormAction>`	`getActions()` Deprecated.
`java.util.Map<java.lang.String,FormAction>`	`getAllActions()` Returns all registered actions, including local and global definitions.
`java.util.Map<java.lang.String,FormAction>`	`getGlobalActions(FormContextI ftx)` Resolves all global actions applicable within the specified form context.
`void`	`initActElRoot()` Parses and initializes the root action definition tree from its XML configuration.
`void`	`initActions()` Schedules action re-initialization on the Event Dispatch Thread (EDT).
`void`	`initActionsOnEDT()` Rebuilds the action hierarchy on the Event Dispatch Thread (EDT).
`boolean`	`isIssueReportFormEnabled()`
`void`	`refreshActions()` Asynchronously refreshes the state and enablement of all registered actions on the EDT.
`void`	`refreshActionsOnEDT(boolean sync)` Refreshes the state and enablement of all registered actions on the EDT.
`void`	`removeAction(FormAction fa, MDIElementI mdie)` Unregisters an action either globally or from a specific MDI element scope.
`void`	`setActions(java.util.HashMap<java.lang.String,FormAction> m)` Deprecated.
`void`	`setAllActions(java.util.LinkedHashMap<java.lang.String,FormAction> m)` Deprecated.

Methods inherited from class de.ipcon.gui.AbstractClientHelper
client

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

- Constructor Detail
  - ClientActionHelper
```
public ClientActionHelper(Client _client)
```
    Constructs a new action helper bound to the specified client context and plugin subsystem.
    
    Parameters:
    
    _ctx - client runtime context
- Method Detail
  - getActions
```
@Deprecated
public java.util.Map<java.lang.String,FormAction> getActions()
```
    Deprecated.
    
    Returns the active client action registry mapped by action identifier.
    
    Returns:
    
    map of active action identifiers to form actions
  - setActions
```
@Deprecated
public void setActions(java.util.HashMap<java.lang.String,FormAction> m)
```
    Deprecated.
    
    Sets the active client action registry.
    
    Parameters:
    
    m - map of action identifiers to form actions
  - getAllActions
```
public java.util.Map<java.lang.String,FormAction> getAllActions()
```
    Returns all registered actions, including local and global definitions.
    
    Returns:
    
    complete ordered map of registered form actions
  - setAllActions
```
@Deprecated
public void setAllActions(java.util.LinkedHashMap<java.lang.String,FormAction> m)
```
    Deprecated.
    
    Sets the complete action registry using an ordered map.
    
    Parameters:
    
    m - ordered map of action identifiers to form actions
  - getGlobalActions
```
public java.util.Map<java.lang.String,FormAction> getGlobalActions(FormContextI ftx)
```
    Resolves all global actions applicable within the specified form context.
    
    Parameters:
    
    ftx - active form context
    
    Returns:
    
    map of global action identifiers to form actions
  - addAction
```
public void addAction(FormAction fa,
                      MDIElementI mdie)
```
    Registers an action either globally or scoped to a specific MDI element.
    
    Parameters:
    
    fa - form action to register
    
    mdie - target MDI element for locally scoped actions, or null to register globally
    
    Throws:
    
    java.lang.IllegalArgumentException - if a non-local, non-prototype action is registered in a multi-window environment
  - removeAction
```
public void removeAction(FormAction fa,
                         MDIElementI mdie)
```
    Unregisters an action either globally or from a specific MDI element scope.
    
    Parameters:
    
    fa - form action to remove
    
    mdie - target MDI element, or null to remove from the global scope
  - initActions
```
public void initActions()
```
    Schedules action re-initialization on the Event Dispatch Thread (EDT).
    Skips execution if initialization is already queued or if no user session is active.
  - initActElRoot
```
public void initActElRoot()
                   throws electric.xml.ParseException
```
    Parses and initializes the root action definition tree from its XML configuration.
    
    Throws:
    
    electric.xml.ParseException - if the underlying XML action structure is invalid or cannot be parsed
  - initActionsOnEDT
```
public void initActionsOnEDT()
```
    Rebuilds the action hierarchy on the Event Dispatch Thread (EDT).
    Clears existing registrations, parses core XML action definitions, triggers plugin action re-registration via ClientPluginHelper, and synchronizes action enablement states across the UI.
  - refreshActions
```
public void refreshActions()
```
    Asynchronously refreshes the state and enablement of all registered actions on the EDT.
  - refreshActionsOnEDT
```
public void refreshActionsOnEDT(boolean sync)
```
    Refreshes the state and enablement of all registered actions on the EDT.
    
    Parameters:
    
    sync - true to block until EDT execution finishes; false to queue asynchronously
  - checkActionsEnabledStatus
```
public void checkActionsEnabledStatus()
```
    Evaluates and updates the enablement state of all active actions.
  - action_reloadProfile
```
public void action_reloadProfile()
```
  - action_serverConsole
```
public void action_serverConsole()
```
  - action_groovyConsole
```
public void action_groovyConsole()
```
  - action_toggleHiddenProperties
```
public void action_toggleHiddenProperties(FormAction action)
```
  - action_toggleBOProperties
```
public void action_toggleBOProperties(FormAction action)
```
  - action_toggleHistory
```
public void action_toggleHistory(FormAction action)
```
  - action_zoomIn
```
public void action_zoomIn()
```
  - action_zoomReset
```
public void action_zoomReset()
```
  - action_zoomOut
```
public void action_zoomOut()
```
  - action_syncNG
```
public void action_syncNG()
```
  - action_exportSystemObjects
```
public void action_exportSystemObjects()
```
  - action_importSystemObjects
```
public void action_importSystemObjects()
```
  - action_openL10n
```
public void action_openL10n()
```
  - action_schemaTool
```
public void action_schemaTool()
```
  - action_switchToMultiWindowDesktopManager
```
public void action_switchToMultiWindowDesktopManager()
```
  - action_switchToMultiWindowDesktopManager_available
```
public boolean action_switchToMultiWindowDesktopManager_available()
```
  - action_switchToSingleWindowDesktopManager
```
public void action_switchToSingleWindowDesktopManager()
```
  - action_switchToSingleWindowDesktopManager_available
```
public boolean action_switchToSingleWindowDesktopManager_available()
```
  - action_saveProfile
```
public void action_saveProfile()
```
    Captures current window geometry and persists profile preferences and session state.
    Delegates window position serialization to ClientProfileSettingsHelper.saveWindowPosition(de.ipcon.swing.WindowState) before committing persistent session storage.
  - action_changeGuiThemeToDefault_available
```
public boolean action_changeGuiThemeToDefault_available()
```
    Indicates whether the action to reset the GUI theme to default is currently available.
    
    Returns:
    
    true if connected and a non-default profile theme is active; false otherwise
  - action_changeGuiThemeToDefault
```
public void action_changeGuiThemeToDefault()
```
    Resets the user's configured GUI theme back to the platform default.
    Delegates XML profile cleanup and persistence to ClientProfileSettingsHelper.resetGuiThemeToDefault().
  - action_changePW
```
public void action_changePW()
```
  - action_quit
```
public void action_quit()
```
  - action_about
```
public void action_about()
```
  - action_keys
```
public void action_keys()
```
  - action_importLicense
```
public void action_importLicense()
```
  - action_importLicense_available
```
public boolean action_importLicense_available()
```
  - action_changeLocale
```
public void action_changeLocale()
```
  - action_reportAnIssue
```
public void action_reportAnIssue(FormAction action)
```
    Opens the issue report form from the global menu (desktop screenshot).
  - action_reportAnIssueFromMDIElement
```
public void action_reportAnIssueFromMDIElement(FormAction action,
                                               java.awt.event.ActionEvent event)
```
    Opens the issue report form from an MDI element toolbar (captures the specific element).
  - action_takeScreenshot
```
public void action_takeScreenshot()
```
    Convenience overload that captures a screenshot without a triggering action event.
    
    See Also:
    
    action_takeScreenshot(ActionEvent)
  - action_takeScreenshot
```
public void action_takeScreenshot(java.awt.event.ActionEvent ae)
```
    Captures a screenshot of the currently focused desktop component and exports it as a PNG file.
    Target selection adapts to the active window management mode:
    - In multi-window mode, captures the currently active internal frame or child window.
    - In single-window mode (or when no child window holds focus), falls back to capturing the primary application mainframe.
    Presents a modal file selection dialog for destination path and filename selection. Displays a confirmation dialog upon successful write, or surfaces a descriptive error dialog if image capture, encoding, or file I/O operations fail.
    Parameters:
    
    ae - the triggering action event; may be null if invoked programmatically
  - isIssueReportFormEnabled
```
public boolean isIssueReportFormEnabled()
```
  - action_showReportIssueForm
```
@Deprecated
public void action_showReportIssueForm(BO sourceBO,
                                                   Struktur sourceStruktur,
                                                   java.awt.event.ActionEvent ae)
```
    Deprecated.
  - action_installDawn
```
public void action_installDawn()
```
    Action installDawn will download the binary fitting to the current os/arch and call it the "-install $codebase/solstice.ds"
  - action_installDawn_available
```
public boolean action_installDawn_available()
```
  - action_flushCaches
```
public void action_flushCaches()
```
  - action_flatlafDefaults
```
public void action_flatlafDefaults()
```
  - action_flatlafInspector
```
public void action_flatlafInspector(java.awt.event.ActionEvent event)
```
    Triggers the FlatLaf UI inspector for runtime visual debugging of any current UI LAF.
    Only responds if invoked explicitly via menu item to avoid collision with the inspector's built-in global key listener.

Class ClientActionHelper

Constructor Summary

Method Summary

Methods inherited from class de.ipcon.gui.AbstractClientHelper

Methods inherited from class java.lang.Object

Constructor Detail

ClientActionHelper

Method Detail

getActions

setActions

getAllActions

setAllActions

getGlobalActions

addAction

removeAction

initActions

initActElRoot

initActionsOnEDT

refreshActions

refreshActionsOnEDT

checkActionsEnabledStatus

action_reloadProfile

action_serverConsole

action_groovyConsole

action_toggleHiddenProperties

action_toggleBOProperties

action_toggleHistory

action_zoomIn

action_zoomReset

action_zoomOut

action_syncNG

action_exportSystemObjects

action_importSystemObjects

action_openL10n

action_schemaTool

action_switchToMultiWindowDesktopManager

action_switchToMultiWindowDesktopManager_available

action_switchToSingleWindowDesktopManager

action_switchToSingleWindowDesktopManager_available

action_saveProfile

action_changeGuiThemeToDefault_available

action_changeGuiThemeToDefault

action_changePW

action_quit

action_about

action_keys

action_importLicense

action_importLicense_available

action_changeLocale

action_reportAnIssue

action_reportAnIssueFromMDIElement

action_takeScreenshot

action_takeScreenshot

isIssueReportFormEnabled

action_showReportIssueForm

action_installDawn

action_installDawn_available

action_flushCaches

action_flatlafDefaults

action_flatlafInspector