com.whitestein.lsps.vaadin.forms

Class WCalendar

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WCalendar

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

public class WCalendar
extends FormComponent

A calendar component.

Author:

jsa

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WCalendar()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractComponent	createWidget() Called once, to create the actual Vaadin component.
boolean	isReadOnly()
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	refresh() Refreshes the content of the calendar.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setCalendarItemProvider(RecordHolder eventProvider) Sets the calendar item provider.
void	setCalendarMode(EnumerationImpl mode) Sets the calendar mode.
void	setInitialDate(Date initialDate) Sets the initial date of the calendar
void	setReadOnly(boolean readOnly)
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidget, getWidth, hashCode, isEnabled, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WCalendar

public WCalendar()

Method Detail

createWidget

protected com.vaadin.ui.AbstractComponent createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

setReadOnly

public void setReadOnly(boolean readOnly)

Overrides:

setReadOnly in class FormComponent

isReadOnly

public boolean isReadOnly()

Overrides:

isReadOnly in class FormComponent

setCalendarMode

public void setCalendarMode(EnumerationImpl mode)

Sets the calendar mode.

Parameters:

mode - a record holder representing the 'forms::CalendarMode' enum value.

setInitialDate

public void setInitialDate(Date initialDate)

Sets the initial date of the calendar

Parameters:

initialDate - the date to set

setCalendarItemProvider

public void setCalendarItemProvider(RecordHolder eventProvider)

Sets the calendar item provider. The item provider is responsible for loading calendar items for the calendar.

Parameters:

eventProvider - the event provider to set.

refresh

public void refresh()

Refreshes the content of the calendar.

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class FormComponent

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)