com.hybris.cockpitng.editor.defaultdate

Class DefaultDateEditor

java.lang.Object

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

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

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

com.hybris.cockpitng.editor.defaultdate.DefaultDateEditor

All Implemented Interfaces:

CockpitEditorRenderer<Date>

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

Default Editor for Date values (incl. time).

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DATE_FORMAT
protected static String	DEFAULT_TIMEZONES
static String	DISABLE_INLINE_EDITING
static String	DISABLE_INLINE_EDITING_SCLASS
static String	DISPLAYED_TIME_ZONES
protected static String	SHOW_CALENDAR_ON_FOCUS
static String	TIME_ZONE_READ_ONLY
protected static 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

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
DefaultDateEditor()

Method Summary

Modifier and Type	Method and Description
protected Date	coerceFromString(org.zkoss.zul.impl.InputElement editorView, String text) Converts string value to a real value.
protected org.zkoss.zul.Datebox	createEditorView() Creates a view component.
protected 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	getDateTimeFormat(int dateStyle, int timeStyle)
protected String	getDisplayedTimeZones(EditorContext<Date> context)
protected String	getFormatConfigurationParameter() Defines a name of configuration parameter that stands for a date format.
protected List<TimeZone>	getTimeZones(String timeZonesString)
void	initTimeZone(org.zkoss.zul.Datebox box, EditorContext<Date> context)
protected void	initTimezoneManagement(org.zkoss.zul.Datebox box, EditorContext<Date> context) Deprecated. since 6.5, please use the initTimeZone(Datebox, EditorContext) instead.
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.
protected boolean	isInitialTimeZoneInDisplayedTimezones(String displayedTimeZonesString, TimeZone initialTimeZone)
protected boolean	isTimeZoneReadOnly(EditorContext<Date> context)
protected void	setTimeZone(org.zkoss.zul.Datebox box, TimeZone timeZone)
protected boolean	shouldInputBeDisabled(EditorContext<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 String TIME_ZONE_READ_ONLY

See Also:

Constant Field Values

DISPLAYED_TIME_ZONES

public static final String DISPLAYED_TIME_ZONES

See Also:

Constant Field Values

DISABLE_INLINE_EDITING

public static final String DISABLE_INLINE_EDITING

See Also:

Constant Field Values

DISABLE_INLINE_EDITING_SCLASS

public static final String DISABLE_INLINE_EDITING_SCLASS

See Also:

Constant Field Values

DATE_FORMAT

protected static final String DATE_FORMAT

See Also:

Constant Field Values

SHOW_CALENDAR_ON_FOCUS

protected static final String SHOW_CALENDAR_ON_FOCUS

See Also:

Constant Field Values

DEFAULT_TIMEZONES

protected static final String DEFAULT_TIMEZONES

See Also:

Constant Field Values

TIMEZONES_DELIMITER

protected static final 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 String getDateFormat(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 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 String getDateTimeFormat(int dateStyle,
                                   int timeStyle)

getFormatConfigurationParameter

protected 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<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 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<Date> context)

initTimeZone

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

Overrides:

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

initTimezoneManagement

@Deprecated
protected void initTimezoneManagement(org.zkoss.zul.Datebox box,
                                                  EditorContext<Date> context)

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

getDisplayedTimeZones

protected String getDisplayedTimeZones(EditorContext<Date> context)

coerceFromString

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

Description copied from class: AbstractTextBasedEditorRenderer

Converts string value to a real value.

Specified by:

coerceFromString in class AbstractTextBasedEditorRenderer<Date>

Parameters:

editorView - the underlying editor component

text - the string vale

Returns:

the value

setTimeZone

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

isTimeZoneReadOnly

protected boolean isTimeZoneReadOnly(EditorContext<Date> context)

isInitialTimeZoneInDisplayedTimezones

protected boolean isInitialTimeZoneInDisplayedTimezones(String displayedTimeZonesString,
                                                        TimeZone initialTimeZone)

getTimeZones

protected List<TimeZone> getTimeZones(String timeZonesString)