com.google.gwt.user.datepicker.client

Class CalendarView

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.google.gwt.user.datepicker.client.CalendarView

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsRenderable, IsWidget

Direct Known Subclasses:

DefaultCalendarView

public abstract class CalendarView
extends Composite

The CalendarView is a calendar grid that represents the current view of a DatePicker. Note, the calendar view only deals with the currently visible dates and all state is flushed when the calendar view is refreshed.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CalendarView() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addMonths(int numMonths)
abstract void	addStyleToDate(String styleName, Date date) Adds a style name to the cell of the supplied date.
protected DatePicker	getDatePicker()
abstract Date	getFirstDate() Returns the first date that is currently shown by the calendar.
abstract Date	getLastDate() Returns the last date that is currently shown by the calendar.
CalendarModel	getModel()
abstract boolean	isDateEnabled(Date date) Is the cell representing the given date enabled?
protected abstract void	refresh() Refresh the component.
protected void	refreshAll() Refreshes the DatePicker, CalendarView, and CalendarModel.
abstract void	removeStyleFromDate(String styleName, Date date) Removes a visible style name from the cell of the supplied date.
void	setAriaSelectedCell(Date date) Sets aria-selected in the given date's cell and clears the other cells.
abstract void	setEnabledOnDate(boolean enabled, Date date) Enables or Disables a particular date.
protected void	setHighlightedDate(Date date) Allows the calendar view to update the date picker's highlighted date.
protected abstract void	setup() Set up the component.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Constructor Detail

CalendarView

public CalendarView()

Constructor.

Method Detail

addStyleToDate

public abstract void addStyleToDate(String styleName,
                                    Date date)

Adds a style name to the cell of the supplied date. This style is only set until the next time the CalendarView is refreshed.

Parameters:

styleName - style name to add

date - date that will have the supplied style added

getFirstDate

public abstract Date getFirstDate()

Returns the first date that is currently shown by the calendar.

Returns:

the first date.

getLastDate

public abstract Date getLastDate()

Returns the last date that is currently shown by the calendar.

Returns:

the last date.

isDateEnabled

public abstract boolean isDateEnabled(Date date)

Is the cell representing the given date enabled?

Parameters:

date - the date

Returns:

is the date enabled

removeStyleFromDate

public abstract void removeStyleFromDate(String styleName,
                                         Date date)

Removes a visible style name from the cell of the supplied date.

Parameters:

styleName - style name to remove

date - date that will have the supplied style added

setAriaSelectedCell

public void setAriaSelectedCell(Date date)

Sets aria-selected in the given date's cell and clears the other cells.

Parameters:

date - the date of the cell where aria-selected should be set, or null to clear aria-selected.

setEnabledOnDate

public abstract void setEnabledOnDate(boolean enabled,
                                      Date date)

Enables or Disables a particular date. by default all valid dates are enabled after a rendering event. Disabled dates cannot be selected.

Parameters:

enabled - true for enabled, false for disabled

date - date to enable or disable

setHighlightedDate

protected final void setHighlightedDate(Date date)

Allows the calendar view to update the date picker's highlighted date.

Parameters:

date - the highlighted date

getModel

public CalendarModel getModel()

addMonths

protected void addMonths(int numMonths)

getDatePicker

protected DatePicker getDatePicker()

refresh

protected abstract void refresh()

Refresh the component. Usually called because the model's current date has changed. In general, only should be called by DatePicker. Use refreshAll() if you need to refresh all components.

refreshAll

protected void refreshAll()

Refreshes the DatePicker, CalendarView, and CalendarModel.

setup

protected abstract void setup()

Set up the component.