Class DateTimePicker

  • All Implemented Interfaces:
    Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<Date,​org.apache.wicket.markup.html.form.FormComponent<Date>>, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
    Direct Known Subclasses:
    AjaxDateTimePicker

    public class DateTimePicker
    extends org.apache.wicket.markup.html.form.FormComponentPanel<Date>
    implements org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider
    Provides a datetime-picker based on a DatePicker and a TimePicker
    Author:
    Sebastien Briquet - sebfz1
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected DatePicker datePicker  
      protected TimePicker timePicker  
      • Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

        FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR
      • Fields inherited from class org.apache.wicket.Component

        ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String formatInput​(String dateInput, String timeInput)
      Gets a formated value of input(s)
      This method is designed to provide the 'value' argument of IConverter.convertToObject(String, Locale)
      <C> org.apache.wicket.util.convert.IConverter<C> getConverter​(Class<C> type)  
      String getDatePattern()
      Gets the date pattern in use
      String getInput()  
      Locale getLocale()  
      String getModelObjectAsString()
      Gets a (localized) string representation of the model object, given the date-time pattern in use.
      String getTextFormat()
      Returns the date-time pattern.
      String getTimePattern()
      Gets the time pattern in use
      boolean isTimePickerEnabled()
      Indicates whether the time-picker is enabled.
      This method is marked final because an override will not change the time-picker 'enable' flag
      protected DatePicker newDatePicker​(String id, org.apache.wicket.model.IModel<Date> model, Locale locale, String datePattern, com.googlecode.wicket.jquery.core.Options options)
      Gets a new DatePicker
      protected TimePicker newTimePicker​(String id, org.apache.wicket.model.IModel<Date> model, Locale locale, String timePattern, com.googlecode.wicket.jquery.core.Options options)
      Gets a new TimePicker
      protected void onInitialize()  
      DateTimePicker setTimePickerEnabled​(boolean enabled)
      Sets the time-picker enabled flag
      void setTimePickerEnabled​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, boolean enabled)
      Sets the time-picker enabled flag
      • Methods inherited from class org.apache.wicket.markup.html.form.FormComponentPanel

        checkRequired, clearInput, newMarkupSourcingStrategy, onComponentTag
      • Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

        add, add, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder
      • Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

        getLabel
      • Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

        getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession
      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren
      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap
      • Methods inherited from interface org.apache.wicket.IGenericComponent

        getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject
      • Methods inherited from interface org.apache.wicket.IQueueRegion

        dequeue, getRegionMarkup, newDequeueContext
    • Constructor Detail

      • DateTimePicker

        public DateTimePicker​(String id)
        Constructor
        Parameters:
        id - the markup id
      • DateTimePicker

        public DateTimePicker​(String id,
                              Locale locale)
        Constructor
        Parameters:
        id - the markup id
        locale - the Locale
      • DateTimePicker

        public DateTimePicker​(String id,
                              String datePattern,
                              String timePattern)
        Constructor
        Parameters:
        id - the markup id
        datePattern - the SimpleDateFormat pattern for the date
        timePattern - the SimpleDateFormat pattern for the time
      • DateTimePicker

        public DateTimePicker​(String id,
                              Locale locale,
                              String datePattern,
                              String timePattern)
        constructor
        Parameters:
        id - the markup id
        locale - the Locale
        datePattern - the SimpleDateFormat pattern for the date
        timePattern - the SimpleDateFormat pattern for the time
      • DateTimePicker

        public DateTimePicker​(String id,
                              org.apache.wicket.model.IModel<Date> model)
        Constructor
        Parameters:
        id - the markup id
        model - the date IModel
      • DateTimePicker

        public DateTimePicker​(String id,
                              org.apache.wicket.model.IModel<Date> model,
                              Locale locale)
        Constructor
        Parameters:
        id - the markup id
        model - the date IModel
        locale - the LocalDate
      • DateTimePicker

        public DateTimePicker​(String id,
                              org.apache.wicket.model.IModel<Date> model,
                              String datePattern,
                              String timePattern)
        Constructor
        Parameters:
        id - the markup id
        model - the date IModel
        datePattern - the SimpleDateFormat pattern for the date
        timePattern - the SimpleDateFormat pattern for the time
      • DateTimePicker

        public DateTimePicker​(String id,
                              org.apache.wicket.model.IModel<Date> model,
                              Locale locale,
                              String datePattern,
                              String timePattern)
        Main constructor
        Parameters:
        id - the markup id
        model - the date IModel
        locale - the Locale
        datePattern - the SimpleDateFormat pattern for the date
        timePattern - the SimpleDateFormat pattern for the time
    • Method Detail

      • getInput

        public String getInput()
        Overrides:
        getInput in class org.apache.wicket.markup.html.form.FormComponent<Date>
      • formatInput

        protected String formatInput​(String dateInput,
                                     String timeInput)
        Gets a formated value of input(s)
        This method is designed to provide the 'value' argument of IConverter.convertToObject(String, Locale)
        Parameters:
        dateInput - the date input
        timeInput - the time input
        Returns:
        a formated value
      • getLocale

        public Locale getLocale()
        Overrides:
        getLocale in class org.apache.wicket.Component
      • getConverter

        public <C> org.apache.wicket.util.convert.IConverter<C> getConverter​(Class<C> type)
        Specified by:
        getConverter in interface org.apache.wicket.IConverterLocator
        Overrides:
        getConverter in class org.apache.wicket.Component
      • getTextFormat

        public final String getTextFormat()
        Returns the date-time pattern.
        Specified by:
        getTextFormat in interface org.apache.wicket.markup.html.form.AbstractTextComponent.ITextFormatProvider
        See Also:
        AbstractTextComponent.ITextFormatProvider.getTextFormat()
      • getModelObjectAsString

        public String getModelObjectAsString()
        Gets a (localized) string representation of the model object, given the date-time pattern in use.
        Returns:
        the model object as string
      • getDatePattern

        public final String getDatePattern()
        Gets the date pattern in use
        Returns:
        the pattern
      • getTimePattern

        public final String getTimePattern()
        Gets the time pattern in use
        Returns:
        the pattern
      • isTimePickerEnabled

        public final boolean isTimePickerEnabled()
        Indicates whether the time-picker is enabled.
        This method is marked final because an override will not change the time-picker 'enable' flag
        Returns:
        the enabled flag
      • setTimePickerEnabled

        public final DateTimePicker setTimePickerEnabled​(boolean enabled)
        Sets the time-picker enabled flag
        Parameters:
        enabled - the enabled flag
        Returns:
        this, for chaining
      • setTimePickerEnabled

        public final void setTimePickerEnabled​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                                               boolean enabled)
        Sets the time-picker enabled flag
        Parameters:
        handler - the IPartialPageRequestHandler
        enabled - the enabled flag
      • onInitialize

        protected void onInitialize()
        Overrides:
        onInitialize in class org.apache.wicket.MarkupContainer
      • newDatePicker

        protected DatePicker newDatePicker​(String id,
                                           org.apache.wicket.model.IModel<Date> model,
                                           Locale locale,
                                           String datePattern,
                                           com.googlecode.wicket.jquery.core.Options options)
        Gets a new DatePicker
        Parameters:
        id - the markup id
        model - the IModel
        locale - the Locale
        datePattern - the date pattern to be used
        options - the Options
        Returns:
        the DatePicker
      • newTimePicker

        protected TimePicker newTimePicker​(String id,
                                           org.apache.wicket.model.IModel<Date> model,
                                           Locale locale,
                                           String timePattern,
                                           com.googlecode.wicket.jquery.core.Options options)
        Gets a new TimePicker
        Parameters:
        id - the markup id
        model - the IModel
        locale - the Locale
        timePattern - the time pattern to be used
        options - the Options
        Returns:
        the TimePicker