com.hybris.cockpitng.editor.defaultdate

Class AbstractDateTimeEditor<C extends org.zkoss.zul.impl.FormatInputElement>

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<T>

com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer<Date>

com.hybris.cockpitng.editor.defaultdate.AbstractDateTimeEditor<C>

All Implemented Interfaces:

CockpitEditorRenderer<Date>

Direct Known Subclasses:

DefaultDateEditor, DefaultTimeEditor

public abstract class AbstractDateTimeEditor<C extends org.zkoss.zul.impl.FormatInputElement>
extends AbstractTextBasedEditorRenderer<Date>

Abstract Editor for Date values.

Abstraction is made to extract all methods independent from whether a component is used as input for date only ( Datebox), time only (Timebox) or both (Datebox).

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DATE_FORMAT_NONE
static String	SELECTED_TIME_ZONE

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer

SETTING_INPUT_INSTANT

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT

Fields inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
AbstractDateTimeEditor()

Method Summary

Modifier and Type	Method and Description
protected abstract C	createEditorView() Creates a view component.
protected String	getDateFormat(C datebox, EditorContext<Date> context) Gets format string from configuration.
protected abstract String	getDateFormat(int dateStyle) Determines a format string for specified format style (see: DateFormat)
protected String	getDateFormat(String dateFormatInput) Determines the date format for the component.
protected String	getDefaultDateFormat(C datebox) Returns default date format.
protected Optional<Integer>	getDefaultDateFormat(String formatInput)
protected abstract String	getFormatConfigurationParameter() Defines a name of configuration parameter that stands for a date format.
protected TimeZone	getInitialTimeZoneFromConfig(EditorContext<Date> context)
protected Optional<String>	getPatternDateFormat(String formatInput)
protected Date	getRawValue(org.zkoss.zul.impl.InputElement viewComponent) Extracts value of the given editor component.
protected int	getRequiredStyle(int style) Checks if provided style is an actual style or points to DATE_FORMAT_NONE.
protected TimeZone	getSessionTimeZoneAttribute()
protected TimeZone	getZKDefaultTimeZone()
protected void	handleReadOnly(EditorContext<Date> context, org.zkoss.zul.impl.InputElement editorView) In case of dateTimeEditor we have to override standard implementation of handleReadOnly.
void	initTimeZone(C box, EditorContext<Date> context)
protected void	initViewComponent(org.zkoss.zul.impl.InputElement editorView, EditorContext<Date> context, EditorListener<Date> listener) Adds event listeners to this editor component, parses the parameter for initial value etc.
void	render(org.zkoss.zk.ui.Component parent, EditorContext<Date> context, EditorListener<Date> listener) Creates a new editor component and attaches it to the specified Component component.
protected void	setRawValue(org.zkoss.zul.impl.InputElement viewComponent, Date rawValue) Sets the value to the given editor component.

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer

clearInvalidInputAndNotify, coerceFromString, handleChangeEvent, handleChangeEvent, handleChangingEvent, hasInvalidInput, isPrimitive, onCancelEvent, onChangeEvent, onChangingEvent, onFocusEvent, onOkEvent

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

extractEmbeddedEditor, extractEmbeddedType, findAncestorEditor, findEmbeddedEditors, getInitialEditString, getL10nDecorator

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_TIME_ZONE

public static final String SELECTED_TIME_ZONE

See Also:

Constant Field Values

DATE_FORMAT_NONE

protected static final int DATE_FORMAT_NONE

See Also:

Constant Field Values

Constructor Detail

AbstractDateTimeEditor

public AbstractDateTimeEditor()

Method Detail

getDateFormat

protected abstract String getDateFormat(int dateStyle)

Determines a format string for specified format style (see: DateFormat)

Parameters:

dateStyle - format style

Returns:

format string

getRequiredStyle

protected int getRequiredStyle(int style)

Checks if provided style is an actual style or points to DATE_FORMAT_NONE.

Parameters:

style - date style to be checked

Returns:

style provided if not DATE_FORMAT_NONE, otherwise a default one

getDateFormat

protected String getDateFormat(String dateFormatInput)

Determines the date format for the component.

The given date format can be either a custom date format e. g. dd/MM/yyyy (see SimpleDateFormat) or the following constants for getting a localized date format:

• short
• medium
• long
• full

Parameters:

dateFormatInput - the configured date format

Returns:

date format string (DateFormat) for the component or null if format is invalid

getDefaultDateFormat

protected Optional<Integer> getDefaultDateFormat(String formatInput)

getPatternDateFormat

protected Optional<String> getPatternDateFormat(String formatInput)

getDefaultDateFormat

protected String getDefaultDateFormat(C datebox)

Returns default date format. Called if date format was not resolved by getDateFormat(String) method.

Parameters:

datebox -

Returns:

createEditorView

protected abstract C createEditorView()

Creates a view component.

Returns:

view component

getFormatConfigurationParameter

protected abstract String getFormatConfigurationParameter()

Defines a name of configuration parameter that stands for a date format.

Returns:

name of configuration parameter

getDateFormat

protected String getDateFormat(C datebox,
                               EditorContext<Date> context)

Gets format string from configuration.

Returned string should be compatible with SimpleDateFormat

Parameters:

datebox - component for which a format is requested

context - the context for the editor creation

Returns:

format string

handleReadOnly

protected void handleReadOnly(EditorContext<Date> context,
                              org.zkoss.zul.impl.InputElement editorView)

In case of dateTimeEditor we have to override standard implementation of handleReadOnly. readonly='true' allows user to change value by datepicker. Setting disabled='true' fixes this problem.

Overrides:

handleReadOnly in class AbstractTextBasedEditorRenderer<Date>

Parameters:

context -

editorView -

initViewComponent

protected void initViewComponent(org.zkoss.zul.impl.InputElement editorView,
                                 EditorContext<Date> context,
                                 EditorListener<Date> listener)

Description copied from class: AbstractTextBasedEditorRenderer

Adds event listeners to this editor component, parses the parameter for initial value etc.

Overrides:

initViewComponent in class AbstractTextBasedEditorRenderer<Date>

Parameters:

editorView - the editor component previously created in overridden method CockpitEditorRenderer.render(org.zkoss.zk.ui.Component, com.hybris.cockpitng.editors.EditorContext, com.hybris.cockpitng.editors.EditorListener)

context - the editor context

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<Date> context,
                   EditorListener<Date> listener)

Description copied from interface: CockpitEditorRenderer

Creates a new editor component and attaches it to the specified Component component.

Parameters:

parent - parent component the editor should be attached to

context - the context for the editor creation

listener - the listener to notify the rest of the world about value changes and other events

setRawValue

protected void setRawValue(org.zkoss.zul.impl.InputElement viewComponent,
                           Date rawValue)

Description copied from class: AbstractTextBasedEditorRenderer

Sets the value to the given editor component.

Specified by:

setRawValue in class AbstractTextBasedEditorRenderer<Date>

Parameters:

viewComponent - the underlying editor component

rawValue - the value

getRawValue

protected Date getRawValue(org.zkoss.zul.impl.InputElement viewComponent)

Description copied from class: AbstractTextBasedEditorRenderer

Extracts value of the given editor component.

Specified by:

getRawValue in class AbstractTextBasedEditorRenderer<Date>

Parameters:

viewComponent - the underlying editor component

Returns:

the value

initTimeZone

public void initTimeZone(C box,
                         EditorContext<Date> context)

getInitialTimeZoneFromConfig

protected TimeZone getInitialTimeZoneFromConfig(EditorContext<Date> context)

getSessionTimeZoneAttribute

protected TimeZone getSessionTimeZoneAttribute()

getZKDefaultTimeZone

protected TimeZone getZKDefaultTimeZone()