com.ontimize.gui.field
Class CalendarDataField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.ontimize.gui.field.AbstractFormComponent
                  com.ontimize.gui.field.IdentifiedAbstractFormComponent
                      com.ontimize.gui.field.CalendarDataField

All Implemented Interfaces:

AccessForm, CalendarListener, DataComponent, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, java.io.Serializable, ValueChangeDataComponent

public class CalendarDataField

extends IdentifiedAbstractFormComponent

implements ValueChangeDataComponent, CalendarListener

This class implements a field with a calendar component. This calendar will be sensible to listeners and value changes.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.util.Calendar	calendar The reference to calendar.
protected VisualCalendarComponent	calendarComp
protected boolean	fireValueEvents The condition of value events activation.
protected java.lang.Object	innerStoredValue The inner stored value reference.
protected boolean	modifiable The possibility to modify the field.
protected boolean	required The required condition to field.
protected java.lang.Object	storeValue The stored value when setValue is called.

Fields inherited from class com.ontimize.gui.field.IdentifiedAbstractFormComponent

attribute, enabledPermission, parentForm, restricted, visiblePermission

Fields inherited from class com.ontimize.gui.field.AbstractFormComponent

defaultBottomMargin, defaultLeftMargin, defaultRightMargin, defaultTopMargin

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.field.DataComponent

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.field.FormComponent

DEBUG

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

CalendarDataField(java.util.Hashtable parameters)
The class constructor.

Method Summary

void	addMenuMouseListener(java.awt.event.MouseListener l) Adds a mouse listener for menu.
void	addValueChangeListener(ValueChangeListener l)
void	dateChanged(CalendarEvent e)
void	deleteData() The method to delete data for component.
protected void	fireValueChanged(java.lang.Object newValue, java.lang.Object oldValue, int type) Fires the value changed events for value listeners.
VisualCalendarComponent	getCalendarComponent()
javax.swing.JMenu	getJMenu() Gets a menu for calendar component.
java.lang.String	getLabelComponentText() Returns the label text component.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
java.lang.Object	getValue() Gets the value of a component.
void	init(java.util.Hashtable parameters) Inits parameters and adds the calendar component to container.
boolean	isEmpty() Checks the data existence in component.
boolean	isHidden() Indicates to check the visibility condition for a component.
boolean	isModifiable() Checks the modifiable condition for a component.
boolean	isModified() This method should be return true when data have been modified.
boolean	isRequired() Indicates the required condition for a component.
void	removeMenuMouseListener(java.awt.event.MouseListener l) Removes the menu mouse listener.
void	removeValueChangeListener(ValueChangeListener l)
void	setComponentLocale(java.util.Locale l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setJMenu(javax.swing.JMenu menu) Sets a menu for calendar component.
void	setModifiable(boolean modifiable) Establishes the modifiable condition for a component.
void	setRequired(boolean required) Sets required a component according to condition.
void	setValue(java.lang.Object value) Sets the value for component.

Methods inherited from class com.ontimize.gui.field.IdentifiedAbstractFormComponent

checkEnabledPermission, checkVisiblePermission, getAttribute, getParentForm, initPermissions, isRestricted, setParentForm

Methods inherited from class com.ontimize.gui.field.AbstractFormComponent

getConstraints, getTextsToTranslate, setResourceBundle

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ontimize.gui.field.FormComponent

getConstraints, isEnabled, setVisible

Methods inherited from interface com.ontimize.gui.i18n.Internationalization

getTextsToTranslate, setResourceBundle

Methods inherited from interface com.ontimize.gui.field.IdentifiedElement

getAttribute

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

fireValueEvents

protected boolean fireValueEvents

The condition of value events activation. By default, true.

calendarComp

protected VisualCalendarComponent calendarComp

calendar

protected java.util.Calendar calendar

The reference to calendar. By default, null.

modifiable

protected boolean modifiable

The possibility to modify the field. By default, true.

required

protected boolean required

The required condition to field. By default, false.

storeValue

protected java.lang.Object storeValue

The stored value when setValue is called. By default, null.

innerStoredValue

protected java.lang.Object innerStoredValue

The inner stored value reference. By default, null.

Constructor Detail

CalendarDataField

public CalendarDataField(java.util.Hashtable parameters)

The class constructor. Inits parameters.

Parameters:

parameters - the Hashtable with parameters

Method Detail

init

public void init(java.util.Hashtable parameters)

Inits parameters and adds the calendar component to container.

Specified by:

init in interface FormComponent

Overrides:

init in class IdentifiedAbstractFormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	The attribute to manage the field.

setJMenu

public void setJMenu(javax.swing.JMenu menu)

Sets a menu for calendar component.

Parameters:

menu - the reference to menu

See Also:

VisualCalendarComponent.setJMenu(JMenu)

getJMenu

public javax.swing.JMenu getJMenu()

Gets a menu for calendar component.

Returns:

the reference to menu

See Also:

VisualCalendarComponent.getJMenu()

addMenuMouseListener

public void addMenuMouseListener(java.awt.event.MouseListener l)

Adds a mouse listener for menu.

Parameters:

l - the mouse listener reference to add

removeMenuMouseListener

public void removeMenuMouseListener(java.awt.event.MouseListener l)

Removes the menu mouse listener.

Parameters:

l - the mouse listener reference to remove

getLabelComponentText

public java.lang.String getLabelComponentText()

Description copied from interface: DataComponent

Returns the label text component. This label will change according to the Locale.

Specified by:

getLabelComponentText in interface DataComponent

Returns:

the label text

getCalendarComponent

public VisualCalendarComponent getCalendarComponent()

getValue

public java.lang.Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Returns:

the object with value.

setValue

public void setValue(java.lang.Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Parameters:

value - the object with value to set

deleteData

public void deleteData()

Description copied from interface: DataComponent

The method to delete data for component.

Specified by:

deleteData in interface DataComponent

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Returns:

true when component is empty

isModifiable

public boolean isModifiable()

Description copied from interface: DataComponent

Checks the modifiable condition for a component. It is useful when it is not desired form deletes a component value.

Specified by:

isModifiable in interface DataComponent

Returns:

true when component is modifiable

setModifiable

public void setModifiable(boolean modifiable)

Description copied from interface: DataComponent

Establishes the modifiable condition for a component. When component is not modifiable, data will not be deleted automatically in DeleteFields call.

Specified by:

setModifiable in interface DataComponent

Parameters:

modifiable - the boolean condition

isHidden

public boolean isHidden()

Description copied from interface: DataComponent

Indicates to check the visibility condition for a component.

Specified by:

isHidden in interface DataComponent

Returns:

the visibility condition

getSQLDataType

public int getSQLDataType()

Description copied from interface: DataComponent

Returns the sql data type according to java.sql.Types

Specified by:

getSQLDataType in interface DataComponent

Returns:

the Integer type

isRequired

public boolean isRequired()

Description copied from interface: DataComponent

Indicates the required condition for a component.

Specified by:

isRequired in interface DataComponent

Returns:

the required condition

isModified

public boolean isModified()

Description copied from interface: DataComponent

This method should be return true when data have been modified. The method setValue() should be change this condition.

Specified by:

isModified in interface DataComponent

Returns:

the modified condition

setRequired

public void setRequired(boolean required)

Description copied from interface: DataComponent

Sets required a component according to condition.

Specified by:

setRequired in interface DataComponent

Parameters:

required - the required condition

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FormComponent

Description method to set enabled or not the component according the boolean condition in parameter.

Specified by:

setEnabled in interface FormComponent

addValueChangeListener

public void addValueChangeListener(ValueChangeListener l)

Specified by:

addValueChangeListener in interface ValueChangeDataComponent

removeValueChangeListener

public void removeValueChangeListener(ValueChangeListener l)

Specified by:

removeValueChangeListener in interface ValueChangeDataComponent

fireValueChanged

protected void fireValueChanged(java.lang.Object newValue,
                                java.lang.Object oldValue,
                                int type)

Fires the value changed events for value listeners.

Parameters:

newValue - the new value

oldValue - the previous value

type - the type of event

dateChanged

public void dateChanged(CalendarEvent e)

Specified by:

dateChanged in interface CalendarListener

setComponentLocale

public void setComponentLocale(java.util.Locale l)

Specified by:

setComponentLocale in interface Internationalization

Overrides:

setComponentLocale in class AbstractFormComponent