de.hybris.platform.hmc.attribute

Class DateTimeEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.DateTimeEditorChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

LongAsDateTimeEditorChip

public class DateTimeEditorChip
extends AbstractAttributeEditorChip
implements EventCheckingChip

Editor for values of type Date providing a layout for inputing the time and the date.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIVIDER
static String	SET_TIME_VALUE
static String	SET_VALUE

Fields inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

CUSTOM, DEFAULT_HEIGHT

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
DateTimeEditorChip(DisplayState displayState, Chip parent)
DateTimeEditorChip(DisplayState displayState, Chip parent, Date value)
DateTimeEditorChip(DisplayState displayState, Chip parent, Object value)

Method Summary

Modifier and Type	Method and Description
protected Object	convertValue(Object object) Override this method to convert the input value (e.g.
Set	getAcceptedEvents()
protected DateFormat	getDateOnlyFormat()
String	getDatePattern()
protected DateFormat	getDateTimeFormat()
Date	getDateValue()
int	getDateWidth() Returns the width of the date editor.
static String	getEditorType()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getScriptDateFormat()
String	getScriptTimeFormat()
String	getStringDateValue()
String	getStringTimeValue()
int	getTimeWidth() Returns the width of the time editor.
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isChanged() Overrides AbstractAttributeEditorChip.isChanged() to compensate for rounding errors.
boolean	isShowPattern()
boolean	isWrapValues() Returns true if the date and time editors should appear below each other.
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setParameters(Map parameters) Sets the parameters which where provided by the xml configuration.
void	setShowPattern(boolean showPattern)
void	setWrapValues(boolean wrap) Set to true if the date and time editors should appear below each other.

Methods inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getFieldID, getHeight, getInitialValue, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getProposedUniqueName, getValue, getWidth, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setValidValue, setValue, setWidth, valuesAreDifferent

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

addEventListener, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

SET_VALUE

public static final String SET_VALUE

See Also:

Constant Field Values

SET_TIME_VALUE

public static final String SET_TIME_VALUE

See Also:

Constant Field Values

DIVIDER

public static final String DIVIDER

See Also:

Constant Field Values

Constructor Detail

DateTimeEditorChip

public DateTimeEditorChip(DisplayState displayState,
                          Chip parent)

DateTimeEditorChip

public DateTimeEditorChip(DisplayState displayState,
                          Chip parent,
                          Date value)

DateTimeEditorChip

public DateTimeEditorChip(DisplayState displayState,
                          Chip parent,
                          Object value)

Method Detail

getDateValue

public Date getDateValue()

convertValue

protected Object convertValue(Object object)
                       throws Exception

Description copied from class: AbstractAttributeEditorChip

Override this method to convert the input value (e.g. Strings) into the desired editor value. It is possible to raise an error by throwing an execption. In that case the unconverted value is stored and the localized exception message is posted.

As default this method just passes the given value unchecked.

Overrides:

convertValue in class AbstractAttributeEditorChip

Parameters:

object - the unconverted value

Returns:

the converted value

Throws:

Exception - on any conversion error

See Also:

AbstractAttributeEditorChip.getLastInvalidValue()

getDateTimeFormat

protected DateFormat getDateTimeFormat()

getDateOnlyFormat

protected DateFormat getDateOnlyFormat()

getDatePattern

public String getDatePattern()

Since:

2.20

getStringTimeValue

public String getStringTimeValue()

Returns:

The time part of the value as string.

getStringDateValue

public String getStringDateValue()

Returns:

The date part of the value as string.

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

Specified by:

processEvents in interface Chip

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

Specified by:

getJSPURI in interface Chip

getScriptDateFormat

public String getScriptDateFormat()

getScriptTimeFormat

public String getScriptTimeFormat()

getEditorType

public static String getEditorType()

Returns:

the editor type of this chip.

isChanged

public boolean isChanged()

Overrides AbstractAttributeEditorChip.isChanged() to compensate for rounding errors.

Overrides:

isChanged in class AbstractAttributeEditorChip

Returns:

true if the value of this editor has been changed.

Since:

2.00

isWrapValues

public boolean isWrapValues()

Returns true if the date and time editors should appear below each other.

Returns:

true if the date and time editors should appear below each other

setWrapValues

public void setWrapValues(boolean wrap)

Set to true if the date and time editors should appear below each other.

Parameters:

wrap - true if the date and time editors should appear below each other.

getTimeWidth

public int getTimeWidth()

Returns the width of the time editor.

Returns:

the width of the time editor.

getDateWidth

public int getDateWidth()

Returns the width of the date editor.

Returns:

the width of the time editor.

isShowPattern

public boolean isShowPattern()

Since:

2.20 SP1

setShowPattern

public void setShowPattern(boolean showPattern)

Since:

2.20 SP1

setParameters

public void setParameters(Map parameters)

Description copied from class: AbstractAttributeEditorChip

Sets the parameters which where provided by the xml configuration.

Overrides:

setParameters in class AbstractAttributeEditorChip

Parameters:

parameters - the parameters which where provided by the xml configuration.

Since:

2.20 SP1

isAjaxUpdatable

public boolean isAjaxUpdatable()

Description copied from class: AbstractAttributeEditorChip

Returns true if this editor chip is ajax updatable. This is used in LocalizableAttributeChip to indicate that the editorchip's jsp only uses the usual form input elements and no other special functionality to update its values (like the wysiwyg editor which uses the 'onsubmit' handler to update its value).

Overrides:

isAjaxUpdatable in class AbstractAttributeEditorChip