de.hybris.platform.hmc.attribute

Class NumberEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.StringLayoutChip

de.hybris.platform.hmc.attribute.NumberEditorChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

BigDecimalEditorChip, ByteEditorChip, DoubleEditorChip, FloatEditorChip, IntegerEditorChip, LongEditorChip, ShortEditorChip

public abstract class NumberEditorChip
extends StringLayoutChip

Editor for values of type Double.

See Also:

Serialized Form

Field Summary

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

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
NumberEditorChip(DisplayState displayState, Chip parent)
NumberEditorChip(DisplayState displayState, Chip parent, boolean isPercent) Deprecated. please use NumberEditorChip(DisplayState, Chip)
NumberEditorChip(DisplayState displayState, Chip parent, boolean isPercent, Object value) Deprecated. please use NumberEditorChip(DisplayState, Chip, Object)
NumberEditorChip(DisplayState displayState, Chip parent, Object value)

Method Summary

Modifier and Type	Method and Description
protected Object	convertValue(Object value) Overrides super implementation of convert() to avoid setting of new values which are equal to the current value in respect to the given fraction digits.
protected NumberFormat	getNumberFormat() Returns the numberformat for this chip.
String	getNumberPattern()
boolean	isChanged() Returns true if this editor is editable and the value of this editor has been changed.
void	setNumberFormat(NumberFormat numberFormat) Sets a specific NumberFormat.
void	setNumberPattern(String numberPattern)
void	setParameters(Map parameters) Sets the parameters which where provided by the xml configuration.

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

getAcceptedEvents, getJSPURI, getQuotedStringValue, getStringValue, isAjaxUpdatable, isAlignRight, isDBEncrypted, isEncoded, parse, processEvents, setAlignRight, setEncoded, toString

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

Constructor Detail

NumberEditorChip

public NumberEditorChip(DisplayState displayState,
                        Chip parent)

Parameters:

displayState -

parent -

Since:

2.20

NumberEditorChip

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

Parameters:

displayState -

parent -

value -

Since:

2.20

NumberEditorChip

@Deprecated
public NumberEditorChip(DisplayState displayState,
                                    Chip parent,
                                    boolean isPercent)

Deprecated. please use NumberEditorChip(DisplayState, Chip)

NumberEditorChip

@Deprecated
public NumberEditorChip(DisplayState displayState,
                                    Chip parent,
                                    boolean isPercent,
                                    Object value)

Deprecated. please use NumberEditorChip(DisplayState, Chip, Object)

Method Detail

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

Sets a specific NumberFormat.
NumberFormats explicitly set using this method will be preferred to any number pattern settings via setNumberPattern(String)!

Parameters:

numberFormat - The NumberFormat to use for this chip

Since:

3.00 (beta1)

getNumberFormat

protected NumberFormat getNumberFormat()

Returns the numberformat for this chip. If a NumberFormat was set using setNumberFormat(NumberFormat) this will be returned. Otherwise a NumberFormat according to the current number pattern will be returned (see setNumberPattern(String).

isChanged

public boolean isChanged()

Description copied from class: AbstractAttributeEditorChip

Returns true if this editor is editable and the value of this editor has been changed.
Usually that is the case if the initial value differs from the current value.
Sometimes it might be desirable to handle special cases differently, e.g. if you want empty strings to be considered equal to an initial null value. In such a case you should override this method in the appropriate editorchip to provide the correct behaviour!
Note: This method is only relevant for the gui to show that an item has been changed. It does not affect the saving process (i.e. if initial and current value differ, the new value will be saved even if this method claims them to be equal)!

Overrides:

isChanged in class AbstractAttributeEditorChip

Returns:

true if the value of this editor has been changed.

convertValue

protected Object convertValue(Object value)
                       throws Exception

Overrides super implementation of convert() to avoid setting of new values which are equal to the current value in respect to the given fraction digits.

Overrides:

convertValue in class StringLayoutChip

Parameters:

value - the unconverted value

Returns:

the converted value

Throws:

Exception - on any conversion error

See Also:

AbstractAttributeEditorChip.getLastInvalidValue()

getNumberPattern

public String getNumberPattern()

Since:

2.20

setNumberPattern

public void setNumberPattern(String numberPattern)

Since:

2.20

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 StringLayoutChip

Parameters:

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