oracle.javatools.ui.calendar

Class CalendarPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.javatools.ui.calendar.CalendarPanel

All Implemented Interfaces:

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

public final class CalendarPanel
extends javax.swing.JPanel

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

Fields

Modifier and Type	Field and Description
static java.lang.String	DOUBLE_CLICK_COMMAND The command for the action fired when the user double clicks on the calendar grid
static java.lang.String	SELECTION_CHANGED_COMMAND The command for the action fired when the selection of dates in the calendar changes

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 and Description
CalendarPanel()
CalendarPanel(java.util.Locale locale) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener listener)
void	addSelectedDates(java.util.Date[] dates) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
CalendarDateProvider	getDateProvider() Deprecated. use CalendarModel and the java.time API instead of java.util.Date
java.util.Set<java.time.ZonedDateTime>	getDates()
java.util.Date	getMaximumDate() Deprecated. use CalendarModel and the java.time API instead of java.util.Date
java.util.Date	getMinimumDate() Deprecated. use CalendarModel and the java.time API instead of java.util.Date
CalendarModel	getModel() Get the model used by this calendar.
java.util.TimeZone	getNearestTimeZone(java.util.TimeZone timeZone) Deprecated. the calendar now shows all time zones, so this method will always return the passed in time zone.
java.util.Date[]	getSelectedDates() Deprecated. new Java time api in JDK8 has better classes than java.util.Date for this sort of thing. Use getDates() instead.
boolean	getShowTimeZone()
java.util.TimeZone	getTimeZone() Deprecated. use CalendarModel and the java.time API instead of java.util.Date
java.util.TimeZone	getTimeZoneInList(java.util.TimeZone timeZone) Deprecated. the calendar now shows all time zones, so this method will always return the passed in time zone.
java.util.Date	getVisibleDate() Deprecated. use the java.time API instead of java.util.Date
void	goToToday() Change the date shown on the calendar to be 'Today'.
boolean	isEditingTime()
boolean	isMultiSelect()
boolean	isShowingTime()
boolean	isShowingToday()
void	makeDateVisible(java.util.Date date) Deprecated. use the java.time API instead of java.util.Date
void	removeActionListener(java.awt.event.ActionListener listener)
void	removeSelectedDates(java.util.Date[] dates) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setDateProvider(CalendarDateProvider calDateProvider) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setEditTime(boolean editTime)
void	setLocale(java.util.Locale l)
void	setMaximumDate(java.util.Date maximumDate) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setMinimumDate(java.util.Date minimumDate) Deprecated. use CalendarModel directly with java.time API
void	setMultiSelect(boolean isMultiSelect)
void	setSelectedDate(java.util.Date date) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setSelectedDates(java.util.Date[] dates) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setShowTime(boolean showTime) Show or hide BOTH time and time zone components.
void	setShowTimeZone(boolean showTimeZone)
void	setShowToday(boolean showToday) Show or hide the 'today' component.
void	setTimeZone(java.util.TimeZone timeZone) Deprecated. use CalendarModel and the java.time API instead of java.util.Date
void	setVisibleDate(boolean visible) Turn on or off the display of the date component in this CalenderPanel (on by default).
void	setVisibleTime(boolean visible) Turn on or off the display of the time component in this CalenderPanel.
void	setVisibleTimeZone(boolean visible) Turn on or off the display of the time zone component in this CalenderPanel.

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, setEnabled, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, setLocation, setLocation, 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 Detail

DOUBLE_CLICK_COMMAND

public static final java.lang.String DOUBLE_CLICK_COMMAND

The command for the action fired when the user double clicks on the calendar grid

See Also:

Constant Field Values

SELECTION_CHANGED_COMMAND

public static final java.lang.String SELECTION_CHANGED_COMMAND

The command for the action fired when the selection of dates in the calendar changes

See Also:

Constant Field Values

Constructor Detail

CalendarPanel

@Deprecated
public CalendarPanel(java.util.Locale locale)

Deprecated.

Parameters:

locale -

CalendarPanel

public CalendarPanel()

Method Detail

setLocale

public void setLocale(java.util.Locale l)

Overrides:

setLocale in class java.awt.Component

getModel

public CalendarModel getModel()

Get the model used by this calendar. The model uses java.time package classes which are the preferred way to handle dates and time since jdk8. Manipulation of the Calendar through calls to this class with java.util.Dates is deprecated.

Returns:

the model used by this Calendar.

getSelectedDates

@Deprecated
public java.util.Date[] getSelectedDates()

Deprecated. new Java time api in JDK8 has better classes than java.util.Date for this sort of thing. Use getDates() instead.

returns an array of dates choosen in the calendar.

If the calendar is displaying the time section (in either edit or display mode) then the time portion (hours/minutes/seconds) for all returned dates will match the displayed time. Note: This means that any date set using setSelectedDate() or setSelectedDates() may not exactly match the return values for the same day. Calendar time

Returns:

an array of selected dates as java Date object.

getDates

public java.util.Set<java.time.ZonedDateTime> getDates()

Returns:

the set of selected dates, each with the time set to the current calendar time.

setSelectedDate

@Deprecated
public void setSelectedDate(java.util.Date date)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

Change the selected date/time to the given one.

Parameters:

date -

setTimeZone

@Deprecated
public void setTimeZone(java.util.TimeZone timeZone)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

Change the timezone.

Parameters:

timeZone - the time zone to set

getTimeZone

@Deprecated
public java.util.TimeZone getTimeZone()

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

setMultiSelect

public void setMultiSelect(boolean isMultiSelect)

isMultiSelect

public boolean isMultiSelect()

setSelectedDates

@Deprecated
public void setSelectedDates(java.util.Date[] dates)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

Change the current selected dates to be the given array. If the calendar is single select then the current selection changes to the first date of the given date array. As the calendar can have many selected dates but only one selected time, the calendar time is adjusted to that of the first date in the given array

Parameters:

dates -

addSelectedDates

@Deprecated
public void addSelectedDates(java.util.Date[] dates)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

add the given dates to the current selection. If the calendar is single select then the current selection changes to the first date of the given date array. The time portion of the calendar is not changed by this call

Parameters:

dates -

removeSelectedDates

@Deprecated
public void removeSelectedDates(java.util.Date[] dates)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

remove the given dates from the current selection

Parameters:

dates -

getVisibleDate

@Deprecated
public java.util.Date getVisibleDate()

Deprecated. use the java.time API instead of java.util.Date

will return a date that is currently visible in the calendar. i.e. one of the days of the currently selected month and year. There's no guarentee of which day in the month will be returned.

Returns:

makeDateVisible

@Deprecated
public void makeDateVisible(java.util.Date date)

Deprecated. use the java.time API instead of java.util.Date

Will adjust the calendar so that the given date is visible

Parameters:

date -

setMinimumDate

@Deprecated
public void setMinimumDate(java.util.Date minimumDate)

Deprecated. use CalendarModel directly with java.time API

Will disable all dates less than the given date

Parameters:

minimumDate -

getMinimumDate

@Deprecated
public java.util.Date getMinimumDate()

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

setMaximumDate

@Deprecated
public void setMaximumDate(java.util.Date maximumDate)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

getMaximumDate

@Deprecated
public java.util.Date getMaximumDate()

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

setDateProvider

@Deprecated
public void setDateProvider(CalendarDateProvider calDateProvider)

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

getDateProvider

@Deprecated
public CalendarDateProvider getDateProvider()

Deprecated. use CalendarModel and the java.time API instead of java.util.Date

setShowTime

public void setShowTime(boolean showTime)

Show or hide BOTH time and time zone components.

Parameters:

showTime -

isShowingTime

public boolean isShowingTime()

setShowToday

public void setShowToday(boolean showToday)

Show or hide the 'today' component.

Parameters:

showToday -

isShowingToday

public boolean isShowingToday()

setEditTime

public void setEditTime(boolean editTime)

isEditingTime

public boolean isEditingTime()

setShowTimeZone

public void setShowTimeZone(boolean showTimeZone)

getShowTimeZone

public boolean getShowTimeZone()

setVisibleDate

public void setVisibleDate(boolean visible)

Turn on or off the display of the date component in this CalenderPanel (on by default).

Parameters:

visible - boolean true to make it visible; false to make it invisible.

setVisibleTime

public void setVisibleTime(boolean visible)

Turn on or off the display of the time component in this CalenderPanel. Unlike setShowTimeZone(boolean), this method and setVisibleTimeZone(boolean) may be used to make the time only and time zone components separatly visible.

Parameters:

visible - boolean true to make it visible; false to make it invisible.

setVisibleTimeZone

public void setVisibleTimeZone(boolean visible)

Turn on or off the display of the time zone component in this CalenderPanel. Unlike setShowTimeZone(boolean), this method and setVisibleTime(boolean) may be used to make the time zone and time only components separatly visible.

Parameters:

visible - boolean true to make it visible; false to make it invisible.

getNearestTimeZone

@Deprecated
public java.util.TimeZone getNearestTimeZone(java.util.TimeZone timeZone)

Deprecated. the calendar now shows all time zones, so this method will always return the passed in time zone.

Finds the nearest TimeZone from the time zone list to the raw offset of the supplied timeZone.

Parameters:

timeZone - TimeZone to be checked.

Returns:

The TimeZone from the list that is the nearest match. When there are multiple values in the list with the same value the last one is returned, which typically is the GMT version.

getTimeZoneInList

@Deprecated
public java.util.TimeZone getTimeZoneInList(java.util.TimeZone timeZone)

Deprecated. the calendar now shows all time zones, so this method will always return the passed in time zone.

Returns a TimeZone from the time zone list that shares the same long daylight saving name.

Parameters:

timeZone - TimeZone to be located.

Returns:

a TimeZone from the list or null if there is no match.

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

goToToday

public void goToToday()

Change the date shown on the calendar to be 'Today'.