de.ipcon.form

Class FInputPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.ipcon.swing.IPanel

de.ipcon.form.FPanel

de.ipcon.form.FInputPanel

All Implemented Interfaces:

FormElementI, FormInputPanelMandatoryI, de.ipcon.swing.FocusVetoHandlerI, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

Direct Known Subclasses:

FBooleanInputComponent, FComboBox, FPopup, FStyledText, FTextInputComponent, FTimespanChooser

public abstract class FInputPanel
extends FPanel
implements FormInputPanelMandatoryI

Abstract base class for form input components.

This class provides a foundation for creating form elements that handle user input. It extends "FPanel" and implements "FormInputPanelMandatoryI" to support mandatory field validation.

Additional Features:

• Conditional Mandatory Logic: Use the "" tag to define custom conditions for when the input field should be mandatory. This allows for dynamic mandatory behavior based on user input or other factors.
• Caching: By default, the result of the "alsoMandatoryIf" condition is cached to optimize performance. To disable caching for dynamic conditions, use the cached="false" attribute within the "" tag.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.LinkedHashMap	myActions
static java.util.HashMap	myAttributes
static java.util.HashMap	myElements

Fields inherited from class de.ipcon.form.FPanel

XMLConfigureInfo

Fields inherited from class de.ipcon.swing.IPanel

inhibitFocusChange, SCROLLING_MODE_ANY, SCROLLING_MODE_HORIZONTAL_ONLY, SCROLLING_MODE_VERTICAL_ONLY, TEXTURE_CENTERED, TEXTURE_REPEAT

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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_TRANSACTION, REFRESH_FROM_USER, SHORTCUT_ACTION_KIND, TOOLBAR_ACTION_KIND, TOPMDI_ONLY_ACTION_KIND

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
FInputPanel(FormContextI ftx, electric.xml.Element confRoot) Constructs a new "FInputPanel" with the given form context and configuration root element.

Method Summary

Modifier and Type	Method and Description
boolean	calculateMandatory(BOI bo, AttributeI attr) Determines if the attribute is mandatory within the given context.
boolean	getAlsoMandatoryIf() Evaluates the "alsoMandatoryIf" condition and determines if the panel should be marked as mandatory.
java.util.HashMap	getAttributeMap() Returns the map of attributes supported by this component.
int	getBaseline(int width, int height) Returns the baseline of the component.
java.util.LinkedHashMap	getDefaultActionMap() Returns the default action map for this component.
java.util.HashMap	getElementMap() Returns the map of elements supported by this component.
abstract javax.swing.JComponent	getJComponent() Returns the "JComponent" associated with this form element.
void	handleAlsoMandatoryIfE(electric.xml.Element e) Handles the "alsoMandatoryIf" script element.

Methods inherited from class de.ipcon.form.FPanel

_refreshActions, action_editForm_available, action_editForm_enabled, action_editForm, action_refreshView_available, action_refreshView, action_reopenView_available, action_reopenView_enabled, action_reopenView, addBeanA, addFormElementListener, addHandleA, addHandleE, afterSave, afterSetValue, assureTransferHandler, beforeSave, beforeSetValue, calculationMightBeExpensive, callLog, cancelPendingRefreshRequests, checkEditable, checkVisible, close, evalScript, evalScript, evalScript, evalScript, evalScript, fhide, focusNextComponent, focusPreviousComponent, fshow, getActions, getActionsOfKind, getActionsOfKind, getBO, getConfRoot, getCtx, getDebugName, getFormActions, getFtx, getInstrumentedSchema, getLastRefreshRequest, getMaximumSize, getMinimumSize, getMissingPropertiesPolicy, getPreferredSize, getRefreshRequestsPending, getSchema, handleActionE, handleAttributes, handleDropAllowedIfE, handleEditableA, handleEditableIfE, handleElement, handleElements, handleElements, handleElements, handleImpliedA, handleMaximumSizeA, handleMaxSizeA, handleMinimumSizeA, handleMinSizeA, handleMissingPropertiesPolicyA, handleNameA, handleNewElement, handleNewElement, handleNewElement, handleOnAfterSaveE, handleOnAfterSetValueE, handleOnBeforeSaveE, handleOnBeforeSetValueE, handleOnConstructionE, handleOnDropE, handleOnFocusGainedE, handleOnFocusLostE, handleOnMDIActivateE, handleOnMDICloseE, handleOnMDIDeactivateE, handleOnMDIOpenE, handleOnRefreshE, handleOnSyncE, handlePreferredSizeA, handlePrefSizeA, handleScriptE, handleVirtualPropertyE, handleVisibleIfE, hasPreferredSizeOverride, invokeAction, invokeAction, isClosed, isDebug, isDefinedEditable, isEditable, isExplicitEditable, isGUIBuilt, isImpliedElement, isInputPossible, isShown, mdiActivate, mdiClose, mdiDeactivate, mdiOpen, postConstructor, postInit, postRefresh, postRefresh, postRefresh, processFocusVeto, processFocusVeto, queueDelayedRefresh, queueDelayedRefresh, reallyHandleVirtualPropertyE, refresh, refresh, refreshActions, refreshActions, registerActionImpl, registerFormAction, removeFormElementListener, requestFocus, requestFocusInWindow, requestFocusInWindow, runAndDeclare, runAndDeclare, setConfRoot, setDebug, setEditable, setFtx, setGUIBuilt, setMissingPropertiesPolicy, setShown, shouldShow, sync, syncImpl, waitForAsyncRefreshes, willCareForChildActions, willCareForChildRefresh

Methods inherited from class de.ipcon.swing.IPanel

getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollingMode, grabFocus, init, init, init, paintComponent, setScrollingMode, setTexture

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.form.FormElementI

getName, toDebugName

Field Detail

myAttributes

public static java.util.HashMap myAttributes

myElements

public static java.util.HashMap myElements

myActions

public static java.util.LinkedHashMap myActions

Constructor Detail

FInputPanel

public FInputPanel(FormContextI ftx,
                   electric.xml.Element confRoot)

Constructs a new "FInputPanel" with the given form context and configuration root element.

This constructor initializes the input panel by setting up the necessary configuration for parsing and handling elements and attributes. It also initializes the action map for handling user interactions.

The constructor performs the following actions:

• Creates a copy of the attribute map from the superclass.
• Creates a copy of the element map from the superclass.
• Adds a handler for the "alsoMandatoryIf" element.
• Creates a copy of the default action map from the superclass.

Parameters:

ftx - The form context associated with this panel.

confRoot - The root element of the panel's configuration.

Method Detail

getAttributeMap

public java.util.HashMap getAttributeMap()

Returns the map of attributes supported by this component.

Specified by:

getAttributeMap in interface FormElementI

Overrides:

getAttributeMap in class FPanel

Returns:

The attribute map.

getElementMap

public java.util.HashMap getElementMap()

Returns the map of elements supported by this component.

Specified by:

getElementMap in interface FormElementI

Overrides:

getElementMap in class FPanel

Returns:

The element map.

getDefaultActionMap

public java.util.LinkedHashMap getDefaultActionMap()

Returns the default action map for this component.

Overrides:

getDefaultActionMap in class FPanel

Returns:

The default action map.

handleAlsoMandatoryIfE

public void handleAlsoMandatoryIfE(electric.xml.Element e)

Handles the "alsoMandatoryIf" script element.

This method processes the "alsoMandatoryIf" element in the form definition, which allows for defining a custom condition to determine if the panel should be marked as mandatory. The script or expression within this element is evaluated to determine the mandatory status.

The "cached" attribute of the "alsoMandatoryIf" element can be used to specify whether the result of the script evaluation should be cached. By default, the result is cached to optimize performance.

If multiple "alsoMandatoryIf" elements are encountered, a "FormElementDefinitionException" is thrown to indicate an invalid form definition.

Example:

 
 <alsoMandatoryIf language="groovy">ctx.currentUser.istMitgliedVon("Pflichtgruppe")</alsoMandatoryIf>
 
 

Parameters:

e - The XML element representing the "alsoMandatoryIf" node.

Throws:

FormElementDefinitionException - If multiple "alsoMandatoryIf" elements are found.

getAlsoMandatoryIf

public boolean getAlsoMandatoryIf()

Evaluates the "alsoMandatoryIf" condition and determines if the panel should be marked as mandatory.

This method evaluates the "alsoMandatoryIf" script or expression associated with the form input panel. If the condition evaluates to true, the panel is considered mandatory, regardless of the mandatory status defined in the schema or through other means (e.g., "isMandatory").

If the "alsoMandatoryIf" condition is not defined or evaluates to false, the mandatory status of the panel is determined by the schema definition or other relevant factors.

The result of the evaluation can be cached to optimize performance, especially if the condition is complex or involves expensive calculations.

Returns:

true if the "alsoMandatoryIf" condition is met and the panel should be marked as mandatory, false otherwise.

getJComponent

public abstract javax.swing.JComponent getJComponent()

Returns the "JComponent" associated with this form element.

Returns:

The "JComponent" of this form element.

getBaseline

public int getBaseline(int width,
                       int height)

Returns the baseline of the component.

Overrides:

getBaseline in class javax.swing.JComponent

Parameters:

width - The width to get the baseline for.

height - The height to get the baseline for.

Returns:

The baseline of the component, or < 0 indicating there is no underlying JComponent or no reasonable baseline.

calculateMandatory

public boolean calculateMandatory(BOI bo,
                                  AttributeI attr)

Determines if the attribute is mandatory within the given context.

This method checks whether the specified attribute is mandatory for the provided "BOI" in the current form input panel. It considers various factors, such as the attribute's definition, the state of the BO, the editability of the panel, and whether a value has already been provided for the attribute.

The method returns true if the attribute is mandatory and no value is currently assigned, indicating that the user must provide a value. It returns false if the attribute is not mandatory, the BO is deleted, the panel is not editable, or a value has already been assigned.

Specified by:

calculateMandatory in interface FormInputPanelMandatoryI

Parameters:

bo - The BOI for which to check the attribute's mandatory status.

attr - The attribute to check.

Returns:

true if the attribute is mandatory and no value is assigned, false otherwise.

See Also:

AttributeI.isMandatory(BOI), getAlsoMandatoryIf()