Package com.hybris.cockpitng.editor.defaultdate

Class DefaultDateEditor

java.lang.Object

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

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

com.hybris.cockpitng.editor.defaultdate.AbstractDateTimeEditor<org.zkoss.zul.Datebox>

com.hybris.cockpitng.editor.defaultdate.DefaultDateEditor

All Implemented Interfaces:

CockpitEditorRenderer<java.util.Date>

public class DefaultDateEditor
extends AbstractDateTimeEditor<org.zkoss.zul.Datebox>

Default Editor for Date values (incl. time).

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	DATE_FORMAT
protected static java.lang.String	DEFAULT_TIMEZONES
static java.lang.String	DISABLE_INLINE_EDITING
static java.lang.String	DISABLE_INLINE_EDITING_SCLASS
static java.lang.String	DISPLAYED_TIME_ZONES
protected static java.lang.String	SHOW_CALENDAR_ON_FOCUS
static java.lang.String	TIME_ZONE_READ_ONLY
protected static java.lang.String	TIMEZONES_DELIMITER

Fields inherited from class com.hybris.cockpitng.editor.defaultdate.AbstractDateTimeEditor

DATE_FORMAT_NONE, 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, YW_EDITOR_AREA_LABEL_CONTAINER

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
DefaultDateEditor()

Method Summary

Modifier and Type	Method	Description
protected java.util.Date	coerceFromString(org.zkoss.zul.impl.InputElement editorView, java.lang.String text)	Converts string value to a real value.
protected org.zkoss.zul.Datebox	createEditorView()	Creates a view component.
protected java.lang.String	getDateFormat(int dateStyle)	Determines a format string for specified format style (see: DateFormat)
protected java.lang.String	getDateFormat(java.lang.String dateFormatInput)	Determines the date format for the component.
protected java.lang.String	getDateTimeFormat(int dateStyle, int timeStyle)
protected java.lang.String	getDisplayedTimeZones(EditorContext<java.util.Date> context)
protected java.lang.String	getFormatConfigurationParameter()	Defines a name of configuration parameter that stands for a date format.
protected java.util.List<java.util.TimeZone>	getTimeZones(java.lang.String timeZonesString)
void	initTimeZone(org.zkoss.zul.Datebox box, EditorContext<java.util.Date> context)
protected void	initTimezoneManagement(org.zkoss.zul.Datebox box, EditorContext<java.util.Date> context)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5, please use the initTimeZone(Datebox, EditorContext) instead.
protected void	initViewComponent(org.zkoss.zul.impl.InputElement editorView, EditorContext<java.util.Date> context, EditorListener<java.util.Date> listener)	Adds event listeners to this editor component, parses the parameter for initial value etc.
protected boolean	isInitialTimeZoneInDisplayedTimezones(java.lang.String displayedTimeZonesString, java.util.TimeZone initialTimeZone)
protected boolean	isTimeZoneReadOnly(EditorContext<java.util.Date> context)
protected void	setTimeZone(org.zkoss.zul.Datebox box, java.util.TimeZone timeZone)
protected boolean	shouldInputBeDisabled(EditorContext<java.util.Date> context)

Methods inherited from class com.hybris.cockpitng.editor.defaultdate.AbstractDateTimeEditor

getDateFormat, getDefaultDateFormat, getDefaultDateFormat, getInitialTimeZoneFromConfig, getPatternDateFormat, getRawValue, getRequiredStyle, getSessionTimeZoneAttribute, getZKDefaultTimeZone, handleReadOnly, render, setRawValue

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

clearInvalidInputAndNotify, 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

TIME_ZONE_READ_ONLY

public static final java.lang.String TIME_ZONE_READ_ONLY

See Also:

Constant Field Values

DISPLAYED_TIME_ZONES

public static final java.lang.String DISPLAYED_TIME_ZONES

See Also:

Constant Field Values

DISABLE_INLINE_EDITING

public static final java.lang.String DISABLE_INLINE_EDITING

See Also:

Constant Field Values

DISABLE_INLINE_EDITING_SCLASS

public static final java.lang.String DISABLE_INLINE_EDITING_SCLASS

See Also:

Constant Field Values

DATE_FORMAT

protected static final java.lang.String DATE_FORMAT

See Also:

Constant Field Values

SHOW_CALENDAR_ON_FOCUS

protected static final java.lang.String SHOW_CALENDAR_ON_FOCUS

See Also:

Constant Field Values

DEFAULT_TIMEZONES

protected static final java.lang.String DEFAULT_TIMEZONES

See Also:

Constant Field Values

TIMEZONES_DELIMITER

protected static final java.lang.String TIMEZONES_DELIMITER

See Also:

Constant Field Values

Constructor Detail

DefaultDateEditor

public DefaultDateEditor()

Method Detail

createEditorView

protected org.zkoss.zul.Datebox createEditorView()

Description copied from class: AbstractDateTimeEditor

Creates a view component.

Specified by:

createEditorView in class AbstractDateTimeEditor<org.zkoss.zul.Datebox>

Returns:

view component

getDateFormat

protected java.lang.String getDateFormat(java.lang.String dateFormatInput)

Description copied from class: AbstractDateTimeEditor

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

Overrides:

getDateFormat in class AbstractDateTimeEditor<org.zkoss.zul.Datebox>

Parameters:

dateFormatInput - the configured date format

Returns:

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

getDateFormat

protected java.lang.String getDateFormat(int dateStyle)

Description copied from class: AbstractDateTimeEditor

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

Specified by:

getDateFormat in class AbstractDateTimeEditor<org.zkoss.zul.Datebox>

Parameters:

dateStyle - format style

Returns:

format string

getDateTimeFormat

protected java.lang.String getDateTimeFormat(int dateStyle,
                                             int timeStyle)

getFormatConfigurationParameter

protected java.lang.String getFormatConfigurationParameter()

Description copied from class: AbstractDateTimeEditor

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

Specified by:

getFormatConfigurationParameter in class AbstractDateTimeEditor<org.zkoss.zul.Datebox>

Returns:

name of configuration parameter

initViewComponent

protected void initViewComponent(org.zkoss.zul.impl.InputElement editorView,
                                 EditorContext<java.util.Date> context,
                                 EditorListener<java.util.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 AbstractDateTimeEditor<org.zkoss.zul.Datebox>

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

shouldInputBeDisabled

protected boolean shouldInputBeDisabled(EditorContext<java.util.Date> context)

initTimeZone

public void initTimeZone(org.zkoss.zul.Datebox box,
                         EditorContext<java.util.Date> context)

Overrides:

initTimeZone in class AbstractDateTimeEditor<org.zkoss.zul.Datebox>

initTimezoneManagement

@Deprecated(since="6.5",
            forRemoval=true)
protected void initTimezoneManagement(org.zkoss.zul.Datebox box,
                                      EditorContext<java.util.Date> context)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5, please use the initTimeZone(Datebox, EditorContext) instead.

getDisplayedTimeZones

protected java.lang.String getDisplayedTimeZones(EditorContext<java.util.Date> context)

coerceFromString

protected java.util.Date coerceFromString(org.zkoss.zul.impl.InputElement editorView,
                                          java.lang.String text)

Description copied from class: AbstractTextBasedEditorRenderer

Converts string value to a real value.

Specified by:

coerceFromString in class AbstractTextBasedEditorRenderer<java.util.Date>

Parameters:

editorView - the underlying editor component

text - the string vale

Returns:

the value

setTimeZone

protected void setTimeZone(org.zkoss.zul.Datebox box,
                           java.util.TimeZone timeZone)

isTimeZoneReadOnly

protected boolean isTimeZoneReadOnly(EditorContext<java.util.Date> context)

isInitialTimeZoneInDisplayedTimezones

protected boolean isInitialTimeZoneInDisplayedTimezones(java.lang.String displayedTimeZonesString,
                                                        java.util.TimeZone initialTimeZone)

getTimeZones

protected java.util.List<java.util.TimeZone> getTimeZones(java.lang.String timeZonesString)