Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.markup.html.form.datetime

Class TimeField

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<T>

org.apache.wicket.markup.html.form.FormComponentPanel<LocalTime>

org.apache.wicket.extensions.markup.html.form.datetime.TimeField

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<LocalTime,FormComponent<LocalTime>>, IMetadataContext<Serializable,Component>, IQueueRegion, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class TimeField
extends FormComponentPanel<LocalTime>

Works on a LocalTime object. Displays a field for hours and a field for minutes, and an AM/PM field. The format (12h/24h) of the hours field depends on the time format of this TimeField's Locale, as does the visibility of the AM/PM field (see use12HourFormat()).

Author:

eelcohillenius

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TimeField.AM_PM	Enumerated type for different ways of handling the render part of requests.
protected class	TimeField.AmPmModel
protected class	TimeField.HoursModel
protected class	TimeField.MinutesModel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HOURS_CSS_CLASS_KEY
static final String	MINUTES_CSS_CLASS_KEY

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

Constructor Summary

Constructors

Constructor	Description
TimeField(String id)	Construct.
TimeField(String id, IModel<LocalTime> model)	Construct.

Method Summary

Modifier and Type	Method	Description
void	convertInput()	Converts and validates the conversion of the raw input string into the object specified by FormComponent.getType() and records any thrown ConversionExceptions.
String	getInput()	Gets the request parameter for this component as a string.
protected TextField<Integer>	newHoursTextField(String id, IModel<Integer> model, Class<Integer> type)	create a new TextField instance for hours to be added to this panel.
protected TextField<Integer>	newMinutesTextField(String id, IModel<Integer> model, Class<Integer> type)	create a new TextField instance for minutes to be added to this panel.
protected void	onConfigure()	Called on all components before any component is rendered.
protected void	onInitialize()	This method is meant to be used as an alternative to initialize components.
protected boolean	use12HourFormat()	Checks whether the current Locale uses the 12h or 24h time format.

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, 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, onBeforeRender, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, 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, 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, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, 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, 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 class java.lang.Object

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

HOURS_CSS_CLASS_KEY

public static final String HOURS_CSS_CLASS_KEY

MINUTES_CSS_CLASS_KEY

public static final String MINUTES_CSS_CLASS_KEY

Constructor Details

TimeField

public TimeField(String id)

Construct.

Parameters:

id - the component id

TimeField

public TimeField(String id,
 IModel<LocalTime> model)

Construct.

Parameters:

id - the component id

model - the component's model

Method Details

onInitialize

protected void onInitialize()

Description copied from class: Component

This method is meant to be used as an alternative to initialize components. Usually the component's constructor is used for this task, but sometimes a component cannot be initialized in isolation, it may need to access its parent component or its markup in order to fully initialize. This method is invoked once per component's lifecycle when a path exists from this component to the Page thus providing the component with an atomic callback when the component's environment is built out.

Overrides must call super#Component.onInitialize(). Usually this should be the first thing an override does, much like a constructor.

Parent containers are guaranteed to be initialized before their children

It is safe to use Component.getPage() in this method

NOTE:The timing of this call is not precise, the contract is that it is called sometime before Component.onBeforeRender().

Overrides:

onInitialize in class MarkupContainer

newHoursTextField

protected TextField<Integer> newHoursTextField(String id,
 IModel<Integer> model,
 Class<Integer> type)

create a new TextField instance for hours to be added to this panel.

Parameters:

id - the component id

model - model that should be used by the TextField

type - the type of the text field

Returns:

a new text field instance

newMinutesTextField

protected TextField<Integer> newMinutesTextField(String id,
 IModel<Integer> model,
 Class<Integer> type)

create a new TextField instance for minutes to be added to this panel.

Parameters:

id - the component id

model - model that should be used by the TextField

type - the type of the text field

Returns:

a new text field instance

getInput

public String getInput()

Description copied from class: FormComponent

Gets the request parameter for this component as a string.

Overrides:

getInput in class FormComponent<LocalTime>

Returns:

The value in the request for this component

convertInput

public void convertInput()

Description copied from class: FormComponent

Converts and validates the conversion of the raw input string into the object specified by FormComponent.getType() and records any thrown ConversionExceptions. Converted value is available through FormComponent.getConvertedInput().

Usually the user should do custom conversions by specifying an IConverter by registering it with the application by overriding Application.getConverterLocator(), or at the component level by overriding Component.getConverter(Class) .

DO NOT CALL THIS METHOD DIRECTLY UNLESS YOU ARE SURE WHAT YOU ARE DOING. USUALLY UPDATING YOUR MODEL IS HANDLED BY THE FORM, NOT DIRECTLY BY YOU.

Overrides:

convertInput in class FormComponent<LocalTime>

See Also:

• IConverterLocator
• Application.newConverterLocator()
• IConverter.convertToObject(String, Locale)
• FormComponent.newValidationError(ConversionException)

onConfigure

protected void onConfigure()

Description copied from class: Component

Called on all components before any component is rendered. This method should be used to configure such things as visibility and enabled flags.

Overrides must call super.onConfigure(), usually before any other code

NOTE: Component hierarchy should not be modified inside this method, instead it should be done in Component.onBeforeRender()

NOTE: Why this method is preferrable to directly overriding Component.isVisible() and Component.isEnabled()? Because those methods are called multiple times even for processing of a single request. If they contain expensive logic they can slow down the response time of the entire page. Further, overriding those methods directly on form components may lead to inconsistent or unexpected state depending on when those methods are called in the form processing workflow. It is a better practice to push changes to state rather than pull.

NOTE: If component's visibility or another property depends on another component you may call other.configure() followed by other.isVisible() as mentioned in Component.configure() javadoc.

NOTE: Why should Component.onBeforeRender() not be used for this? Because if a component's visibility is controlled inside Component.onBeforeRender(), once invisible the component will never become visible again.

Overrides:

onConfigure in class Component

use12HourFormat

protected boolean use12HourFormat()

Checks whether the current Locale uses the 12h or 24h time format. This method can be overridden to e.g. always use 24h format.

Returns:

true, if the current Locale uses the 12h format.
false, otherwise