Class FWAbstractFormSubComponent
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.simplace.pipe.formcomponents.FWAbstractFormSubComponent
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
- Direct Known Subclasses:
FWCheckboxChoiceSubComponent, FWDaySubComponent, FWLabelChoiceSubComponent, FWMonthSubComponent, FWSingleCheckboxChoiceSubComponent, FWYearSubComponent
Abstract class that is supposed to be overwritten by subcomponent implementations.
Subcomponents may be used to assemble compound form components (see
FWDateFormComponent)
or to create form components that have a different appearance, depending on input parameters
(see FWChoiceFormComponent). Subcomponents cannot be directly used in forms but can only
be contained in a form component that inherits from FWAbstractFormComponent.
Form components may register change listeners on subcomponents to get notified of changes. This may
be useful to keep several subcomponents synchronized and to keep the form component's value up-to-date.
However, it is up to the implementation of the subcomponent to notify listeners by calling
fireStateChanged() whenever its value changes!- Author:
- Christoph Kunze
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionparameters of the containing form componentprotected booleanenabled state (the Swing enabled state is not used)protected net.simplace.core.FWObservableparameters of the functionalityFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionFWAbstractFormSubComponent(boolean aIsEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddChangeListener(ChangeListener aListener) Allows form components to register change listeners on subcomponents in order to get notified of changes.protected StringcreateSqlOrCondition(String aColumn, List<?> aValues) Creates the SQL condition of the parametersql_where_paramfor the selected values:column='value1' OR column='value2'(format as before).protected voidNotifies change listeners of changes to the subcomponent.protected StringgetLocaleValue(String aKey) Reads a localised text<locale prefix>.FormComponent.<key>fromLocaleBundle.abstract StringgetValue()booleanvoidremoveChangeListener(ChangeListener aListener) Allows form components to unregister previously registered change listeners on subcomponentsvoidsetEnabled(boolean aEnabled) abstract voidAllows to set the value of the implemented subcomponentMethods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateMethods inherited from class Container
add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTreeMethods inherited from class Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
iObservable
protected net.simplace.core.FWObservable iObservableparameters of the functionality -
iIsEnabled
protected boolean iIsEnabledenabled state (the Swing enabled state is not used) -
iFormComponentParameterMap
-
-
Constructor Details
-
FWAbstractFormSubComponent
public FWAbstractFormSubComponent(boolean aIsEnabled, net.simplace.core.FWObservable aObservable, Map<String, Object> aFormComponentParameterMap) - Parameters:
aIsEnabled-trueif the subcomponent is enabledaObservable- parameters of the functionalityaFormComponentParameterMap- parameters of the containing form component
-
-
Method Details
-
getValue
- Returns:
- value of the implemented subcomponent
-
getSelectedValueList
-
isEnabled
-
setEnabled
public void setEnabled(boolean aEnabled) - Overrides:
setEnabledin classJComponent
-
setValue
Allows to set the value of the implemented subcomponent- Parameters:
aValue- String representation of the value to be set
-
addChangeListener
Allows form components to register change listeners on subcomponents in order to get notified of changes. Implementations of subcomponentsMUST call fireStateChanged() whenever their value changes, so that change listeners get notified.- Parameters:
aListener- Change Listener to be registered
-
removeChangeListener
Allows form components to unregister previously registered change listeners on subcomponents- Parameters:
aListener- The previpusly registered change listener
-
fireStateChanged
protected void fireStateChanged()Notifies change listeners of changes to the subcomponent. This methodMUST get called, whenever the value of the subcomponent changes. However, calling it is up to the specific implementation of this abstract class. -
getChangeListeners
- Returns:
- An array of all the change listeners that are currently registered on this component
-
getLocaleValue
-
createSqlOrCondition
Creates the SQL condition of the parametersql_where_paramfor the selected values:column='value1' OR column='value2'(format as before). Security: the values are escaped as SQL string literals (a quote is doubled), and the column name must be a plain SQL identifier; before, both were concatenated unchecked into the SQL (SQL injection via option values).- Parameters:
aColumn- the column name (parametersql_where_param)aValues- the selected values;nullvalues are compared as empty string- Returns:
- the condition, or an empty string if the column name is no valid identifier (error is logged)
-