de.ipcon.form

Interface FormContextI

All Superinterfaces:

BreadcrumbContextI

All Known Implementing Classes:

DefaultFormContext

public interface FormContextI
extends BreadcrumbContextI

Defines an interface for connecting forms (of any type) with their associated data objects.

These contexts can be hierarchically linked together. This allows for the representation of complex data connections. For example, it can be used for true sub-forms within their own windows.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0
static java.lang.ThreadLocal<DefaultBreadcrumbFinder>	BREADCRUMB_FINDER_FOR_THREAD

Method Summary

Modifier and Type	Method and Description
void	addFormContextListener(FormContextListenerI l)
void	addSubContext(FormContextI a)
void	afterSave()
void	appendThisAndAllSubContexts(java.util.List l)
void	beforeSave()
boolean	boWasChangedExternally()
VisibilityI	cacheVisibility(VisibilityI v)
void	clearCachedVisibility()
void	clearTransaction()
void	close()
FormContextI	createSubFormContext()
void	disableConflictCheckDuringSave() Don't ignore conflicts during saving anymore if previously enabled.
void	enableConflictCheckDuringSave() Registers a default FormContextSaveHandlerI that doesn't ignore conflicts during saving.
static DefaultBreadcrumbFinder	enterBreadcrumb(FormContextI ftx) Establishes a new breadcrumb context for the current thread and returns the associated finder.
static void	exitBreadcrumb(FormContextI ftx) Clears the breadcrumb context for the current thread.
default FormElementI	findOnlyFormElement(java.lang.Class<? extends FormElementI> ofType) Find and return the only form element of the given type in the entire form context.
java.util.LinkedHashMap	getAllActionsOfKind(int kind)
FormElementI	getAt(java.lang.String n)
Transaction.Savepoint	getBeforeUserChangesSavepoint()
BO	getBO()
BO	getBO(boolean _synchronized)
BOLoaderI	getBOLoader()
BO[]	getBOs()
default BO	getContextBO() Gets the associated business object for this specific context, returning the value directly.
ClientContextI	getCtx()
DBManEventProviderI	getEventProvider()
FormElementI	getFormElement()
default javax.swing.ImageIcon	getIcon(java.lang.String name)
default javax.swing.ImageIcon	getIcon(java.lang.String name, java.awt.Color color)
default javax.swing.ImageIcon	getIcon(java.lang.String name, java.awt.Color color, boolean allowUnderlay)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context, java.awt.Color color)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context, java.awt.Color color, boolean allowUnderlay)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context, java.lang.String configuration)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context, java.lang.String configuration, java.awt.Color color)
default javax.swing.ImageIcon	getIcon(java.lang.String name, de.ipcon.swing.IconDisplayContext context, java.lang.String configuration, java.awt.Color color, boolean allowUnderlay)
default javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String configuration)
default javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String configuration, java.awt.Color color)
default javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String configuration, java.awt.Color color, boolean allowUnderlay)
java.awt.Component	getIconContextObject()
javax.swing.JRootPane	getJRootPane()
EntityI	getLowestCommonDenominateEntity()
FormElementI	getNamedElement(java.lang.String n)
FormContextI	getParent()
default BreadcrumbContextI	getParentBreadcrumbContext() Gets the parent context of the current context, returning the value directly.
java.lang.String	getPath()
void	getPath(java.lang.StringBuilder s)
FormContextI	getRoot()
javax.swing.RootPaneContainer	getRootPaneContainer()
FormContextSaveHandlerI	getSaveHandler()
BeanShellScript	getScript()
java.util.Map	getScriptParameters()
java.util.List	getSubContexts()
java.util.Iterator	getSubContextsIterator()
FormContextI[]	getThisAndAllSubContextsAsArray()
Transaction	getTransaction()
VisibilityI	getVisibility()
boolean	hasCachedVisibility()
boolean	hasScript()
boolean	hasUnsavedFormData()
boolean	hasUnsavedUserData()
void	initScript()
void	invalidateAllSubContextsCache()
boolean	isClosed()
boolean	isRoot()
boolean	isSyncEventHandlingPaused() If true, then {link #sync()} calls for this element should be ignored, e.g. because the form is currently saving.
void	mdiActivate(MDIElementI me)
void	mdiClose(MDIElementI me)
void	mdiDeactivate(MDIElementI me)
void	mdiOpen(MDIElementI me)
boolean	pauseFiringNewProcs() Creates a token to pause updating the GUI with changes in the Transaction for a while.
void	refreshBO(FormContextI _realFtx, java.lang.String _propertyname, boolean _transactionControl, boolean _autoCreate, electric.xml.Element _confRoot)
void	refreshForms() Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.
void	refreshForms(int from) Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.
void	refreshForms(int from, long onlyBOId, long ifNotSince) Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.
void	refreshFormsFromInitialViewRefresh() Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI in the context of an initial view refresh.
void	refreshView() Only refreshes the window titles and other 'outside' stuff, not the form itself or parts of it.
void	removeAllFormContextListeners()
void	removeFormContextListener(FormContextListenerI l)
void	removeSubContext(FormContextI a)
void	resetBOWasChangedExternally()
boolean	resumeFiringNewProcs() Resumes updates to the GUI after a previous call of pauseFiringNewProcs(), unless updates are inh, due to changes in the Transaction for a while.
boolean	saveFormData()
boolean	saveFormData(boolean willCloseRightAfter)
void	setBeforeUserChangesSavepoint(Transaction.Savepoint _sp)
boolean	setBO(BO bo)
void	setBOLoader(BOLoaderI bol)
void	setEditable(boolean b)
void	setEditable(boolean b, boolean dontRefresh)
void	setFormElement(FormElementI j)
void	setJRootPane(javax.swing.JRootPane rp)
void	setLowestCommonDenominateEntity(EntityI ent)
void	setNamedElement(java.lang.String n, FormElementI e)
void	setParent(FormContextI a)
void	setRootPaneContainer(javax.swing.RootPaneContainer rpc)
void	setSaveHandler(FormContextSaveHandlerI sh)
void	setScript(BeanShellScript b)
void	setScriptParameters(java.util.Map m)
void	setTransaction(Transaction tx)
void	setVisibilityTransient()
void	startListeningNewProcs() internal
void	sync() Synchronize the data of the form and the model
void	toast(java.lang.String text)
void	toast(java.lang.String text, int delay)
void	toastError(java.lang.String text)
void	toastError(java.lang.String text, int delay)
boolean	tryFocus() Attempts to set the keyboard focus to an appropriate component within this form context.

Methods inherited from interface de.ipcon.schema.BreadcrumbContextI

findFirstBO, findFirstBOOfType, findFirstBOWhere, findParentBO

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

BREADCRUMB_FINDER_FOR_THREAD

static final java.lang.ThreadLocal<DefaultBreadcrumbFinder> BREADCRUMB_FINDER_FOR_THREAD

Method Detail

enterBreadcrumb

static DefaultBreadcrumbFinder enterBreadcrumb(FormContextI ftx)

Establishes a new breadcrumb context for the current thread and returns the associated finder.

This method should be called before a form element's attribute accessor (getter, setter, etc.) is called to enable breadcrumb navigation in the form contexts of the current view/UI.

It retrieves the thread-local finder, initializing a new one if it doesn't exist. It then sets the provided FormContextI as the starting context for the finder, but only if the finder's context is not already set. This prevents overwriting an existing context, which is crucial for nested accessor calls, as only the initial starting point in the structure shall be the starting point of the breadcrumb navigation.

Moreover, the ThreadLocal is by choice not an InheritableThreadLocal, as any threads that are spawned off the accessor should be ignorant of the breadcrumb navigation. They may run in parallel or longer than the parent thread, posing the risk of the parent thread being reused for a new accessor call that changes the value of the InheritableThreadLocal for the spawned thread, thus creating a false Breadcrumb navigation for that child thread.

If the context is successfully set, this method also updates the thread-local finder in the Breadcrumb convenience class, providing a static entry point for forms to access the current breadcrumb context finder.

Parameters:

ftx - The FormContextI instance associated with the current form element.

Returns:

The DefaultBreadcrumbFinder instance associated with the current thread.

exitBreadcrumb

static void exitBreadcrumb(FormContextI ftx)

Clears the breadcrumb context for the current thread.

This method should be called after a form element's attribute accessor call has ended (preferably in a finally block) to clear the thread-local context. It retrieves the finder for the current thread and attempts to clear its context, but only if it matches the provided FormContextI instance. This prevents unintended side effects in nested contexts by ensuring only the correct context is cleared.

Parameters:

ftx - The FormContextI instance for which the breadcrumb context for the current thread is to be cleared.

getCtx

ClientContextI getCtx()

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      java.awt.Color color)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      java.awt.Color color,
                                      boolean allowUnderlay)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context,
                                      java.awt.Color color)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context,
                                      java.awt.Color color,
                                      boolean allowUnderlay)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      java.lang.String configuration)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      java.lang.String configuration,
                                      java.awt.Color color)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      java.lang.String configuration,
                                      java.awt.Color color,
                                      boolean allowUnderlay)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context,
                                      java.lang.String configuration)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context,
                                      java.lang.String configuration,
                                      java.awt.Color color)

getIcon

default javax.swing.ImageIcon getIcon(java.lang.String name,
                                      de.ipcon.swing.IconDisplayContext context,
                                      java.lang.String configuration,
                                      java.awt.Color color,
                                      boolean allowUnderlay)

getIconContextObject

java.awt.Component getIconContextObject()

getParent

FormContextI getParent()

setParent

void setParent(FormContextI a)

isRoot

boolean isRoot()

getRoot

FormContextI getRoot()

getPath

java.lang.String getPath()

getPath

void getPath(java.lang.StringBuilder s)

getNamedElement

FormElementI getNamedElement(java.lang.String n)

setNamedElement

void setNamedElement(java.lang.String n,
                     FormElementI e)

getAt

FormElementI getAt(java.lang.String n)

createSubFormContext

FormContextI createSubFormContext()

addSubContext

void addSubContext(FormContextI a)

removeSubContext

void removeSubContext(FormContextI a)

getSubContexts

java.util.List getSubContexts()

getSubContextsIterator

java.util.Iterator getSubContextsIterator()

getThisAndAllSubContextsAsArray

FormContextI[] getThisAndAllSubContextsAsArray()

appendThisAndAllSubContexts

void appendThisAndAllSubContexts(java.util.List l)

invalidateAllSubContextsCache

void invalidateAllSubContextsCache()

getLowestCommonDenominateEntity

EntityI getLowestCommonDenominateEntity()

setLowestCommonDenominateEntity

void setLowestCommonDenominateEntity(EntityI ent)

getBO

BO getBO()

getBO

BO getBO(boolean _synchronized)

setBO

boolean setBO(BO bo)

getBOs

BO[] getBOs()

setEditable

void setEditable(boolean b)

setEditable

void setEditable(boolean b,
                 boolean dontRefresh)

getJRootPane

javax.swing.JRootPane getJRootPane()

setJRootPane

void setJRootPane(javax.swing.JRootPane rp)

setRootPaneContainer

void setRootPaneContainer(javax.swing.RootPaneContainer rpc)

getRootPaneContainer

javax.swing.RootPaneContainer getRootPaneContainer()

setFormElement

void setFormElement(FormElementI j)

getFormElement

FormElementI getFormElement()

findOnlyFormElement

default FormElementI findOnlyFormElement(java.lang.Class<? extends FormElementI> ofType)

Find and return the only form element of the given type in the entire form context.

Parameters:

ofType - the type of form element to look for

Returns:

the only form element of the given type that was requested or null if such a form element was not found or is not unique

getParentBreadcrumbContext

default BreadcrumbContextI getParentBreadcrumbContext()

Description copied from interface: BreadcrumbContextI

Gets the parent context of the current context, returning the value directly.

Specified by:

getParentBreadcrumbContext in interface BreadcrumbContextI

Returns:

The parent context, or null if there is no parent.

getContextBO

default BO getContextBO()

Description copied from interface: BreadcrumbContextI

Gets the associated business object for this specific context, returning the value directly.

Specified by:

getContextBO in interface BreadcrumbContextI

Returns:

The associated business object, or null if this context has no business object.

cacheVisibility

VisibilityI cacheVisibility(VisibilityI v)

setVisibilityTransient

void setVisibilityTransient()

hasCachedVisibility

boolean hasCachedVisibility()

getVisibility

VisibilityI getVisibility()

clearCachedVisibility

void clearCachedVisibility()

mdiOpen

void mdiOpen(MDIElementI me)

mdiClose

void mdiClose(MDIElementI me)

mdiActivate

void mdiActivate(MDIElementI me)

mdiDeactivate

void mdiDeactivate(MDIElementI me)

getAllActionsOfKind

java.util.LinkedHashMap getAllActionsOfKind(int kind)

initScript

void initScript()

setScript

void setScript(BeanShellScript b)

getScript

BeanShellScript getScript()

hasScript

boolean hasScript()

setScriptParameters

void setScriptParameters(java.util.Map m)

getScriptParameters

java.util.Map getScriptParameters()

setTransaction

void setTransaction(Transaction tx)

getTransaction

Transaction getTransaction()

clearTransaction

void clearTransaction()

setBOLoader

void setBOLoader(BOLoaderI bol)

getBOLoader

BOLoaderI getBOLoader()

pauseFiringNewProcs

boolean pauseFiringNewProcs()

Creates a token to pause updating the GUI with changes in the Transaction for a while. If returned true, then a later call of resumeFiringNewProcs() is necessary.

Returns:

true if a transaction was available and the call to this method had any effect.

resumeFiringNewProcs

boolean resumeFiringNewProcs()

Resumes updates to the GUI after a previous call of pauseFiringNewProcs(), unless updates are inh, due to changes in the Transaction for a while. Preceeded by a previous call to pauseFireNewProcs()

Returns:

true if a transaction was available and the call to this method had any effect.

startListeningNewProcs

void startListeningNewProcs()

internal

getSaveHandler

FormContextSaveHandlerI getSaveHandler()

setSaveHandler

void setSaveHandler(FormContextSaveHandlerI sh)

hasUnsavedFormData

boolean hasUnsavedFormData()

hasUnsavedUserData

boolean hasUnsavedUserData()

boWasChangedExternally

boolean boWasChangedExternally()

resetBOWasChangedExternally

void resetBOWasChangedExternally()

sync

void sync()

Synchronize the data of the form and the model

isSyncEventHandlingPaused

boolean isSyncEventHandlingPaused()

If true, then {link #sync()} calls for this element should be ignored, e.g. because the form is currently saving. Can be disabled for all elements on the root context

beforeSave

void beforeSave()

afterSave

void afterSave()

saveFormData

boolean saveFormData(boolean willCloseRightAfter)

Returns:

true if save proceeded normally, false if there was a conflict and automatic retries should be prevented, even if the transaction is still active.

saveFormData

boolean saveFormData()

See Also:

with parameter false

enableConflictCheckDuringSave

void enableConflictCheckDuringSave()

Registers a default FormContextSaveHandlerI that doesn't ignore conflicts during saving. Activate ins forms with

[Tabbed]View conflictPolicy="ASK"

disableConflictCheckDuringSave

void disableConflictCheckDuringSave()

Don't ignore conflicts during saving anymore if previously enabled. Throws exception if the current savehandler is not the expected one.

refreshView

void refreshView()

Only refreshes the window titles and other 'outside' stuff, not the form itself or parts of it. Basically only part of the API because of internal reasons (the MDIManager needs access).

refreshForms

void refreshForms()

Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.

refreshForms

void refreshForms(int from)

Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.

Parameters:

from - An integer representing the source of the refreshForms request. May be one of FormElementI.REFRESH_FROM_USER or FormElementI.REFRESH_FROM_TRANSACTION. Defaults to FormElementI.REFRESH_FROM_USER.

refreshForms

void refreshForms(int from,
                  long onlyBOId,
                  long ifNotSince)

Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI.

Parameters:

from - An integer representing the source of the refreshForms request. May be one of FormElementI.REFRESH_FROM_USER or FormElementI.REFRESH_FROM_TRANSACTION. Defaults to FormElementI.REFRESH_FROM_USER.

onlyBOId - A long. If specified and positive, the refresh will only be done for the Business Object (BO) having the given Id. Defaults to 0, meaning no specific BO ID filter.

ifNotSince - A long specifying a point in time (in milliseconds since epoch). A refresh will only be performed if the internally stored last refresh time is earlier (smaller) than this given time. Defaults to System.currentTimeMillis().

refreshFormsFromInitialViewRefresh

void refreshFormsFromInitialViewRefresh()

Refreshes the form-parts that belong to this FormContextI and all subforms that belong to any subcontext of this FormContextI in the context of an initial view refresh.

tryFocus

boolean tryFocus()

Attempts to set the keyboard focus to an appropriate component within this form context.

The specific component that receives focus (if any) and the criteria for success are determined by the implementation. This method might recursively delegate the focus attempt to sub-contexts.

Returns:

true if focus was successfully requested by a component within this context, false otherwise.

close

void close()

isClosed

boolean isClosed()

addFormContextListener

void addFormContextListener(FormContextListenerI l)

removeFormContextListener

void removeFormContextListener(FormContextListenerI l)

removeAllFormContextListeners

void removeAllFormContextListeners()

getEventProvider

DBManEventProviderI getEventProvider()

getBeforeUserChangesSavepoint

Transaction.Savepoint getBeforeUserChangesSavepoint()

setBeforeUserChangesSavepoint

void setBeforeUserChangesSavepoint(Transaction.Savepoint _sp)

refreshBO

void refreshBO(FormContextI _realFtx,
               java.lang.String _propertyname,
               boolean _transactionControl,
               boolean _autoCreate,
               electric.xml.Element _confRoot)

toastError

void toastError(java.lang.String text,
                int delay)

toastError

void toastError(java.lang.String text)

toast

void toast(java.lang.String text,
           int delay)

toast

void toast(java.lang.String text)