Package org.opencms.acacia.client.widgets.serialdate

Class CmsSerialDateController

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
org.opencms.acacia.client.widgets.serialdate.CmsSerialDateController
All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsEditWidget, I_StatusUpdateHandler
public class CmsSerialDateController extends com.google.gwt.user.client.ui.Composite implements I_CmsEditWidget, I_StatusUpdateHandler
Controller for the serial date widget, being the widget implementation itself.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CmsSerialDateController.PatternDefaultValues
    Data wrapper for the default values to set when changing the pattern, dependent on the event's start date.
    protected static class 
    CmsSerialDateController.StatusUpdateTimer
    The status update timer.

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

    com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_DATE_FORMAT
    Default date format.

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsSerialDateController()
    Category field widgets for ADE forms.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
     
    void
    conditionallyRemoveExceptionsOnChange(com.google.gwt.user.client.Command action, boolean showDialog)
     
    void
    executeShowDatesAction()
    Show the dates for managing exceptions.
    I_CmsSerialDatePatternController
    getPattern()
    Returns the controller for the currently active pattern.
    CmsSerialDateController.PatternDefaultValues
    getPatternDefaultValues()
    Returns the default values to set for the patterns dependent on the current start date.
    I_CmsSerialDatePatternView
    getPatternView()
    Returns the widget to place in the pattern panel.
    String
    getValue()
     
    boolean
    isActive()
    Returns if the widget is active.
    void
    onAttachWidget()
    This method is called when a widget is attached to the browser's document.
    boolean
    owns(com.google.gwt.dom.client.Element element)
    Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside".
    void
    removeExceptionsOnChange(com.google.gwt.user.client.Command cmd)
     
    void
    setActive(boolean active)
    Sets the widget active/inactive.
    void
    setCurrentTillEnd(Boolean isCurrentTillEnd)
    Set the flag, indicating if the events are displayed as "current" till they end (true) or only till they start (false).
    void
    setEndTime(Date date)
    Set the end time.
    void
    setEndType(String value)
    Set the duration option.
    void
    setIsSeries(Boolean isSeries)
    Toggle between single events and series.
    void
    setName(String name)
    Sets the name of input fields.
    void
    setOccurrences(String occurrences)
    Set the occurrences.
    void
    setPattern(String patternType)
    Set the serial pattern type.
    void
    setSeriesEndDate(Date date)
    Set the serial end date.
    void
    setStartTime(Date date)
    Set the start time.
    void
    setValue(String value)
     
    void
    setValue(String value, boolean fireEvent)
     
    void
    setWholeDay(Boolean isWholeDay)
    Sets the whole day flag.
    void
    sizeChanged()
     
    void
    updateExceptions(SortedSet<Date> exceptions)
    Updates the exceptions.
    void
    updateStatus()
    Method called when a status update is triggered.
    void
    valueChanged()
     

    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

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

    Methods inherited from interface com.google.gwt.event.shared.HasHandlers

    fireEvent

    Methods inherited from interface org.opencms.acacia.client.widgets.I_CmsEditWidget

    shouldSetDefaultWhenDisabled

    Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

    asWidget

  • Field Details

  • Constructor Details

  • Method Details

    • addFocusHandler

      public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
      Specified by:
      addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers
      See Also:
      • HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)

    • addValueChangeHandler

      public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
      Specified by:
      addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>
      Specified by:
      addValueChangeHandler in interface I_CmsEditWidget
      See Also:
      • HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

    • conditionallyRemoveExceptionsOnChange

      public void conditionallyRemoveExceptionsOnChange(com.google.gwt.user.client.Command action, boolean showDialog)
      See Also:
      • I_ChangeHandler.conditionallyRemoveExceptionsOnChange(com.google.gwt.user.client.Command, boolean)

    • executeShowDatesAction

      public void executeShowDatesAction()
      Show the dates for managing exceptions.

    • getPattern

      public I_CmsSerialDatePatternController getPattern()
      Returns the controller for the currently active pattern.
      Returns:
      the controller for the currently active pattern.

    • getPatternDefaultValues

      public CmsSerialDateController.PatternDefaultValues getPatternDefaultValues()
      Returns the default values to set for the patterns dependent on the current start date.
      Returns:
      the default values to set for the patterns dependent on the current start date.

    • getPatternView

      public I_CmsSerialDatePatternView getPatternView()
      Returns the widget to place in the pattern panel.
      Returns:
      the widget to place in the pattern panel.

    • getValue

      public String getValue()
      Specified by:
      getValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      getValue in interface com.google.gwt.user.client.TakesValue<String>
      See Also:
      • HasValue.getValue()

    • isActive

      public boolean isActive()
      Description copied from interface: I_CmsEditWidget
      Returns if the widget is active.

      Specified by:
      isActive in interface I_CmsEditWidget
      Returns:
      true if the widget is active
      See Also:

    • onAttachWidget

      public void onAttachWidget()
      Description copied from interface: I_CmsEditWidget
      This method is called when a widget is attached to the browser's document.

      It needs to call the Widget.onAttach() method.

      Specified by:
      onAttachWidget in interface I_CmsEditWidget
      See Also:

    • owns

      public boolean owns(com.google.gwt.dom.client.Element element)
      Description copied from interface: I_CmsEditWidget
      Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside". For example, this is needed if the widget uses a popup.
      Specified by:
      owns in interface I_CmsEditWidget
      Parameters:
      element - the element to check
      Returns:
      true if the element counts as part of the widget
      See Also:

    • removeExceptionsOnChange

      public void removeExceptionsOnChange(com.google.gwt.user.client.Command cmd)
      See Also:
      • I_ChangeHandler.removeExceptionsOnChange(com.google.gwt.user.client.Command)

    • setActive

      public void setActive(boolean active)
      Description copied from interface: I_CmsEditWidget
      Sets the widget active/inactive.

      Specified by:
      setActive in interface I_CmsEditWidget
      Parameters:
      active - true to activate the widget
      See Also:

    • setCurrentTillEnd

      public void setCurrentTillEnd(Boolean isCurrentTillEnd)
      Set the flag, indicating if the events are displayed as "current" till they end (true) or only till they start (false).
      Parameters:
      isCurrentTillEnd - the flag, indicating if the events are displayed as "current" till they end (true) or only till they start (false).

    • setEndTime

      public void setEndTime(Date date)
      Set the end time.
      Parameters:
      date - the end time to set.

    • setEndType

      public void setEndType(String value)
      Set the duration option.
      Parameters:
      value - the duration option to set (I_CmsSerialDateValue.EndType as string).

    • setIsSeries

      public void setIsSeries(Boolean isSeries)
      Toggle between single events and series.
      Parameters:
      isSeries - flag, indicating if we want a series of events.

    • setName

      public void setName(String name)
      Description copied from interface: I_CmsEditWidget
      Sets the name of input fields.

      Specified by:
      setName in interface I_CmsEditWidget
      Parameters:
      name - of the input field
      See Also:

    • setOccurrences

      public void setOccurrences(String occurrences)
      Set the occurrences. If the String is invalid, the occurrences will be set to "-1" to cause server-side validation to fail.
      Parameters:
      occurrences - the interval to set.

    • setPattern

      public void setPattern(String patternType)
      Set the serial pattern type.
      Parameters:
      patternType - the pattern type to set.

    • setSeriesEndDate

      public void setSeriesEndDate(Date date)
      Set the serial end date.
      Parameters:
      date - the serial end date.

    • setStartTime

      public void setStartTime(Date date)
      Set the start time.
      Parameters:
      date - the start time to set.

    • setValue

      public void setValue(String value)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      setValue in interface com.google.gwt.user.client.TakesValue<String>
      See Also:
      • HasValue.setValue(java.lang.Object)

    • setValue

      public void setValue(String value, boolean fireEvent)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      setValue in interface I_CmsEditWidget
      See Also:

    • setWholeDay

      public void setWholeDay(Boolean isWholeDay)
      Sets the whole day flag.
      Parameters:
      isWholeDay - flag, indicating if the event lasts whole days.

    • sizeChanged

      public void sizeChanged()
      See Also:
      • I_ChangeHandler.sizeChanged()

    • updateExceptions

      public void updateExceptions(SortedSet<Date> exceptions)
      Updates the exceptions.
      Parameters:
      exceptions - the exceptions to set

    • updateStatus

      public void updateStatus()
      Description copied from interface: I_StatusUpdateHandler
      Method called when a status update is triggered.
      Specified by:
      updateStatus in interface I_StatusUpdateHandler
      See Also:

    • valueChanged

      public void valueChanged()
      See Also:
      • I_ChangeHandler.valueChanged()