Package net.simplace.pipe.formcomponents

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, FWTableChoiceSubComponent, FWYearSubComponent

public abstract class FWAbstractFormSubComponent
extends JPanel

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:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	iFormComponentParameterMap
protected boolean	iIsEnabled
protected FWObservable	iObservable

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
FWAbstractFormSubComponent(boolean aIsEnabled, FWObservable aObservable, Map<String,Object> aFormComponentParameterMap)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ChangeListener aListener)	Allows form components to register change listeners on subcomponents in order to get notified of changes.
protected void	fireStateChanged()	Notifies change listeners of changes to the subcomponent.
ChangeListener[]	getChangeListeners()
protected String	getLocaleValue(String aKey)	This method limits the coding for reading values from the locale.
abstract List<Object>	getSelectedValueList()
abstract String	getValue()
boolean	isEnabled()
void	removeChangeListener(ChangeListener aListener)	Allows form components to unregister previously registered change listeners on subcomponents
void	setEnabled(boolean aEnabled)
abstract void	setValue(String aValue)	Allows to set the value of the implemented subcomponent

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.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, update

Methods inherited from class java.awt.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, validateTree

Methods inherited from class java.awt.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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

iObservable

protected FWObservable iObservable

iIsEnabled

protected boolean iIsEnabled

iFormComponentParameterMap

protected Map<String,Object> iFormComponentParameterMap

Constructor Details

FWAbstractFormSubComponent

public FWAbstractFormSubComponent(boolean aIsEnabled,
 FWObservable aObservable,
 Map<String,Object> aFormComponentParameterMap)

Parameters:

aIsEnabled -

aObservable -

aFormComponentParameterMap -

Method Details

getValue

public abstract String getValue()

Returns:

value of the implemented subcomponent

getSelectedValueList

public abstract List<Object> getSelectedValueList()

Returns:

value of the implemented subcomponent

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class Component

setEnabled

public void setEnabled(boolean aEnabled)

Overrides:

setEnabled in class JComponent

setValue

public abstract void setValue(String aValue)

Allows to set the value of the implemented subcomponent

Parameters:

aValue - String representation of the value to be set

addChangeListener

public void addChangeListener(ChangeListener aListener)

Allows form components to register change listeners on subcomponents in order to get notified of changes. Implementations of subcomponents MUST call fireStateChanged() whenever their value changes, so that change listeners get notified.

Parameters:

aListener - Change Listener to be registered

removeChangeListener

public void removeChangeListener(ChangeListener aListener)

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 method MUST get called, whenever the value of the subcomponent changes. However, calling it is up to the specific implementation of this abstract class.

getChangeListeners

public ChangeListener[] getChangeListeners()

Returns:

An array of all the change listeners that are currently registered on this component

getLocaleValue

protected String getLocaleValue(String aKey)

This method limits the coding for reading values from the locale.

Parameters:

aKey -

Returns: