de.agilecoders.wicket.markup.html.bootstrap.extensions.form

Class DateTextFieldConfig

java.lang.Object

de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

de.agilecoders.wicket.markup.html.bootstrap.extensions.form.DateTextFieldConfig

All Implemented Interfaces:

Serializable, org.apache.wicket.util.io.IClusterable

public final class DateTextFieldConfig
extends AbstractConfig

Configuration holder for all DateTextField configurations.

Author:

miha

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateTextFieldConfig.Day holds all week days in a specific sort order.
static class	DateTextFieldConfig.View holds all view options.

Nested classes/interfaces inherited from class de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

AbstractConfig.IKey<T>

Constructor Summary

Constructors

Constructor and Description
DateTextFieldConfig() Construct.

Method Summary

Methods

Modifier and Type	Method and Description
DateTextFieldConfig	allowKeyboardNavigation(boolean value) Whether or not to allow date navigation by arrow keys.
DateTextFieldConfig	autoClose(boolean value) Whether or not to close the datepicker immediately when a date is selected.
DateTextFieldConfig	forceParse(boolean value) Whether or not to force parsing of the input value when the picker is closed.
String	getFormat()
String	getLanguage()
DateTextFieldConfig	highlightToday(boolean value) If true, highlights the current date.
boolean	isDefaultLanguageSet()
DateTextFieldConfig	showTodayButton(boolean value) If true, displays a "Today" button at the bottom of the datepicker to select the current date.
DateTextFieldConfig	withEndDate(org.joda.time.DateTime value) The latest date that may be selected; all later dates will be disabled.
DateTextFieldConfig	withFormat(String value) The date format (java style), combination of d, dd, m, mm, M, MM, yy, yyyy.
DateTextFieldConfig	withLanguage(String value) The two-letter code of the language to use for month and day names.
DateTextFieldConfig	withStartDate(org.joda.time.DateTime value) The earliest date that may be selected; all earlier dates will be disabled.
DateTextFieldConfig	withView(DateTextFieldConfig.View value) The view that the datepicker should show when it is opened.
DateTextFieldConfig	withWeekStart(DateTextFieldConfig.Day value) Day of the week start. 0 (Sunday) to 6 (Saturday)

Methods inherited from class de.agilecoders.wicket.markup.html.bootstrap.common.AbstractConfig

all, getString, isEmpty, newKey, put, remove, toJsonString, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTextFieldConfig

public DateTextFieldConfig()

Construct.

Method Detail

getFormat

public String getFormat()

Returns:

the date format as string

getLanguage

public String getLanguage()

Returns:

the language to use

isDefaultLanguageSet

public boolean isDefaultLanguageSet()

Returns:

true if default language should be used.

withStartDate

public DateTextFieldConfig withStartDate(org.joda.time.DateTime value)

The earliest date that may be selected; all earlier dates will be disabled.

Parameters:

value - the earliest start date

Returns:

this instance for chaining

withEndDate

public DateTextFieldConfig withEndDate(org.joda.time.DateTime value)

The latest date that may be selected; all later dates will be disabled.

Parameters:

value - the latest end date

Returns:

this instance for chaining

withLanguage

public DateTextFieldConfig withLanguage(String value)

The two-letter code of the language to use for month and day names. These will also be used as the input's value (and subsequently sent to the server in the case of form submissions). Currently ships with English ('en'), German ('de'), Brazilian ('br'), and Spanish ('es') translations, but others can be added (see I18N below). If an unknown language code is given, English will be used.

Parameters:

value - two letter language code (optional 5 letter code like de_DE)

Returns:

this instance for chaining

withView

public DateTextFieldConfig withView(DateTextFieldConfig.View value)

The view that the datepicker should show when it is opened. Accepts values of 0 or 'month' for month view (the default), 1 or 'year' for the 12-month overview, and 2 or 'decade' for the 10-year overview. Useful for date-of-birth datepicker.

Parameters:

value - the start view to use

Returns:

this instance for chaining

withFormat

public DateTextFieldConfig withFormat(String value)

The date format (java style), combination of d, dd, m, mm, M, MM, yy, yyyy.

Parameters:

value - The date format value (java style)

Returns:

this instance for chaining

withWeekStart

public DateTextFieldConfig withWeekStart(DateTextFieldConfig.Day value)

Day of the week start. 0 (Sunday) to 6 (Saturday)

Parameters:

value - the DateTextFieldConfig.Day the week starts

Returns:

this instance for chaining

allowKeyboardNavigation

public DateTextFieldConfig allowKeyboardNavigation(boolean value)

Whether or not to allow date navigation by arrow keys.

Parameters:

value - true, if keyboard navigation is allowed

Returns:

this instance for chaining

highlightToday

public DateTextFieldConfig highlightToday(boolean value)

If true, highlights the current date.

Parameters:

value - If true, highlights the current date.

Returns:

this instance for chaining

showTodayButton

public DateTextFieldConfig showTodayButton(boolean value)

If true, displays a "Today" button at the bottom of the datepicker to select the current date. If true, the "Today" button will only move the current date into view;

Parameters:

value - whether to show today button or not

Returns:

this instance for chaining

forceParse

public DateTextFieldConfig forceParse(boolean value)

Whether or not to force parsing of the input value when the picker is closed. That is, when an invalid date is left in the input field by the user, the picker will forcibly parse that value, and set the input's value to the new, valid date, conforming to the given format.

Parameters:

value - Whether or not to force parsing of the input value when the picker is closed

Returns:

this instance for chaining

autoClose

public DateTextFieldConfig autoClose(boolean value)

Whether or not to close the datepicker immediately when a date is selected.

Parameters:

value - true, if datepicker should close immediately when date is selected.

Returns:

this instance for chaining