de.hybris.platform.catalog.hmc

Class AbstractClassificationAttributeEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.catalog.hmc.AbstractClassificationAttributeEditorChip

All Implemented Interfaces:

AttributeValueChangeListener, Chip, Serializable, Cloneable, EventListener

Direct Known Subclasses:

BooleanClassificationAttributeEditorChip, DateClassificationAttributeEditorChip, EnumClassificationAttributeEditorChip, NoAccessClassificationAttributeEditorChip, NumberClassificationAttributeEditorChip, StringClassificationAttributeEditorChip

public abstract class AbstractClassificationAttributeEditorChip
extends AbstractChip
implements AttributeValueChangeListener

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD
protected static String	ATTRIBUTE_WIDTH
protected static int	DEFAULT_EDITORWIDTH
protected static int	DEFAULT_UNIT_WIDTH
static String	REMOVE
protected static String	UNIT_WIDTH

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
AbstractClassificationAttributeEditorChip(SessionContext context, Chip parent, Map<String,String> xmlAttributes)

Method Summary

Modifier and Type	Method and Description
protected int	addValue() Adds new empty editors representing a new feature value.
protected int	addValue(AbstractAttributeEditorChip valueEditor, AbstractAttributeEditorChip descriptionEditor, AbstractAttributeEditorChip unitEditor)
boolean	containsValidValue() Returns true if all the embedded editors contain valid values.
protected abstract Object	convertValue(Object value) Implementation of this method should convert the given value if necessary.
protected AbstractAttributeEditorChip	createDescriptionEditor(Object initialValue) Returns a new AbstractAttributeEditorChip (usually a StringEditorChip) containing the given initial value.
protected AbstractAttributeEditorChip	createDescriptionEditorChip() Creates a string editor chip.
protected AbstractAttributeEditorChip	createUnitEditor(Object initialValue) Returns a new AbstractAttributeEditorChip (usually a AllInstancesSelectEditorChip) containing the given initial value.
protected AbstractAttributeEditorChip	createUnitEditorChip(ClassificationAttributeUnit currentValueUnit) Returns a new instance of AllInstancesSelectEditorChip for the type ClassificationAttributeUnit.
protected AbstractAttributeEditorChip	createValueEditor(Object initialValue) Creates a new AbstractAttributeEditorChip with the given initial value.
protected abstract AbstractAttributeEditorChip	createValueEditorChip() Implementation of this method should create a new value editor.
protected ClassAttributeAssignment	getClassAttributeAssignment() Returns the ClassAttributeAssignment this editor represents.
SessionContext	getContext() Returns the SessionContext for which this editor was created.
protected ClassificationAttributeUnit	getDefaultUnit() For the current ClassAttributeAssignment this method returns the default ClassificationAttributeUnit.
List<AbstractAttributeEditorChip>	getDescriptionEditorChips() Returns the List of description editors (usually of type StringEditorChip)
protected int	getEditorWidth() From the given xml attributes map this method will try to extract the editor width (the "width" attribute) and return it.
TypedFeature<Object>	getFeature() Returns the TypedFeature this editor represents.
List	getMenuEntries() Returns context menu entries.
protected List<ClassificationAttributeUnit>	getSelectableUnitsForAttribute()
String	getTooltip(int index) For the given index the value of the descriptio editor is returned.
List<AbstractAttributeEditorChip>	getUnitEditorChips() Returns the List of unit editors (usually of type AllInstancesSelectEditorChip)
protected int	getUnitEditorWidth() From the given xml attributes map this method will try to extract the unit editor width (the "unitwidth" attribute) and return it.
List<AbstractAttributeEditorChip>	getValueEditorChips()
protected Map<String,String>	getXmlAttributes() Returns the xml attributes which were used to configure this editor in the hmc.xml.
protected boolean	hasUnitEditor()
boolean	isChanged() Returns true if at least one of the value- or description editors have been changed.
boolean	isEditable() Returns true if this editor is being marked as editable.
boolean	isMandatory() Returns true if the the feature this editor represents is mandatory
boolean	isMultiValued() Returns true if the feature this editor represents allows for multiple values.
boolean	isRange() Returns true if the feature this editor represents should contain range values
void	notifyAttributeValueChange(AttributeValueChangeEvent event) Is called if one of the editors has been changed.
protected void	notifyDesciptionEditorChanged(int index, AttributeValueChangeEvent event)
protected void	notifyUnitEditorChanged(int index, AttributeValueChangeEvent event)
protected void	notifyValueEditorChanged(int index, AttributeValueChangeEvent event)
void	processEvents(Map events) Processes 'add' and 'remove' events for feature values.
protected void	removeValue(int index) Removes the feature value with the given index (i.e.
void	setEditable(boolean editable) Sets this editor as editable.
void	setFeature(TypedFeature<Object> feature) Sets the TypedFeature this editor represents.
protected void	setIsChanged(boolean changed) Sets the current 'is changed' status.
protected abstract boolean	supportUnits() Implementing classes should return true if the editor should support units.

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

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, 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

Field Detail

ATTRIBUTE_WIDTH

protected static final String ATTRIBUTE_WIDTH

See Also:

Constant Field Values

UNIT_WIDTH

protected static final String UNIT_WIDTH

See Also:

Constant Field Values

DEFAULT_EDITORWIDTH

protected static final int DEFAULT_EDITORWIDTH

See Also:

Constant Field Values

DEFAULT_UNIT_WIDTH

protected static final int DEFAULT_UNIT_WIDTH

See Also:

Constant Field Values

ADD

public static final String ADD

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

Constructor Detail

AbstractClassificationAttributeEditorChip

public AbstractClassificationAttributeEditorChip(SessionContext context,
                                                 Chip parent,
                                                 Map<String,String> xmlAttributes)

Method Detail

getValueEditorChips

public List<AbstractAttributeEditorChip> getValueEditorChips()

getDescriptionEditorChips

public List<AbstractAttributeEditorChip> getDescriptionEditorChips()

Returns the List of description editors (usually of type StringEditorChip)

getUnitEditorChips

public List<AbstractAttributeEditorChip> getUnitEditorChips()

Returns the List of unit editors (usually of type AllInstancesSelectEditorChip)

getTooltip

public String getTooltip(int index)

For the given index the value of the descriptio editor is returned.

setEditable

public final void setEditable(boolean editable)

Sets this editor as editable.

isEditable

public final boolean isEditable()

Returns true if this editor is being marked as editable.

Returns:

true if this editor is being marked as editable.

getEditorWidth

protected int getEditorWidth()

From the given xml attributes map this method will try to extract the editor width (the "width" attribute) and return it.

hasUnitEditor

protected boolean hasUnitEditor()

getUnitEditorWidth

protected int getUnitEditorWidth()

From the given xml attributes map this method will try to extract the unit editor width (the "unitwidth" attribute) and return it.

getXmlAttributes

protected final Map<String,String> getXmlAttributes()

Returns the xml attributes which were used to configure this editor in the hmc.xml.

Returns:

the xml attributes which were used to configure this editor in the hmc.xml.

getFeature

public final TypedFeature<Object> getFeature()

Returns the TypedFeature this editor represents.

Returns:

the TypedFeature this editor represents.

setFeature

public void setFeature(TypedFeature<Object> feature)

Sets the TypedFeature this editor represents.

Parameters:

feature - the TypedFeature this editor represents.

getContext

public final SessionContext getContext()

Returns the SessionContext for which this editor was created.

Returns:

the SessionContext for which this editor was created.

processEvents

public void processEvents(Map events)

Processes 'add' and 'remove' events for feature values.

Specified by:

processEvents in interface Chip

removeValue

protected void removeValue(int index)

Removes the feature value with the given index (i.e. the editors and the feature value itself are being removed).

Parameters:

index - the index of the value to be removed.

addValue

protected int addValue()

Adds new empty editors representing a new feature value.

addValue

protected int addValue(AbstractAttributeEditorChip valueEditor,
                       AbstractAttributeEditorChip descriptionEditor,
                       AbstractAttributeEditorChip unitEditor)

convertValue

protected abstract Object convertValue(Object value)

Implementation of this method should convert the given value if necessary.
If the type of the classification attribute has been changed in the past there might still be 'old' values of the wrong type, for example. This method should either try to convert these old values or return a default 'empty' value, if that is not possible. TODO: mr, if some better solution for this type conversion problem comes along, this method might no longer be necessary

Parameters:

value - the value to be converted (if necessary)

Returns:

the converted value (of the correct type according to the current classification attribute type

supportUnits

protected abstract boolean supportUnits()

Implementing classes should return true if the editor should support units. This is usually only true for attributes of type number.

Returns:

true if the editor should support units

createValueEditorChip

protected abstract AbstractAttributeEditorChip createValueEditorChip()

Implementation of this method should create a new value editor. Needs to be implemented according to the respective value type (string, boolean etc.)

Returns:

a new attribute editor chip

createValueEditor

protected final AbstractAttributeEditorChip createValueEditor(Object initialValue)

Creates a new AbstractAttributeEditorChip with the given initial value.

Parameters:

initialValue - the initial editor value

Returns:

a new AbstractAttributeEditorChip

createDescriptionEditorChip

protected AbstractAttributeEditorChip createDescriptionEditorChip()

Creates a string editor chip.

createDescriptionEditor

protected final AbstractAttributeEditorChip createDescriptionEditor(Object initialValue)

Returns a new AbstractAttributeEditorChip (usually a StringEditorChip) containing the given initial value.

Parameters:

initialValue - the initial value of the new editor

Returns:

a new AbstractAttributeEditorChip (usually a StringEditorChip)

createUnitEditorChip

protected AbstractAttributeEditorChip createUnitEditorChip(ClassificationAttributeUnit currentValueUnit)

Returns a new instance of AllInstancesSelectEditorChip for the type ClassificationAttributeUnit.

Returns:

a new instance of AllInstancesSelectEditorChip for the type ClassificationAttributeUnit.

getSelectableUnitsForAttribute

protected List<ClassificationAttributeUnit> getSelectableUnitsForAttribute()

createUnitEditor

protected final AbstractAttributeEditorChip createUnitEditor(Object initialValue)

Returns a new AbstractAttributeEditorChip (usually a AllInstancesSelectEditorChip) containing the given initial value.

Parameters:

initialValue - the initial value of the new editor

Returns:

a new AbstractAttributeEditorChip (usually a AllInstancesSelectEditorChip)

setIsChanged

protected void setIsChanged(boolean changed)

Sets the current 'is changed' status. Intended for internal use only.

Parameters:

changed -

isChanged

public boolean isChanged()

Returns true if at least one of the value- or description editors have been changed.

Returns:

true if at least one of the value- or description editors have been changed.

containsValidValue

public boolean containsValidValue()

Returns true if all the embedded editors contain valid values.

Returns:

true if all the embedded editors contain valid values.

isMultiValued

public boolean isMultiValued()

Returns true if the feature this editor represents allows for multiple values.

Returns:

true if the feature this editor represents allows for multiple values.

isRange

public boolean isRange()

Returns true if the feature this editor represents should contain range values

Returns:

true if the feature this editor represents should contain range values

isMandatory

public boolean isMandatory()

Returns true if the the feature this editor represents is mandatory

Returns:

true if the the feature this editor represents is mandatory

getClassAttributeAssignment

protected ClassAttributeAssignment getClassAttributeAssignment()

Returns the ClassAttributeAssignment this editor represents.

getDefaultUnit

protected ClassificationAttributeUnit getDefaultUnit()

For the current ClassAttributeAssignment this method returns the default ClassificationAttributeUnit.

Returns:

the default ClassificationAttributeUnit

getMenuEntries

public List getMenuEntries()

Returns context menu entries.

Specified by:

getMenuEntries in interface Chip

Overrides:

getMenuEntries in class AbstractChip

Returns:

List of Actions;

notifyAttributeValueChange

public void notifyAttributeValueChange(AttributeValueChangeEvent event)

Is called if one of the editors has been changed.

Specified by:

notifyAttributeValueChange in interface AttributeValueChangeListener

notifyUnitEditorChanged

protected void notifyUnitEditorChanged(int index,
                                       AttributeValueChangeEvent event)

notifyDesciptionEditorChanged

protected void notifyDesciptionEditorChanged(int index,
                                             AttributeValueChangeEvent event)

notifyValueEditorChanged

protected void notifyValueEditorChanged(int index,
                                        AttributeValueChangeEvent event)