org.tentackle.swing

Class FormCalendarField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.tentackle.swing.FormPanel

org.tentackle.swing.FormComponentPanel

org.tentackle.swing.FormFieldComponentPanel

org.tentackle.swing.FormCalendarField

All Implemented Interfaces:

ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, I18nTranslatable, FormChangeable, FormChangeableComponent, FormComponent, FormContainer, FormFieldComponent, SqlDateField

public class FormCalendarField
extends FormFieldComponentPanel
implements SqlDateField

Author:

harald

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 and Description
static int	SHOW_AUTO show only date (default)

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 org.tentackle.swing.FormFieldComponent

ADJUST_LEFT, ADJUST_NONE, ADJUST_RIGHT, ADJUST_TRIM, CONVERT_LC, CONVERT_NONE, CONVERT_UC

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FormCalendarField() Creates a calendar field.

Method Summary

Modifier and Type	Method and Description
org.tentackle.common.Date	getDate() Gets the org.tentackle.misc.Date.
char	getDefaultUnit() Gets the default unit.
DateFormField	getFormComponent() Gets the embedded form field component.
Date	getFormValue() Retrieves the value from this component. The method is used to update the data model if the view has changed because the user edited it.
Date	getReferenceDate() Gets the reference date.
DateFormField.ReferenceDateProvider	getReferenceDateProvider() Gets the reference date provider.
org.tentackle.common.Time	getTime() Gets the org.tentackle.misc.Time.
int	getTimeMode() Gets the time mode. One of FormCalendar.SHOW_...
org.tentackle.common.Timestamp	getTimestamp() Gets the org.tentackle.misc.Timestamp.
boolean	isLenient() Gets the lenient flag.
void	setCellEditorUsage(boolean flag) Sets a hint that this component is used as a cell editor. Some components behave differently in tables than in forms, for example.
void	setChangeable(boolean changeable) Set the component to be changeable. This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.
void	setDefaultUnit(char defaultUnit) Sets the default unit.
void	setEnabled(boolean enabled)
void	setFormComponent(FormComponent comp) Sets the embedded form field component.
void	setFormValue(Object value) Sets a value in this component. The method is used to update the view if the data has changed.
void	setLenient(boolean lenient) Sets the "lenient" flag in date format.
void	setName(String name)
void	setReferenceDate(Date referenceDate) Sets the reference date.
void	setReferenceDateProvider(DateFormField.ReferenceDateProvider refProvider) Sets the reference date provider.
void	setTimeMode(int timeMode) Sets the time mode. One of FormCalendar.SHOW_....

Methods inherited from class org.tentackle.swing.FormFieldComponentPanel

clearText, doFormat, downRight, getAdjust, getCaretPosition, getColumns, getConvert, getConverter, getDefaultColumns, getErrorMessage, getErrorOffset, getFiller, getFormat, getHorizontalAlignment, getInvalidChars, getMaxColumns, getText, getToolTipText, getValidChars, getVerticalAlignment, isAutoNext, isAutoSelect, isCaretLeft, isCaretRight, isEmpty, isEraseFirst, isInhibitAutoSelect, isOverwrite, isStartEditLeftmost, postActionEvent, setAdjust, setAutoNext, setAutoSelect, setCaretLeft, setCaretPosition, setCaretRight, setColumns, setConvert, setConverter, setDefaultColumns, setEraseFirst, setErrorMessage, setErrorOffset, setFiller, setFormat, setHorizontalAlignment, setInhibitAutoSelect, setInvalidChars, setMaxColumns, setOverwrite, setStartEditLeftmost, setText, setToolTipText, setValidChars, setVerticalAlignment, upLeft

Methods inherited from class org.tentackle.swing.FormComponentPanel

addValueListener, clearValueShownModified, fireValueChanged, fireValueEntered, getBaseline, getBinding, getBindingPath, getComponentPath, getFocusTraversalGroup, getHelpURL, getParentWindow, getPropertyGroup, getValueShown, hasFocus, invalidateParentInfo, isAutoUpdate, isBindable, isCellEditorUsage, isChangeable, isFireRunning, isFormTraversable, isHonourChangeable, isMandatory, isSmartValueEntered, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, removeValueListener, requestFocus, requestFocus, requestFocusInWindow, requestFocusLater, saveValue, setAutoUpdate, setBindable, setBinding, setBindingPath, setComponentPath, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormWrapWindow, setHelpURL, setHonourChangeable, setMandatory, setPropertyGroup, setSmartValueEntered, setTriggerValueChangedEnabled, showErrorPopup, showHelp, triggerValueChanged, updateAllChangeable, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from class org.tentackle.swing.FormPanel

addActionListener, areValuesChanged, componentAdded, componentRemoved, createBinder, fireActionPerformed, getBinder, getFormValues, getI18nTranslation, getTitle, isTriggerValuesChangedEnabled, removeActionListener, saveValues, setFormValues, setFormValuesKeepChanged, setI18nTranslation, setTitle, setTitle, setTriggerValuesChangedEnabled, triggerValuesChanged

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, 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, 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, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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, 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

Methods inherited from interface org.tentackle.swing.FormComponent

addValueListener, clearValueShownModified, fireValueChanged, fireValueEntered, getBaseline, getBinding, getBindingPath, getComponentPath, getFocusTraversalGroup, getHelpURL, getParentWindow, getPropertyGroup, getValueShown, hasFocus, invalidateParentInfo, isAutoUpdate, isBindable, isCellEditorUsage, isFireRunning, isFormTraversable, isMandatory, isSmartValueEntered, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, removeValueListener, requestFocusLater, saveValue, setAutoUpdate, setBindable, setBinding, setBindingPath, setComponentPath, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormWrapWindow, setHelpURL, setMandatory, setPropertyGroup, setSmartValueEntered, setTriggerValueChangedEnabled, showErrorPopup, showHelp, transferFocus, transferFocusBackward, triggerValueChanged, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from interface org.tentackle.swing.FormChangeableComponent

updateAllChangeable

Methods inherited from interface org.tentackle.swing.FormChangeable

isChangeable, isHonourChangeable, setHonourChangeable

Field Detail

SHOW_AUTO

public static final int SHOW_AUTO

show only date (default)

See Also:

Constant Field Values

Constructor Detail

FormCalendarField

public FormCalendarField()

Creates a calendar field.

Method Detail

setFormComponent

public void setFormComponent(FormComponent comp)

Description copied from class: FormComponentPanel

Sets the embedded form field component.

Overrides:

setFormComponent in class FormComponentPanel

Parameters:

comp - the component.

getFormComponent

public DateFormField getFormComponent()

Description copied from class: FormFieldComponentPanel

Gets the embedded form field component.

Overrides:

getFormComponent in class FormFieldComponentPanel

Returns:

the component

setName

public void setName(String name)

Overridden to set the names in subcomponents.

Overrides:

setName in class Component

setTimeMode

public void setTimeMode(int timeMode)

Sets the time mode.
One of FormCalendar.SHOW_....

Parameters:

timeMode - the time mode, -1 if from date format (default)

See Also:

FormCalendar

getTimeMode

public int getTimeMode()

Gets the time mode.
One of FormCalendar.SHOW_...

Returns:

the time mode, -1 if from date format (default)

setLenient

public void setLenient(boolean lenient)

Sets the "lenient" flag in date format.

Parameters:

lenient - true if lenient

isLenient

public boolean isLenient()

Gets the lenient flag.

Returns:

the lenient flag

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

setChangeable

public void setChangeable(boolean changeable)

Description copied from interface: FormChangeable

Set the component to be changeable.
This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.

Specified by:

setChangeable in interface FormChangeable

Overrides:

setChangeable in class FormComponentPanel

Parameters:

changeable - true the user can edit the data, false if show only

setFormValue

public void setFormValue(Object value)

Description copied from interface: FormComponent

Sets a value in this component.
The method is used to update the view if the data has changed.

Specified by:

setFormValue in interface FormComponent

Overrides:

setFormValue in class FormComponentPanel

Parameters:

value - is the object to set

getFormValue

public Date getFormValue()

Description copied from interface: FormComponent

Retrieves the value from this component.
The method is used to update the data model if the view has changed because the user edited it.

Specified by:

getFormValue in interface FormComponent

Overrides:

getFormValue in class FormComponentPanel

Returns:

the object from the form

getDate

public org.tentackle.common.Date getDate()

Gets the org.tentackle.misc.Date.

Specified by:

getDate in interface SqlDateField

Returns:

the SQL date

getTimestamp

public org.tentackle.common.Timestamp getTimestamp()

Gets the org.tentackle.misc.Timestamp.

Specified by:

getTimestamp in interface SqlDateField

Returns:

the SQL timestamp

getTime

public org.tentackle.common.Time getTime()

Gets the org.tentackle.misc.Time.

Specified by:

getTime in interface SqlDateField

Returns:

the SQL time

getReferenceDate

public Date getReferenceDate()

Gets the reference date.

Returns:

the reference date, null = today

setReferenceDate

public void setReferenceDate(Date referenceDate)

Sets the reference date.

Parameters:

referenceDate - the reference date, null = today

getDefaultUnit

public char getDefaultUnit()

Gets the default unit.

Returns:

the default unit, blank if default

setDefaultUnit

public void setDefaultUnit(char defaultUnit)

Sets the default unit.

The default unit applies to number-only input, for example "6" in a time field. By default, the unit is derived from the format and corresponds to the smallest unit. For example, in "HH:mm" the default unit is minute and in "yy/mm/dd" the default unit is day. Input of "6" will by default be translated to "6 minutes (in current hour)", respectively 6th day in current month. If the default unit, however, is explicitly set to "H" (or "y") an input of "6" will result in "06:00" ("06/xx/xx" respectively).

Parameters:

defaultUnit - the default unit (formatting char), blank or 0 if default

getReferenceDateProvider

public DateFormField.ReferenceDateProvider getReferenceDateProvider()

Gets the reference date provider.

Returns:

the provider, null if none

setReferenceDateProvider

public void setReferenceDateProvider(DateFormField.ReferenceDateProvider refProvider)

Sets the reference date provider.

The provider is consulted whenever the input starts with a '@'. It will be used to retrieve the reference date. For example: "@+7" to add 7 days to a specific date from the model.

Parameters:

refProvider - the provider, null to clear

setCellEditorUsage

public void setCellEditorUsage(boolean flag)

Description copied from interface: FormComponent

Sets a hint that this component is used as a cell editor.
Some components behave differently in tables than in forms, for example.

Specified by:

setCellEditorUsage in interface FormComponent

Overrides:

setCellEditorUsage in class FormComponentPanel

Parameters:

flag - true if component is a cell editor, false if not.