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, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.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()
String	getInput()
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()
protected void	onInitialize()
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()

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()

Overrides:

getInput in class FormComponent<LocalTime>

convertInput

public void convertInput()

Overrides:

convertInput in class FormComponent<LocalTime>

onConfigure

protected void onConfigure()

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