Package net.simplace.pipe.formcomponents.date

Class FWMonthSubComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.simplace.pipe.formcomponents.FWAbstractFormSubComponent

net.simplace.pipe.formcomponents.date.FWMonthSubComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener

public class FWMonthSubComponent
extends FWAbstractFormSubComponent
implements ChangeListener

An FWMonthSubComponent displays a spinner with a list of months that the user can choose from.

Its constructor takes the numbers of the first month and the last month that should be displayed and optionally the number of the month that should be preselected. The months that are displayed in the list can be changed at runtime using the updateMonthsInList function.

Whenever the user selects a month, a stateChanged event is fired. At any time, it is possible to query the currently selected month using getValue or to set the currently selected month using setValue.

Months are numbered from 1 to 12!

International month names will be obtained from the locale.

Author:

ckunze

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 inherited from class net.simplace.pipe.formcomponents.FWAbstractFormSubComponent

iFormComponentParameterMap, iIsEnabled, 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
FWMonthSubComponent(int aMin, int aMax, int aDefault, boolean aIsEnabled, FWObservable aObservable, Map<String,Object> aFormComponentParameterMap)
FWMonthSubComponent(int aMin, int aMax, FWObservable aObservable, Map<String,Object> aFormComponentParameterMap)	Constructs a FWMonthSubComponent offering the months from aMin to aMax to choose from.

Method Summary

Modifier and Type	Method	Description
List<Object>	getSelectedValueList()
String	getValue()
void	setEnabled(boolean aIsEnabled)
void	setValue(String aValue)	Selects the combo box item that corresponds to the given month or the first item if the given month does not exist in the list.
void	stateChanged(ChangeEvent e)
void	updateMonthsInList(int aMin, int aMax)	Rebuilds the combo's list so it contains months from aMin to aMax.

Methods inherited from class net.simplace.pipe.formcomponents.FWAbstractFormSubComponent

addChangeListener, fireStateChanged, getChangeListeners, getLocaleValue, isEnabled, removeChangeListener

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

Constructor Details

FWMonthSubComponent

public FWMonthSubComponent(int aMin,
 int aMax,
 FWObservable aObservable,
 Map<String,Object> aFormComponentParameterMap)

Constructs a FWMonthSubComponent offering the months from aMin to aMax to choose from. The first month in the list will be selected by default. Months are numbered from 1 to 12.

Parameters:

aMin -

aMax -

aObservable -

aFormComponentParameterMap -

FWMonthSubComponent

public FWMonthSubComponent(int aMin,
 int aMax,
 int aDefault,
 boolean aIsEnabled,
 FWObservable aObservable,
 Map<String,Object> aFormComponentParameterMap)

Parameters:

aMin - Number (1-12) of the first month in the list.

aMax - Number (1-12) of the last month in the list.

aDefault - Number (1-12) of the month that will be selected initially.

aIsEnabled -

aObservable -

aFormComponentParameterMap -

Method Details

getValue

public String getValue()

Specified by:

getValue in class FWAbstractFormSubComponent

Returns:

the currently seected month (0-11)

setValue

public void setValue(String aValue)

Selects the combo box item that corresponds to the given month or the first item if the given month does not exist in the list.

Specified by:

setValue in class FWAbstractFormSubComponent

Parameters:

aValue - The month to be selected (1-12)

updateMonthsInList

public void updateMonthsInList(int aMin,
 int aMax)

Rebuilds the combo's list so it contains months from aMin to aMax. After that, the same month as before is selected. If the previously selected month is no longer in the list, the first or last month from the list will be selected.

Parameters:

aMin - First selectable month (1-12)

aMax - Last selectable month (1-12)

setEnabled

public void setEnabled(boolean aIsEnabled)

Overrides:

setEnabled in class FWAbstractFormSubComponent

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

getSelectedValueList

public List<Object> getSelectedValueList()

Specified by:

getSelectedValueList in class FWAbstractFormSubComponent

Returns:

value of the implemented subcomponent