de.ipcon.form

Interface FormElementI

All Superinterfaces:

L10nApplicatorI

All Known Subinterfaces:

DetailViewOwnerI, FormElementWithDisplayPropertyI, FTableConfigurationI, FTreeConfigurationI, PopupableFormElementI

All Known Implementing Classes:

FBooleanInputComponent, FBorder, FButton, FCanvas, FChart, FCheckBox, FComboBox, FDateChooser, FDetailView, FEditor, FElement, FEmail, FHideablePanel, FImage, FInputPanel, FJRDesignViewer, FLabel, FLocked, FormAction, FPanel, FPDFViewer, FPopup, FRootPane, FScheduler, FSimpleDurationChooser, FSimpleTimespanChooser, FStyledText, FTab, FTabbedView, FTable, FTableColumn, FText, FTextInputComponent, FTimespanChooser, FToggleButton, FTree, FUri, FView, LiquidSeparatorLabel

public interface FormElementI
extends L10nApplicatorI

Defines the contract for an element within a form.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_ACTIONS
static int	AVAILABLE_ACTION_KIND
static int	CONTEXTMENU_ACTION_KIND
static int	LOCAL_ACTION_KIND
static org.apache.log4j.Logger	log
static int	MENU_ACTION_KIND
static int	NO_LOCAL_ACTION_KIND
static int	NO_TOPMDI_ONLY_ACTION_KIND
static int	NOT_AVAILABLE_ACTION_KIND
static int	REFRESH_FROM_TRANSACTION
static int	REFRESH_FROM_USER
static int	SHORTCUT_ACTION_KIND
static int	TOOLBAR_ACTION_KIND
static int	TOPMDI_ONLY_ACTION_KIND

Method Summary

Modifier and Type	Method and Description
static void	addBeanA(java.lang.Class<? extends FormElementI> clazz, java.util.Map<java.lang.String,MethodLocalizationWrapper> m, java.lang.String attributeName, boolean localizable) Searches for a static setter method on the given clazz corresponding to the attributeName.
default void	addBeanA(java.util.Map<java.lang.String,MethodLocalizationWrapper> m, java.lang.String attributeName, boolean localizable)
void	addFormElementListener(FormElementListenerI l)
static void	addHandleA(java.lang.Class<? extends FormElementI> clazz, java.util.Map<java.lang.String,MethodLocalizationWrapper> m, java.lang.String attributeName, boolean localizable) Searches for a handler method on the given clazz corresponding to the attributeName.
default void	addHandleA(java.util.Map<java.lang.String,MethodLocalizationWrapper> m, java.lang.String attributeName, boolean localizable)
static void	addHandleE(java.lang.Class<? extends FormElementI> clazz, java.util.Map<java.lang.String,java.lang.reflect.Method> m, java.lang.String elementName) Searches for a handler method on the given clazz corresponding to the elementName.
default void	addHandleE(java.util.Map<java.lang.String,java.lang.reflect.Method> m, java.lang.String elementName)
void	afterSave()
void	afterSetValue(java.lang.Object old, java.lang.Object newO)
default java.lang.String	applyL10n(java.lang.String s)
void	beforeSave()
void	beforeSetValue(java.lang.Object old, java.lang.Object newO)
void	close()
java.util.LinkedHashMap	getActions()
java.util.LinkedHashMap	getActionsOfKind(int kind)
java.util.HashMap<java.lang.String,MethodLocalizationWrapper>	getAttributeMap()
electric.xml.Element	getConfRoot()
ClientContextI	getCtx()
java.lang.String	getDebugName()
default DefinitionErrorHandlerI	getDefinitionErrorHandler()
static electric.xml.Element	getElementConsideringIgnored(electric.xml.Element root, java.lang.String name) Searches for a child Element with the specified name under the root element.
java.util.HashMap	getElementMap()
FormContextI	getFtx()
java.lang.String	getName()
SchemaI	getSchema()
default void	handleAttributes(java.util.Map<java.lang.String,MethodLocalizationWrapper> attrName2MethodWrapper) Handles configuration attributes for this form element, performing type conversion and reflection method invocation.
default boolean	handleElement(java.util.Map<java.lang.String,java.lang.reflect.Method> elementName2MethodWrapper, electric.xml.Element el) Handles processing an XML element by invoking a reflective method based on the element's name.
default void	handleElements(electric.xml.Element root, java.util.Map<java.lang.String,java.lang.reflect.Method> elementName2MethodWrapper, boolean subsPossible, java.lang.String implyElement, java.lang.String implyPrefix) Recursively processes configuration elements within a root element.
default void	handleElements(java.util.HashMap elementName2MethodWrapper, boolean subsPossible)
default void	handleElements(java.util.HashMap elementName2MethodWrapper, boolean subsPossible, java.lang.String implyElement)
default void	handleElements(java.util.HashMap elementName2MethodWrapper, boolean subsPossible, java.lang.String implyElement, java.lang.String implyPrefix)
default void	handleError(java.lang.String msg, electric.xml.Element el, java.lang.Throwable cause, boolean mayContinue)
default FormElementI	handleNewElement(electric.xml.Element el)
default FormElementI	handleNewElement(electric.xml.Element el, java.lang.String aka)
default FormElementI	handleNewElement(electric.xml.Element el, java.lang.String aka, FormContextI preparedFtx)
boolean	isClosed()
boolean	isDebug()
boolean	isEditable()
boolean	isGUIBuilt()
static boolean	isIgnored(electric.xml.Element el) Checks if the given Element should be ignored during element retrieval operations.
boolean	isInputPossible()
boolean	isShown()
void	mdiActivate(MDIElementI me) Invoked when this form element is activated within an MDI environment.
void	mdiClose(MDIElementI me)
void	mdiDeactivate(MDIElementI me) Invoked when this form element is deactivated within an MDI environment.
void	mdiOpen(MDIElementI me)
default void	performAdditionalFormElementDefinitionChecks()
void	postInit()
void	postRefresh(int from)
void	refresh()
void	refresh(int from)
void	removeFormElementListener(FormElementListenerI l)
void	requestFocus()
boolean	setEditable(boolean isEditable)
default void	showError(java.lang.String message)
default void	showError(java.lang.String message, java.lang.Throwable t)
void	sync()
static java.lang.String	toDebugName(java.lang.Object o) A helper method to create a human-readable string representation of an object, typically a Frame or Component like FPanel.
boolean	willCareForChildActions()
boolean	willCareForChildRefresh()

Field Detail

log

static final org.apache.log4j.Logger log

ALL_ACTIONS

static final int ALL_ACTIONS

See Also:

Constant Field Values

TOOLBAR_ACTION_KIND

static final int TOOLBAR_ACTION_KIND

See Also:

Constant Field Values

MENU_ACTION_KIND

static final int MENU_ACTION_KIND

See Also:

Constant Field Values

CONTEXTMENU_ACTION_KIND

static final int CONTEXTMENU_ACTION_KIND

See Also:

Constant Field Values

SHORTCUT_ACTION_KIND

static final int SHORTCUT_ACTION_KIND

See Also:

Constant Field Values

LOCAL_ACTION_KIND

static final int LOCAL_ACTION_KIND

See Also:

Constant Field Values

NO_LOCAL_ACTION_KIND

static final int NO_LOCAL_ACTION_KIND

See Also:

Constant Field Values

TOPMDI_ONLY_ACTION_KIND

static final int TOPMDI_ONLY_ACTION_KIND

See Also:

Constant Field Values

NO_TOPMDI_ONLY_ACTION_KIND

static final int NO_TOPMDI_ONLY_ACTION_KIND

See Also:

Constant Field Values

AVAILABLE_ACTION_KIND

static final int AVAILABLE_ACTION_KIND

See Also:

Constant Field Values

NOT_AVAILABLE_ACTION_KIND

static final int NOT_AVAILABLE_ACTION_KIND

See Also:

Constant Field Values

REFRESH_FROM_USER

static final int REFRESH_FROM_USER

See Also:

Constant Field Values

REFRESH_FROM_TRANSACTION

static final int REFRESH_FROM_TRANSACTION

See Also:

Constant Field Values

Method Detail

getConfRoot

electric.xml.Element getConfRoot()

getFtx

FormContextI getFtx()

getCtx

ClientContextI getCtx()

getSchema

SchemaI getSchema()

getName

java.lang.String getName()

applyL10n

default java.lang.String applyL10n(java.lang.String s)

Specified by:

applyL10n in interface L10nApplicatorI

getAttributeMap

java.util.HashMap<java.lang.String,MethodLocalizationWrapper> getAttributeMap()

getElementMap

java.util.HashMap getElementMap()

addBeanA

default void addBeanA(java.util.Map<java.lang.String,MethodLocalizationWrapper> m,
                      java.lang.String attributeName,
                      boolean localizable)

addBeanA

static void addBeanA(java.lang.Class<? extends FormElementI> clazz,
                     java.util.Map<java.lang.String,MethodLocalizationWrapper> m,
                     java.lang.String attributeName,
                     boolean localizable)

Searches for a static setter method on the given clazz corresponding to the attributeName. The method name is constructed by translating hyphens ('-') to underscores ('_'), capitalizing the first letter of the attributeName and prefixing it with "set" (e.g., "name-bla" -> "setName_bla"). The search is restricted to methods with exactly one parameter.

Parameters:

clazz - The Class to search for the setter method.

m - The map to store the found method wrapper (key: attributeName).

attributeName - The property name (e.g., "title", "description").

localizable - Whether the property supports localization.

addHandleA

default void addHandleA(java.util.Map<java.lang.String,MethodLocalizationWrapper> m,
                        java.lang.String attributeName,
                        boolean localizable)

addHandleA

static void addHandleA(java.lang.Class<? extends FormElementI> clazz,
                       java.util.Map<java.lang.String,MethodLocalizationWrapper> m,
                       java.lang.String attributeName,
                       boolean localizable)

Searches for a handler method on the given clazz corresponding to the attributeName. The method name is constructed by: 1. Translating hyphens ('-') to underscores ('_'). 2. Capitalizing the first letter of the translated name. 3. Prefixing the result with "handle" and suffixing it with "A" (e.g., "user-name" -> "handleUser_nameA"). The method must take exactly one parameter of type String.

Parameters:

clazz - The Class to search for the handler method.

m - The map to store the found method wrapper (key: attributeName).

attributeName - The property name (e.g., "title", "description").

localizable - Whether the property supports localization.

addHandleE

default void addHandleE(java.util.Map<java.lang.String,java.lang.reflect.Method> m,
                        java.lang.String elementName)

addHandleE

static void addHandleE(java.lang.Class<? extends FormElementI> clazz,
                       java.util.Map<java.lang.String,java.lang.reflect.Method> m,
                       java.lang.String elementName)

Searches for a handler method on the given clazz corresponding to the elementName. The method name is constructed by: 1. Translating hyphens ('-') to underscores ('_'). 2. Capitalizing the first letter of the translated name. 3. Prefixing the result with "handle" and suffixing it with "E" (e.g. "user-click" -> "handleUser_clickE"). The method must take exactly one parameter of type electric.xml.Element.

Parameters:

clazz - The Class to search for the handler method.

m - The map to store the found method (key: elementName).

elementName - The element attribute name.

handleAttributes

default void handleAttributes(java.util.Map<java.lang.String,MethodLocalizationWrapper> attrName2MethodWrapper)

Handles configuration attributes for this form element, performing type conversion and reflection method invocation.

Parameters:

attrName2MethodWrapper - A map of attribute names to method wrappers.

performAdditionalFormElementDefinitionChecks

default void performAdditionalFormElementDefinitionChecks()

handleElements

default void handleElements(java.util.HashMap elementName2MethodWrapper,
                            boolean subsPossible)

handleElements

default void handleElements(java.util.HashMap elementName2MethodWrapper,
                            boolean subsPossible,
                            java.lang.String implyElement)

handleElements

default void handleElements(java.util.HashMap elementName2MethodWrapper,
                            boolean subsPossible,
                            java.lang.String implyElement,
                            java.lang.String implyPrefix)

handleElements

default void handleElements(electric.xml.Element root,
                            java.util.Map<java.lang.String,java.lang.reflect.Method> elementName2MethodWrapper,
                            boolean subsPossible,
                            java.lang.String implyElement,
                            java.lang.String implyPrefix)

Recursively processes configuration elements within a root element. It handles element-specific logic, attribute implication, and error reporting.

Parameters:

root - The current root element whose children are being processed.

elementName2MethodWrapper - A map of element names to the Method object that handles them.

subsPossible - If true, allows the creation of new elements via o.handleNewElement.

implyElement - The name of the element to use for implication, or null.

implyPrefix - The prefix for attributes to move to the implied element.

handleElement

default boolean handleElement(java.util.Map<java.lang.String,java.lang.reflect.Method> elementName2MethodWrapper,
                              electric.xml.Element el)

Handles processing an XML element by invoking a reflective method based on the element's name.

Parameters:

elementName2MethodWrapper - A map of element names to the Method object that handles them.

el - The configuration element to process.

Returns:

true if a handler method was found and executed (even if it threw a handled exception), false if no handler method was found.

handleNewElement

default FormElementI handleNewElement(electric.xml.Element el)

handleNewElement

default FormElementI handleNewElement(electric.xml.Element el,
                                      java.lang.String aka)

handleNewElement

default FormElementI handleNewElement(electric.xml.Element el,
                                      java.lang.String aka,
                                      FormContextI preparedFtx)

postInit

void postInit()

mdiOpen

void mdiOpen(MDIElementI me)
      throws java.lang.Exception

Throws:

java.lang.Exception

mdiClose

void mdiClose(MDIElementI me)
       throws java.lang.Exception

Throws:

java.lang.Exception

mdiActivate

void mdiActivate(MDIElementI me)
          throws java.lang.Exception

Invoked when this form element is activated within an MDI environment.

This method is called when the form element becomes the active, or currently selected, component in its MDI parent. Implementations should handle any necessary updates, refreshes, or setup that needs to occur when the element is brought into focus.

Parameters:

me - The MDIElementI that is being activated.

Throws:

java.lang.Exception - if an error occurs during activation.

mdiDeactivate

void mdiDeactivate(MDIElementI me)
            throws java.lang.Exception

Invoked when this form element is deactivated within an MDI environment.

This method is called when the form element is no longer the active component in its MDI parent. Implementations should handle any necessary cleanup, state saving, or resource release that needs to occur when the element loses focus.

Parameters:

me - The MDIElementI that is being deactivated.

Throws:

java.lang.Exception - if an error occurs during deactivation.

addFormElementListener

void addFormElementListener(FormElementListenerI l)

removeFormElementListener

void removeFormElementListener(FormElementListenerI l)

sync

void sync()

beforeSave

void beforeSave()

afterSave

void afterSave()

refresh

void refresh(int from)

refresh

void refresh()

postRefresh

void postRefresh(int from)

willCareForChildRefresh

boolean willCareForChildRefresh()

beforeSetValue

void beforeSetValue(java.lang.Object old,
                    java.lang.Object newO)

afterSetValue

void afterSetValue(java.lang.Object old,
                   java.lang.Object newO)

getActions

java.util.LinkedHashMap getActions()

willCareForChildActions

boolean willCareForChildActions()

getActionsOfKind

java.util.LinkedHashMap getActionsOfKind(int kind)

setEditable

boolean setEditable(boolean isEditable)

isEditable

boolean isEditable()

isShown

boolean isShown()

isInputPossible

boolean isInputPossible()

isGUIBuilt

boolean isGUIBuilt()

requestFocus

void requestFocus()

close

void close()

isClosed

boolean isClosed()

isDebug

boolean isDebug()

getDebugName

java.lang.String getDebugName()

toDebugName

static java.lang.String toDebugName(java.lang.Object o)

A helper method to create a human-readable string representation of an object, typically a Frame or Component like FPanel.

Parameters:

o - The Object to format.

Returns:

A formatted String with the object's simple class name and other relevant details.

isIgnored

static boolean isIgnored(electric.xml.Element el)

Checks if the given Element should be ignored during element retrieval operations. Ignored elements are typically "Include" containers which should be transparent, i.e. traversed to find the requested child elements.

Parameters:

el - The Element to check. May be null (though ideally shouldn't be).

Returns:

true if the element should be ignored and descended into; false otherwise.

getElementConsideringIgnored

static electric.xml.Element getElementConsideringIgnored(electric.xml.Element root,
                                                         java.lang.String name)

Searches for a child Element with the specified name under the root element. The search recursively descends into any elements identified as 'ignored' by the IgnoredElementChecker#isIgnored(Element) method. This effectively treats ignored elements as transparent containers. The search is performed depth-first and returns the first match found.

Parameters:

root - The root Element to start the search from.

name - The name of the child element to find (case-sensitive).

Returns:

The matching Element, or null if no element is found or if input is invalid.

getDefinitionErrorHandler

default DefinitionErrorHandlerI getDefinitionErrorHandler()

handleError

default void handleError(java.lang.String msg,
                         electric.xml.Element el,
                         java.lang.Throwable cause,
                         boolean mayContinue)

showError

default void showError(java.lang.String message)

showError

default void showError(java.lang.String message,
                       java.lang.Throwable t)