org.dominokit.domino.ui.datepicker

Class DateBox

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.forms.BasicFormElement<T,V>

org.dominokit.domino.ui.forms.ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

org.dominokit.domino.ui.datepicker.DateBox

All Implemented Interfaces:

FormElement<DateBox,Date>, HasGrouping<DateBox>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,DateBox,DateBox>, Focusable<DateBox>, HasAutoValidation<DateBox>, HasChangeHandlers<DateBox,Date>, HasChildren<DateBox>, HasHelperText<DateBox>, HasLabel<DateBox>, HasName<DateBox>, HasPlaceHolder<DateBox>, HasValidation<DateBox>, HasValue<DateBox,Date>, HasWavesElement, IsCollapsible<DateBox>, IsReadOnly<DateBox>, IsRequired<DateBox>, Switchable<DateBox>, org.gwtproject.editor.client.Editor<Date>, org.gwtproject.editor.client.HasEditorErrors<Date>, org.gwtproject.editor.client.LeafValueEditor<Date>, org.gwtproject.editor.client.TakesValue<Date>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

public class DateBox
extends ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

An text box for representing a Date which opens DatePicker when selecting it.

This component provides either selecting the date using the DatePicker or typing the date based on the pattern configured to convert it to a valid Date object

For example:

     DateBox.create("Birth date").setPattern("yyyy/MM/dd")

     DateBox.create("Birth date", new Date(), new DateTimeFormatInfoImpl_fr())

     DateBox.create("Birth date")
             .setPopoverPosition(PopupPosition.TOP)
             .setPickerStyle(DateBox.PickerStyle.POPOVER)
 

See Also:

ValueBox, DatePicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateBox.Pattern A predefined patterns for the date
static class	DateBox.PickerStyle The style of the date picker

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.ValueBox

ValueBox.AutoValidate, ValueBox.AutoValidator

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement

BasicFormElement.FieldHandler<T>

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasChangeHandlers

HasChangeHandlers.ChangeHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

Fields inherited from class org.dominokit.domino.ui.forms.ValueBox

changeHandlers, changeListener, DISABLED, fieldContainer, fieldGroup, FLOATING, FOCUSED, inputContainer, inputListener

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
DateBox()
DateBox(Date date)
DateBox(String label)
DateBox(String label, Date date)
DateBox(String label, Date date, Date minDate, Date maxDate)
DateBox(String label, Date date, org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo)
DateBox(String label, Date date, org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo, Date minDate, Date maxDate)

Method Summary

Modifier and Type	Method and Description
protected void	clearValue(boolean silent) clear the field value
void	close()
static DateBox	create() Creates date box with no label
static DateBox	create(Date date) Creates date box with a Date
static DateBox	create(String label) Creates date box with a label
static DateBox	create(String label, Date date) Creates date box with label and Date
static DateBox	create(String label, Date date, org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo) Creates date box with label, Date and a date time format
protected ValueBox.AutoValidator	createAutoValidator(ValueBox.AutoValidate autoValidate) Create an AutoValidator that will automatically validate the component when it loses focus
protected elemental2.dom.HTMLInputElement	createInputElement(String type) Creates an input element with the specified type
protected DominoElement<elemental2.dom.HTMLDivElement>	createMandatoryAddOn()
DateBox	disable()
protected void	doSetValue(Date value)
DateBox	enable()
MdiIcon	getCalendarIcon()
DominoElement<elemental2.dom.HTMLDivElement>	getCalendarIconContainer()
DatePicker	getDatePicker()
Formatter	getFormatter()
Optional<ModalDialog>	getModal()
Optional<Popover>	getPopover()
String	getStringValue()
Date	getValue()
boolean	isEmpty()
boolean	isEmptyIgnoreSpaces()
boolean	isOpenOnClick()
void	open() Opens the date picker based on the DateBox.PickerStyle defined
DateBox	openOnFocus() Opens the date picker when the element is focused
DateBox	setFormatter(Formatter formatter) Set a custom Formatter to use with this DateBox
DateBox	setInvalidFormatMessage(String invalidFormatMessage) Sets the error message when the date is not well formatted
DateBox	setOpenOnClick(boolean openOnClick) Sets if the date picker should be opened when clicking on the field
DateBox	setParseStrict(boolean parseStrict) Parse strict means that if the value is not valid, then an exception will be thrown, otherwise the value will wrapped around as needed
DateBox	setPattern(DateBox.Pattern pattern) Sets the DateBox.Pattern of the field
DateBox	setPattern(String pattern) Sets a custom pattern.
DateBox	setPickerStyle(DateBox.PickerStyle pickerStyle) Sets the DateBox.PickerStyle
DateBox	setPlaceholder(String placeholder)
DateBox	setPopoverPosition(PopupPosition popoverPosition) Sets the position of the model if the DateBox.PickerStyle is DateBox.PickerStyle.POPOVER
DateBox	setReadOnly(boolean readOnly) set the readonly attribute value

Methods inherited from class org.dominokit.domino.ui.forms.ValueBox

addChangeHandler, addLeftAddOn, addLeftAddOn, addLeftAddOn, addOnClearHandler, addRightAddOn, addRightAddOn, addRightAddOn, allowEmptyLabel, asTableField, autoValidate, callChangeHandlers, changeLabelFloating, clear, clear, clearInvalid, clearValue, condense, createLabelElement, doFocus, doUnfocus, element, floating, floatLabel, focus, getAdditionalInfoContainer, getCountItem, getErrorItem, getErrorsContainer, getFieldContainer, getFieldGroup, getFieldInputContainer, getFieldStyle, getFocusColor, getHelperContainer, getHelpItem, getInputContainer, getInputElement, getLabelElement, getLabelTextElement, getLeftAddonContainer, getLeftAddOnsContainer, getMandatoryAddOn, getNotesContainer, getOnClearHandlers, getPlaceholder, getPostfix, getPostFixItem, getPrefix, getPrefixItem, getRightAddonContainer, getRightAddOnsContainer, hasChangeHandler, hideLabelText, hidePlaceholder, invalidate, invalidate, isAddFocusColor, isAutoValidation, isFloating, isFocused, isReadOnly, linkLabelToField, nonfloating, onEnterKey, pauseChangeHandlers, pauseFocusValidation, removeChangeHandler, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOns, removeOnClearHandler, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOns, resumeChangeHandlers, resumeFocusValidation, setAutoValidation, setFieldStyle, setFixErrorsPosition, setFloating, setFocusColor, setLabel, setLabel, setLabel, setLabel, setLabelTextVisible, setPauseChangeHandlers, setPostFix, setPrefix, setSpellCheck, setTableField, shouldShowPlaceholder, showLabelText, showPlaceholder, spread, unfloatLabel, unfocus, updateLabel, value, value

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement

addValidator, getErrorLabels, getErrors, getHelperText, getLabel, getName, getRequiredErrorMessage, groupBy, hasValidator, isDisabled, isEnabled, isFixErrorsPosition, isRequired, isShowRequiredIndicator, isValidationDisabled, makeErrorLabel, removeValidator, setHelperText, setName, setRequired, setRequired, setRequiredErrorMessage, setShowRequiredIndicator, setValidationDisabled, setValue, showErrors, ungroup, validate, withValidationDisabled

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isEmptyElement, isEqualNode, isForceHidden, isHidden, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation

validateAll

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

DateBox

public DateBox()

DateBox

public DateBox(String label)

DateBox

public DateBox(Date date)

DateBox

public DateBox(String label,
               Date date)

DateBox

public DateBox(String label,
               Date date,
               Date minDate,
               Date maxDate)

DateBox

public DateBox(String label,
               Date date,
               org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo)

DateBox

public DateBox(String label,
               Date date,
               org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo,
               Date minDate,
               Date maxDate)

Method Detail

close

public void close()

create

public static DateBox create()

Creates date box with no label

Returns:

new instance

create

public static DateBox create(String label)

Creates date box with a label

Parameters:

label - the field label

Returns:

new instance

create

public static DateBox create(Date date)

Creates date box with a Date

Parameters:

date - the field value

Returns:

new instance

create

public static DateBox create(String label,
                             Date date)

Creates date box with label and Date

Parameters:

label - the field label

date - the field value

Returns:

new instance

create

public static DateBox create(String label,
                             Date date,
                             org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo dateTimeFormatInfo)

Creates date box with label, Date and a date time format

Parameters:

label - the field label

date - the field value

dateTimeFormatInfo - the DateTimeFormatInfo

Returns:

new instance

setParseStrict

public DateBox setParseStrict(boolean parseStrict)

Parse strict means that if the value is not valid, then an exception will be thrown, otherwise the value will wrapped around as needed

Parameters:

parseStrict - true to enable parse strict

Returns:

same instance

See Also:

DateTimeFormat.parseStrict(String), DateTimeFormat.parse(String)

setPattern

public DateBox setPattern(DateBox.Pattern pattern)

Sets the DateBox.Pattern of the field

Parameters:

pattern - the new DateBox.Pattern

Returns:

same instance

setPattern

public DateBox setPattern(String pattern)

Sets a custom pattern.

More information of defining the pattern can be found under GWT DateTimeFormat

Parameters:

pattern - the new pattern

Returns:

same instance

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasGrouping<DateBox>

Overrides:

isEmpty in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

boolean, true if the component value is empty

isEmptyIgnoreSpaces

public boolean isEmptyIgnoreSpaces()

Specified by:

isEmptyIgnoreSpaces in interface HasGrouping<DateBox>

Overrides:

isEmptyIgnoreSpaces in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

boolean, true if the component value is empty after trimming spaces

clearValue

protected void clearValue(boolean silent)

clear the field value

Specified by:

clearValue in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

doSetValue

protected void doSetValue(Date value)

Specified by:

doSetValue in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Parameters:

value - V the value to set for this field

getValue

public Date getValue()

Specified by:

getValue in interface org.gwtproject.editor.client.LeafValueEditor<Date>

Specified by:

getValue in interface org.gwtproject.editor.client.TakesValue<Date>

Overrides:

getValue in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

createInputElement

protected elemental2.dom.HTMLInputElement createInputElement(String type)

Description copied from class: ValueBox

Creates an input element with the specified type

Specified by:

createInputElement in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Parameters:

type - String the input element type

Returns:

E the input html element

setPlaceholder

public DateBox setPlaceholder(String placeholder)

Specified by:

setPlaceholder in interface HasPlaceHolder<DateBox>

Overrides:

setPlaceholder in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Parameters:

placeholder - String placeholder

Returns:

same implementing class instance

setPickerStyle

public DateBox setPickerStyle(DateBox.PickerStyle pickerStyle)

Sets the DateBox.PickerStyle

Parameters:

pickerStyle - the new DateBox.PickerStyle

Returns:

same instance

getDatePicker

public DatePicker getDatePicker()

Returns:

The DatePicker

setPopoverPosition

public DateBox setPopoverPosition(PopupPosition popoverPosition)

Sets the position of the model if the DateBox.PickerStyle is DateBox.PickerStyle.POPOVER

Parameters:

popoverPosition - the new PopupPosition

Returns:

same instance

openOnFocus

public DateBox openOnFocus()

Opens the date picker when the element is focused

Returns:

same instance

open

public void open()

Opens the date picker based on the DateBox.PickerStyle defined

disable

public DateBox disable()

Specified by:

disable in interface Switchable<DateBox>

Overrides:

disable in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

same implementing component

setReadOnly

public DateBox setReadOnly(boolean readOnly)

set the readonly attribute value

Specified by:

setReadOnly in interface IsReadOnly<DateBox>

Overrides:

setReadOnly in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Parameters:

readOnly - boolean, if true switch the component to readonly mode, otherwise switch out off readonly mode

Returns:

same instance of the implementing class

enable

public DateBox enable()

Specified by:

enable in interface Switchable<DateBox>

Overrides:

enable in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

same implementing component

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface HasInputElement

Overrides:

getStringValue in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

String value of the input element

createMandatoryAddOn

protected DominoElement<elemental2.dom.HTMLDivElement> createMandatoryAddOn()

Overrides:

createMandatoryAddOn in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Returns:

the FlexItem that contains the mandatory addons

getCalendarIconContainer

public DominoElement<elemental2.dom.HTMLDivElement> getCalendarIconContainer()

Returns:

The calendar icon container element

getCalendarIcon

public MdiIcon getCalendarIcon()

Returns:

The calendar icon element

createAutoValidator

protected ValueBox.AutoValidator createAutoValidator(ValueBox.AutoValidate autoValidate)

Create an AutoValidator that will automatically validate the component when it loses focus

Specified by:

createAutoValidator in class ValueBox<DateBox,elemental2.dom.HTMLInputElement,Date>

Parameters:

autoValidate - ValueBox.AutoValidate

Returns:

same component instance

setInvalidFormatMessage

public DateBox setInvalidFormatMessage(String invalidFormatMessage)

Sets the error message when the date is not well formatted

Parameters:

invalidFormatMessage - the new message

Returns:

same instance

getModal

public Optional<ModalDialog> getModal()

Returns:

The ModalDialog of the date picker

getPopover

public Optional<Popover> getPopover()

Returns:

The Popover of the date picker

isOpenOnClick

public boolean isOpenOnClick()

Returns:

true if the date picker should be opened when clicking on the field, false otherwise

setOpenOnClick

public DateBox setOpenOnClick(boolean openOnClick)

Sets if the date picker should be opened when clicking on the field

Parameters:

openOnClick - true to open the date picker when clicking on the field

Returns:

same instance

getFormatter

public Formatter getFormatter()

Returns:

Formatter

setFormatter

public DateBox setFormatter(Formatter formatter)

Set a custom Formatter to use with this DateBox

Parameters:

formatter - Formatter

Returns:

same datebox instance