de.hybris.platform.hmc.attribute

Class TimePeriodEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.TimePeriodEditorChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

public class TimePeriodEditorChip
extends AbstractAttributeEditorChip
implements EventCheckingChip

Editor for values of type Date providing a layout for inputting the time only.

Since:

2.30

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_TIME_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
TimePeriodEditorChip(DisplayState displayState, Chip parent)
TimePeriodEditorChip(DisplayState displayState, Chip parent, Date value)
TimePeriodEditorChip(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()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getScriptTimeFormat()
String	getStringValue()
protected DateFormat	getTimeOnlyFormat()
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()
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)

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

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getEditorType, 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_TIME_VALUE

public static final String SET_TIME_VALUE

See Also:

Constant Field Values

Constructor Detail

TimePeriodEditorChip

public TimePeriodEditorChip(DisplayState displayState,
                            Chip parent)

TimePeriodEditorChip

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

TimePeriodEditorChip

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

Method Detail

getStringValue

public String getStringValue()

Returns:

A string representation of the date according to the current system locale.

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()

getTimeOnlyFormat

protected DateFormat getTimeOnlyFormat()

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

getScriptTimeFormat

public String getScriptTimeFormat()

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.

getTimeWidth

public int getTimeWidth()

Returns the width of the time editor.

Returns:

the width of the time editor.

isShowPattern

public boolean isShowPattern()

setShowPattern

public void setShowPattern(boolean showPattern)

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.

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