com.isti.util.gui
Class TimeJTextField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextField
                      com.isti.util.gui.TimeJTextField

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

public class TimeJTextField
extends javax.swing.JTextField

Class TimeJTextField is an extension of 'JTextField' which only allows time characters to be entered into it.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

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

Field Summary

protected static int[]	CALENDAR_TIME_FIELDS
protected static boolean	debugFlag
protected static java.lang.String	EMPTY_TIME_TEXT
protected static java.lang.String	FIELD_SEPARATOR
static int	HOURS Entry for hours only.
static int	HOURS_MINS Entry for hours and minutes.
static int	HOURS_MINS_SECS Entry for hours, minutes and seconds (default.)
protected int	MAX_CALENDAR_TIME_FIELD
protected static java.lang.String	MS_FIELD_SEPARATOR
static boolean	SHOW_ZERO_TEXT_FLAG_DEFAULT Default value for the show zero text flag.
protected static java.lang.String	TIME_PATTERN
java.text.SimpleDateFormat	timeFormatterObj

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

TimeJTextField()
Creates a new 'TimeJTextField' object.

TimeJTextField(int maxNumChars)
Creates a new 'TimeJTextField' object.

TimeJTextField(int maxNumChars, boolean showZeroTextFlag)
Creates a new 'TimeJTextField' object.

TimeJTextField(int maxNumChars, boolean showZeroTextFlag, java.util.Calendar calObj)
Creates a new 'TimeJTextField' object.

Method Summary

java.util.Calendar	getCalendar() Gets the calendar for this panel.
protected java.lang.String	getCleanText() Gets a cleaned up version of the text where spaces are replaced with zeros.
protected static java.lang.String	getCleanText(java.lang.String text) Gets a cleaned up version of the text where spaces are replaced with zeros.
int	getMaxNumChars() Gets the maximum number of characters.
java.util.Date	getMaxTime() Gets the maximum time.
java.util.Date	getMinTime() Gets the minimum time.
java.util.Date	getTime() Get the date that is specified in this object.
java.util.TimeZone	getTimeZone() Gets the time zone.
static java.util.Date	getValidDate(java.util.Date date) Gets the date with the milliseconds cleared.
static java.util.Date	getValidDate(java.util.Date date, boolean ceilFlag) Gets the date with the milliseconds cleared.
boolean	isShowZeroText() Gets the show zero text flag.
boolean	setMaxTime(java.util.Date date) Sets the maximum time.
boolean	setMinTime(java.util.Date date) Sets the minimum time.
boolean	setTime(java.util.Date date) Sets the time.
void	setTimeZone(java.util.TimeZone value) Sets the time zone with the given time zone value.
java.lang.String	toString() Returns a string representation of this component and its values.
protected void	updateTime() Updates the date that is specified in this object.

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

HOURS

public static final int HOURS

Entry for hours only.

See Also:

Constant Field Values

HOURS_MINS

public static final int HOURS_MINS

Entry for hours and minutes.

See Also:

Constant Field Values

HOURS_MINS_SECS

public static final int HOURS_MINS_SECS

Entry for hours, minutes and seconds (default.)

See Also:

Constant Field Values

SHOW_ZERO_TEXT_FLAG_DEFAULT

public static final boolean SHOW_ZERO_TEXT_FLAG_DEFAULT

Default value for the show zero text flag.

See Also:

Constant Field Values

FIELD_SEPARATOR

protected static final java.lang.String FIELD_SEPARATOR

See Also:

Constant Field Values

MS_FIELD_SEPARATOR

protected static final java.lang.String MS_FIELD_SEPARATOR

See Also:

Constant Field Values

TIME_PATTERN

protected static final java.lang.String TIME_PATTERN

See Also:

Constant Field Values

EMPTY_TIME_TEXT

protected static final java.lang.String EMPTY_TIME_TEXT

See Also:

Constant Field Values

CALENDAR_TIME_FIELDS

protected static final int[] CALENDAR_TIME_FIELDS

MAX_CALENDAR_TIME_FIELD

protected final int MAX_CALENDAR_TIME_FIELD

timeFormatterObj

public final java.text.SimpleDateFormat timeFormatterObj

debugFlag

protected static boolean debugFlag

Constructor Detail

TimeJTextField

public TimeJTextField()

Creates a new 'TimeJTextField' object. The default is entry for hours, minutes, and seconds ("HH:mm:ss".)

TimeJTextField

public TimeJTextField(int maxNumChars)

Creates a new 'TimeJTextField' object.

Parameters:

maxNumChars - the maximum number of characters. This value should be HOURS for hours only ("HH"), HOURS_MINS for hours and minutes ("HH:mm"), or HOURS_MINS_SECS for hours, minutes, and seconds ("HH:mm:ss").

TimeJTextField

public TimeJTextField(int maxNumChars,
                      boolean showZeroTextFlag)

Creates a new 'TimeJTextField' object.

Parameters:

maxNumChars - the maximum number of characters. This value should be HOURS for hours only ("HH"), HOURS_MINS for hours and minutes ("HH:mm"), or HOURS_MINS_SECS for hours, minutes, and seconds ("HH:mm:ss").

showZeroTextFlag - the show zero test flag, if true spaces in the text are replaced with zeros.

TimeJTextField

public TimeJTextField(int maxNumChars,
                      boolean showZeroTextFlag,
                      java.util.Calendar calObj)

Creates a new 'TimeJTextField' object.

Parameters:

maxNumChars - the maximum number of characters. This value should be HOURS for hours only ("HH"), HOURS_MINS for hours and minutes ("HH:mm"), or HOURS_MINS_SECS for hours, minutes, and seconds ("HH:mm:ss").

showZeroTextFlag - the show zero test flag, if true spaces in the text are replaced with zeros.

calObj - calendar object or null to create a new one.

Method Detail

getMaxNumChars

public int getMaxNumChars()

Gets the maximum number of characters.

Returns:

HOURS for hours only ("HH"), HOURS_MINS for hours and minutes ("HH:mm"), or HOURS_MINS_SECS for hours, minutes, and seconds ("HH:mm:ss").

isShowZeroText

public boolean isShowZeroText()

Gets the show zero text flag.

Returns:

the show zero text flag, if true spaces in the text are replaced with zeros.

getMaxTime

public java.util.Date getMaxTime()

Gets the maximum time.

Returns:

the maximum time.

getMinTime

public java.util.Date getMinTime()

Gets the minimum time.

Returns:

the minimum time.

getTime

public java.util.Date getTime()

Get the date that is specified in this object.

Returns:

the date or null if none entered.

getTimeZone

public java.util.TimeZone getTimeZone()

Gets the time zone.

Returns:

the time zone object associated with this panel.

getCalendar

public java.util.Calendar getCalendar()

Gets the calendar for this panel.

Returns:

the calendar for this panel.

getValidDate

public static java.util.Date getValidDate(java.util.Date date)

Gets the date with the milliseconds cleared.

Parameters:

date - the Date.

Returns:

the date with the milliseconds cleared.

getValidDate

public static java.util.Date getValidDate(java.util.Date date,
                                          boolean ceilFlag)

Gets the date with the milliseconds cleared.

Parameters:

date - the Date.

ceilFlag - true for the ceiling value (greater than minimum), false for the floor value (less than maximum.)

Returns:

the date with the milliseconds cleared.

setMaxTime

public boolean setMaxTime(java.util.Date date)

Sets the maximum time.

Parameters:

date - the date to set or null to clear.

Returns:

true if the maximum time is valid and was updated.

setMinTime

public boolean setMinTime(java.util.Date date)

Sets the minimum time.

Parameters:

date - the date to set or null to clear.

Returns:

true if the minimum time is valid and was updated.

setTime

public boolean setTime(java.util.Date date)

Sets the time.

Parameters:

date - the date to set or null to clear.

Returns:

true if the time is valid and was updated.

setTimeZone

public void setTimeZone(java.util.TimeZone value)

Sets the time zone with the given time zone value.

Parameters:

value - the given time zone.

toString

public java.lang.String toString()

Returns a string representation of this component and its values.

Overrides:

toString in class java.awt.Component

Returns:

a string representation of this component.

getCleanText

protected java.lang.String getCleanText()

Gets a cleaned up version of the text where spaces are replaced with zeros.

Returns:

a cleaned up version of the text.

getCleanText

protected static java.lang.String getCleanText(java.lang.String text)

Gets a cleaned up version of the text where spaces are replaced with zeros.

Parameters:

text - date text.

Returns:

a cleaned up version of the text.

updateTime

protected void updateTime()

Updates the date that is specified in this object.