de.ipcon.form

Interface SchemaLocaleAwareFormElementI

All Superinterfaces:

FormElementI, FormElementWithDisplayPropertyI, L10nApplicatorI

All Known Implementing Classes:

FEmail, FTable, FTableColumn, FText, FUri

public interface SchemaLocaleAwareFormElementI
extends FormElementWithDisplayPropertyI

Interface for form elements that display data dependent on the current schema locale.

This serves as a marker and operational contract for the UI framework to identify components whose displayed content - specifically translated attribute values - must be synchronized whenever the InstrumentingSchemaI locale is changed.

In addition to identifying candidate elements, this interface provides evaluation methods to determine whether locale switching is practically relevant. By validating that the underlying attribute manages localized strings and verifying that multiple locales exist in the current runtime environment, UI contexts can avoid registering redundant listeners or triggering unnecessary repaints in single-locale setups.

Usage: The root form context receives locale-switch events and triggers targeted UI updates across all sub-contexts containing elements where locale synchronization is active and relevant.

Field Summary

Fields inherited from interface de.ipcon.form.FormElementWithDisplayPropertyI

log

Fields inherited from interface de.ipcon.form.FormElementI

ALL_ACTIONS, AVAILABLE_ACTION_KIND, CONTEXTMENU_ACTION_KIND, LOCAL_ACTION_KIND, MENU_ACTION_KIND, NO_LOCAL_ACTION_KIND, NO_TOPMDI_ONLY_ACTION_KIND, NOT_AVAILABLE_ACTION_KIND, REFRESH_FROM_SHOW_POPUP, REFRESH_FROM_TRANSACTION, REFRESH_FROM_USER, SHORTCUT_ACTION_KIND, TOOLBAR_ACTION_KIND, TOPMDI_ONLY_ACTION_KIND

Method Summary

Modifier and Type	Method and Description
default boolean	hasLocalizedAttribute() Determines if the underlying attribute specifically holds localized string data.
default boolean	isLocaleSwitchingRelevant() Checks whether this element has a localized attribute and multiple localization locales are available to switch between, using the default cache loader.
default boolean	isLocaleSwitchingRelevant(BOLoaderI bol) Checks whether this element has a localized attribute and multiple localization locales are available to switch between, using the specified loader or transaction context.

Methods inherited from interface de.ipcon.form.FormElementWithDisplayPropertyI

getAttribute, getDisplayProperty

Methods inherited from interface de.ipcon.form.FormElementI

addBeanA, addBeanA, addFormElementListener, addHandleA, addHandleA, addHandleE, addHandleE, afterSave, afterSetValue, applyL10n, beforeSave, beforeSetValue, close, getActions, getActionsOfKind, getAttribute, getAttribute, getAttributeMap, getBO, getConfRoot, getCtx, getCurrentLanguageCode, getCurrentLocale, getDebugName, getDefinitionErrorHandler, getElementConsideringIgnored, getElementMap, getFtx, getName, getSchema, handleAttributes, handleElement, handleElements, handleElements, handleElements, handleElements, handleError, handleNewElement, handleNewElement, handleNewElement, isClosed, isDebug, isEditable, isGUIBuilt, isIgnored, isInputPossible, isShown, mdiActivate, mdiClose, mdiDeactivate, mdiOpen, performAdditionalFormElementDefinitionChecks, postInit, postRefresh, refresh, refresh, removeFormElementListener, requestFocus, setEditable, showError, showError, sync, toDebugName, willCareForChildActions, willCareForChildRefresh

Method Detail

hasLocalizedAttribute

default boolean hasLocalizedAttribute()

Determines if the underlying attribute specifically holds localized string data.

This check verifies if the attribute's type is compatible with L10nedStringType, indicating that the value itself contains a translated text which stems from another persistent attribute managing multiple translations (typically of type L10nStringType).

Returns:

true if the attribute is an L10nedString; false otherwise.

isLocaleSwitchingRelevant

default boolean isLocaleSwitchingRelevant()

Checks whether this element has a localized attribute and multiple localization locales are available to switch between, using the default cache loader.

Returns:

true if the attribute is localized and more than one locale exists; false otherwise

isLocaleSwitchingRelevant

default boolean isLocaleSwitchingRelevant(BOLoaderI bol)

Checks whether this element has a localized attribute and multiple localization locales are available to switch between, using the specified loader or transaction context.

Parameters:

bol - the business object loader or transaction context; if null, the default cache loader is used

Returns:

true if the attribute is localized and more than one locale exists; false otherwise