com.vaadin.client.ui.calendar.
Class CalendarConnector
- java.lang.Object
-
- com.vaadin.client.ui.AbstractConnector
-
- com.vaadin.client.ui.AbstractComponentConnector
-
- com.vaadin.client.ui.calendar.CalendarConnector
-
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler
,StateChangeEvent.StateChangeHandler
,ComponentConnector
,Paintable
,ServerConnector
,ActionOwner
,ManagedLayout
,SimpleManagedLayout
,Connector
,Serializable
public class CalendarConnector extends AbstractComponentConnector implements ActionOwner, SimpleManagedLayout, Paintable
Handles communication between Calendar on the server side and
VCalendar
on the client side.Since:
7.1
Author:
Vaadin Ltd.
See Also:
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector
SIGNIFICANT_MOVE_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description CalendarConnector()
-
Method Summary
All Methods Modifier and Type Method Description String
getActionCaption(String actionKey)
Get the text that is displayed for a context menu item
Date
getActionEndDate(String actionKey)
Get the end date for an action item
String
getActionIcon(String actionKey)
Get the icon url for a context menu item
String
getActionID(String actionKey)
Get the original action ID that was passed in from the shared state
Action[]
getActions()
Returns ALL currently registered events.
Date
getActionStartDate(String actionKey)
Get the start date for an action item
ApplicationConnection
getClient()
Returns the ApplicationConnection used to connect to the server side
String
getPaintableId()
CalendarState
getState()
Returns the shared state object for this connector.
TooltipInfo
getTooltipInfo(com.google.gwt.dom.client.Element element)
Gets the tooltip info for the given element.
VCalendar
getWidget()
Returns the widget associated with this paintable.
boolean
hasTooltip()
Check whether there might be a tooltip for this component.
protected void
init()
Called when the connector has been initialized.
void
layout()
void
onStateChanged(StateChangeEvent stateChangeEvent)
Notifies the event handler that the state has changed.
void
onUnregister()
Event called when connector has been unregistered.
protected void
registerListeners()
Registers listeners on the calendar so server can be notified of the events
void
updateFromUIDL(UIDL uidl, ApplicationConnection client)
-
Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector
createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, isReadOnly, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, registerTouchHandlers, sendContextClickEvent, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, updateComponentSize, updateEnabledState, updateWidgetSize, updateWidgetStyleNames
-
Methods inherited from class com.vaadin.client.ui.AbstractConnector
addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, unregisterRpc
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.client.ComponentConnector
delegateCaptionHandling, flush, getLayoutManager, isReadOnly, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled
-
Methods inherited from interface com.vaadin.shared.Connector
getConnectorId
-
Methods inherited from interface com.vaadin.client.ServerConnector
addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, hasEventListener, isEnabled, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, updateEnabledState
-
-
-
-
Method Detail
-
init
protected void init()
Description copied from class:
AbstractConnector
Called when the connector has been initialized. Override this method to perform initialization of the connector.
Overrides:
init
in classAbstractConnector
-
onUnregister
public void onUnregister()
Description copied from interface:
ServerConnector
Event called when connector has been unregistered.
Specified by:
onUnregister
in interfaceServerConnector
Overrides:
onUnregister
in classAbstractComponentConnector
-
getWidget
public VCalendar getWidget()
Description copied from class:
AbstractComponentConnector
Returns the widget associated with this paintable. The widget returned by this method must not changed during the life time of the paintable.
Specified by:
getWidget
in interfaceComponentConnector
Overrides:
getWidget
in classAbstractComponentConnector
Returns:
The widget associated with this paintable
-
getState
public CalendarState getState()
Description copied from class:
AbstractConnector
Returns the shared state object for this connector. Override this method to define the shared state type for your connector.
Specified by:
getState
in interfaceComponentConnector
Specified by:
getState
in interfaceServerConnector
Overrides:
getState
in classAbstractComponentConnector
Returns:
the current shared state (never null)
-
registerListeners
protected void registerListeners()
Registers listeners on the calendar so server can be notified of the events
-
onStateChanged
public void onStateChanged(StateChangeEvent stateChangeEvent)
Description copied from interface:
StateChangeEvent.StateChangeHandler
Notifies the event handler that the state has changed.
Specified by:
onStateChanged
in interfaceStateChangeEvent.StateChangeHandler
Overrides:
onStateChanged
in classAbstractComponentConnector
Parameters:
stateChangeEvent
- the state change event with details about the change
-
updateFromUIDL
public void updateFromUIDL(UIDL uidl, ApplicationConnection client)
Specified by:
updateFromUIDL
in interfacePaintable
-
getClient
public ApplicationConnection getClient()
Returns the ApplicationConnection used to connect to the server side
Specified by:
getClient
in interfaceActionOwner
-
getTooltipInfo
public TooltipInfo getTooltipInfo(com.google.gwt.dom.client.Element element)
Description copied from interface:
ComponentConnector
Gets the tooltip info for the given element.
When overriding this method,
ComponentConnector.hasTooltip()
should also be overridden to returntrue
in all situations where this method might return a non-empty result.Specified by:
getTooltipInfo
in interfaceComponentConnector
Overrides:
getTooltipInfo
in classAbstractComponentConnector
Parameters:
element
- The element to lookup a tooltip forReturns:
The tooltip for the element or null if no tooltip is defined for this element.
-
hasTooltip
public boolean hasTooltip()
Description copied from interface:
ComponentConnector
Check whether there might be a tooltip for this component. The framework will only add event listeners for automatically handling tooltips (using
ComponentConnector.getTooltipInfo(Element)
) if this method returns true.This is only done to optimize performance, so in cases where the status is not known, it's safer to return
true
so that there will be a tooltip handler even though it might not be needed in all cases.Specified by:
hasTooltip
in interfaceComponentConnector
Overrides:
hasTooltip
in classAbstractComponentConnector
Returns:
true
if some part of the component might have a tooltip, otherwisefalse
-
getActionID
public String getActionID(String actionKey)
Get the original action ID that was passed in from the shared state
Parameters:
actionKey
- the unique action keyReturns:
Since:
7.1.2
-
getActionCaption
public String getActionCaption(String actionKey)
Get the text that is displayed for a context menu item
Parameters:
actionKey
- The unique action keyReturns:
-
getActionIcon
public String getActionIcon(String actionKey)
Get the icon url for a context menu item
Parameters:
actionKey
- The unique action keyReturns:
-
getActionStartDate
public Date getActionStartDate(String actionKey) throws ParseException
Get the start date for an action item
Parameters:
actionKey
- The unique action keyReturns:
Throws:
-
getActionEndDate
public Date getActionEndDate(String actionKey) throws ParseException
Get the end date for an action item
Parameters:
actionKey
- The unique action keyReturns:
Throws:
-
getActions
public Action[] getActions()
Returns ALL currently registered events. Use
#getActions(Date)
to get the actions for a specific dateSpecified by:
getActions
in interfaceActionOwner
Returns:
Array of IActions
-
getPaintableId
public String getPaintableId()
Specified by:
getPaintableId
in interfaceActionOwner
-
layout
public void layout()
Specified by:
layout
in interfaceSimpleManagedLayout
-
-