de.hybris.platform.hmc.attribute

Class AbstractAttributeEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AttributeDescriptor2BooleanMapEditorChip, BooleanEditorChip, DateOnlyDateRangeEditorChip, DateRangeEditorChip, DateTimeEditorChip, DefaultValueEditorChip, DiffTextDisplayChip, DiscountValueEditorChip, GenericListEditorChip, GenericReferenceListEditorChip, MapTypeEditorChip, NoAccessAttributeEditorChip, ObjectEditorChip, PartOfReferenceEditorChip, PlaceholderDisplayChip, ReferenceAttributeEditorChip, ReferenceMultiSelectEditorChip, SelectionOfCollectionReferenceEditorChip, SelectLayoutChip, StringLayoutChip, SubTypeSelectEditorChip, TaxValueEditorChip, TimePeriodEditorChip, VariantListEditorChip

public abstract class AbstractAttributeEditorChip
extends AbstractChip

Abstract super class of all editor chips. It defines some general attributes like isEditable() which will be redirected to the surrounding AttributeChip if there is one, or default values will be returned.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM String constant for custom editor type.
static int	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
AbstractAttributeEditorChip(DisplayState displayState, Chip parent)
AbstractAttributeEditorChip(DisplayState displayState, Chip parent, Object value)

Method Summary

Modifier and Type	Method and Description
void	addAttributeValueChangeListener(AttributeValueChangeListener listener) Adds a AttributeValueChangeListener to this chip which will be notified if the value contained in this chip is changed.
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
protected void	clearError()
boolean	containsValidValue()
void	convertAndSetValue(Object value) Use this method to set this editor's value if any conversion or checking has to be done.
protected Object	convertValue(Object value) Override this method to convert the input value (e.g.
protected AttributeChip	getAttributeChip()
AttributeDescriptor	getAttributeDescriptor()
Set<AttributeValueChangeListener>	getAttributeValueChangeListeners()
static String	getEditorType() Implement this method in subclasses!!!
String	getFieldID() Returns the field id.
int	getHeight() Returns the (desired) height of this chip.
Object	getInitialValue()
Object	getLastInvalidValue()
int	getMaxLength()
Map<String,String>	getParameters() Returns the parameters which where provided by the xml configuration.
protected AbstractAttributeEditorChip	getParentEditorChip()
protected String	getProposedUniqueName()
Object	getValue()
int	getWidth()
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isChanged() Returns true if this editor is editable and the value of this editor has been changed.
boolean	isEditable()
boolean	isInitialized()
boolean	isOptional()
protected void	notifyAttributeValueChangeListeners(AttributeValueChangeEvent event) Notifies all AttributeValueChangeListener which have been registered with this editor chip.
void	removeAttributeValueChangeListener(AttributeValueChangeListener listener)
void	setAttributeDescriptor(AttributeDescriptor attributeDescriptor)
void	setEditable(boolean value)
protected void	setError(Exception exception, Object wrongValue)
void	setFieldID(String id) The field id is useful in editable tables.
void	setHeight(int newHeight) Sets the (desired) height of this chip.
void	setInitialValue(Object initialValue)
void	setMaxLength(int maxLength)
void	setOptional(boolean value)
void	setParameters(Map<String,String> map) Sets the parameters which where provided by the xml configuration.
protected void	setValidValue(boolean valid)
void	setValue(Object value)
void	setWidth(int width)
protected boolean	valuesAreDifferent(Object value1, Object value2)

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

getJSPURI, processEvents

Field Detail

CUSTOM

public static final String CUSTOM

String constant for custom editor type.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

AbstractAttributeEditorChip

public AbstractAttributeEditorChip(DisplayState displayState,
                                   Chip parent)

AbstractAttributeEditorChip

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

Method Detail

setFieldID

public void setFieldID(String id)

The field id is useful in editable tables. Each editor field there has an id. The id should be of the format y_x which enables the user to switch from field to field using ctrl+cursor keys.

getFieldID

public String getFieldID()

Returns the field id. See setFieldID(String) for details.

setWidth

public void setWidth(int width)

getWidth

public int getWidth()

getValue

public Object getValue()

convertAndSetValue

public void convertAndSetValue(Object value)

Use this method to set this editor's value if any conversion or checking has to be done. Override convertValue(Object) which is called within this method to implement the actual conversion logic.

If an error is raised during conversion the error message is posted, the editor marked as invalid and the value saved so that it may be used later via getLastInvalidValue(). The next successful setValue() operation will clear the error status and remove the invalid value.

Parameters:

value -

clearError

protected void clearError()

setError

protected void setError(Exception exception,
                        Object wrongValue)

setValue

public void setValue(Object value)

getAttributeValueChangeListeners

public Set<AttributeValueChangeListener> getAttributeValueChangeListeners()

Since:

3.00 (beta1)

addAttributeValueChangeListener

public void addAttributeValueChangeListener(AttributeValueChangeListener listener)

Adds a AttributeValueChangeListener to this chip which will be notified if the value contained in this chip is changed. More precisely it will always be notified when setValue(Object) is called with a different value than the previous value.

Since:

3.00 (beta1)

removeAttributeValueChangeListener

public void removeAttributeValueChangeListener(AttributeValueChangeListener listener)

Since:

3.00 (beta1)

notifyAttributeValueChangeListeners

protected void notifyAttributeValueChangeListeners(AttributeValueChangeEvent event)

Notifies all AttributeValueChangeListener which have been registered with this editor chip. This method will implicitly be called if setValue(Object) is called with a different value than the previous value. So usually you will not need to call this method yourself!

Since:

3.00 (beta1)

convertValue

protected Object convertValue(Object value)
                       throws Exception

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.

Parameters:

value - the unconverted value

Returns:

the converted value

Throws:

Exception - on any conversion error

See Also:

getLastInvalidValue()

getLastInvalidValue

public final Object getLastInvalidValue()

containsValidValue

public boolean containsValidValue()

setValidValue

protected void setValidValue(boolean valid)

isChanged

public boolean isChanged()

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

Returns:

true if the value of this editor has been changed.

Since:

2.00

valuesAreDifferent

protected boolean valuesAreDifferent(Object value1,
                                     Object value2)

Since:

3.10 (beta1)

isEditable

public boolean isEditable()

Returns:

AttributeChip.isEditable() or explicitely set value, if getAttributeChip() is NULL.

setEditable

public void setEditable(boolean value)

getAttributeChip

protected AttributeChip getAttributeChip()

Returns:

The AttributeChip as owner of this chip if its exists or NULL if not.

getParentEditorChip

protected AbstractAttributeEditorChip getParentEditorChip()

Returns:

The AbstractAttributeEditorChip as owner of this chip if its exists or NULL if not.

setOptional

public void setOptional(boolean value)

isOptional

public boolean isOptional()

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractChip

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

getInitialValue

public Object getInitialValue()

setInitialValue

public void setInitialValue(Object initialValue)

isInitialized

public boolean isInitialized()

getEditorType

public static String getEditorType()

Implement this method in subclasses!!!

Returns:

a string containing the editor type

getParameters

public Map<String,String> getParameters()

Returns the parameters which where provided by the xml configuration.

Returns:

the parameters which where provided by the xml configuration.

setParameters

public void setParameters(Map<String,String> map)

Sets the parameters which where provided by the xml configuration.

Parameters:

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

getHeight

public int getHeight()

Returns the (desired) height of this chip. You may override this method if your chip needs to return heights dynamically at running time.

Returns:

the (desired) height of this chip.

setHeight

public void setHeight(int newHeight)

Sets the (desired) height of this chip.

Parameters:

newHeight -

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

getAttributeDescriptor

public AttributeDescriptor getAttributeDescriptor()

Returns:

the attributeDescriptor

setAttributeDescriptor

public void setAttributeDescriptor(AttributeDescriptor attributeDescriptor)

Parameters:

attributeDescriptor - the attributeDescriptor to set

isAjaxUpdatable

public boolean isAjaxUpdatable()

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

Since:

3.0 M3