Package com.flowingcode.vaadin.addons.cronexpressionfield

Class CronExpressionField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<CustomField<T>,T>

com.vaadin.flow.component.customfield.CustomField<String>

com.flowingcode.vaadin.addons.cronexpressionfield.CronExpressionField

All Implemented Interfaces:

AttachNotifier, BlurNotifier<CustomField<String>>, DetachNotifier, Focusable<CustomField<String>>, FocusNotifier<CustomField<String>>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<CustomField<String>,String>,String>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<CustomField<String>,String>,String>, HasTooltip, HasValidationProperties, InputField<AbstractField.ComponentValueChangeEvent<CustomField<String>,String>,String>, Serializable

@CssImport("./styles/cron-expression-field-styles.css")
public class CronExpressionField
extends CustomField<String>

UI component for building cron expressions.

Author:

Sofia Nuñez / Flowing Code

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	CronExpressionField.Units

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

AbstractField.ComponentValueChangeEvent<C extends Component,V extends Object>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

BlurNotifier.BlurEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

FocusNotifier.FocusEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

HasValue.ValueChangeEvent<V extends Object>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
CronExpressionField()	Creates a new instance of CronExpressionField
CronExpressionField(String defaultExpression)	Creates a new instance of CronExpressionField with a default expression.

Method Summary

Modifier and Type	Method	Description
boolean	addCommonExpressions(String... crons)	Sets a list of cron expressions to be displayed if setCommonExpressionsVisible is enabled.
protected String	generateModelValue()
void	setCommonExpressionsVisible(boolean commonExpressionsVisible)	Sets visible a ComboBox with common expressions.
void	setCronInputEnabled(boolean isEnabled)	Enables or disables user input for the cron expression text field.
boolean	setDefaultExpression(String cron)	Allows the developer to set a default expression.
void	setHelpEnabled(boolean helpEnabled)	Sets whether the UI components get a tooltip with helper text for the user.
void	setI18n(CronExpressionFieldI18n i18n)	Sets the internationalization settings for the field.
void	setLocale(Locale locale)	Sets the Locale for this component.
void	setNextDatesButtonVisible(boolean nextDatesVisible)	Displays a button that generates a grid with the next dates scheduled by the generated cron expression.
protected void	setPresentationValue(String newPresentationValue)

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, onAttach, remove, removeThemeVariants, setLabel, updateValue

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.HasValidation

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Constructor Details

CronExpressionField

public CronExpressionField()

Creates a new instance of CronExpressionField

CronExpressionField

public CronExpressionField(String defaultExpression)

Creates a new instance of CronExpressionField with a default expression.

Parameters:

defaultExpression - a String representing the default cron expression to be set

Method Details

setCronInputEnabled

public void setCronInputEnabled(boolean isEnabled)

Enables or disables user input for the cron expression text field.

Parameters:

isEnabled - a boolean to set the editing mode of the cron expression TextField

setNextDatesButtonVisible

public void setNextDatesButtonVisible(boolean nextDatesVisible)

Displays a button that generates a grid with the next dates scheduled by the generated cron expression.

Parameters:

nextDatesVisible - a boolean to set the visibility of the button

setDefaultExpression

public boolean setDefaultExpression(String cron)

Allows the developer to set a default expression.

Parameters:

cron - a String representing the expression to be set as default

Returns:

a boolean indicating if the expression is valid or not

addCommonExpressions

public boolean addCommonExpressions(String... crons)

Sets a list of cron expressions to be displayed if setCommonExpressionsVisible is enabled.

The method validates the cron expressions to be added.

Parameters:

crons - one or more strings of cron expressions to be validated

Returns:

a boolean indicating if all the cron expressions pass the validation

setCommonExpressionsVisible

public void setCommonExpressionsVisible(boolean commonExpressionsVisible)

Sets visible a ComboBox with common expressions.

When set, a combobox with previously set cron expressions is displayed inside the advanced mode layout allowing the user to choose from one of them.

Parameters:

commonExpressionsVisible - a boolean indicating if the ComboBox is displayed or not

setHelpEnabled

public void setHelpEnabled(boolean helpEnabled)

Sets whether the UI components get a tooltip with helper text for the user.

Parameters:

helpEnabled - a boolean indicating if the tooltip is displayed or not

generateModelValue

protected String generateModelValue()

Specified by:

generateModelValue in class CustomField<String>

setPresentationValue

protected void setPresentationValue(String newPresentationValue)

Specified by:

setPresentationValue in class CustomField<String>

setLocale

public void setLocale(Locale locale)

Sets the Locale for this component.

Parameters:

locale - the Locale to be used

setI18n

public void setI18n(CronExpressionFieldI18n i18n)

Sets the internationalization settings for the field.

If i18n is null, default internationalization to english.

Parameters:

i18n - the CronExpressionFieldI18n to use, or null for default