de.hybris.platform.catalog.hmc

Class ClassificationAttributeChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.CustomChip

de.hybris.platform.catalog.hmc.ClassificationAttributeChip

All Implemented Interfaces:

ChangeIndicatorChip, SpecialEditor, SpecialValidatingChip, SpecialReloadChip, SpecialSaveChip, Chip, Serializable, Cloneable

public class ClassificationAttributeChip
extends CustomChip
implements SpecialEditor, SpecialValidatingChip, ChangeIndicatorChip

ClassificationAttributeChip represents a classification attribute. It has similar functionality to the normal AttributeChip (and LocalizableAttributeChip) and should look nearly the same. Main difference is, of course, the handling of classification attributes instead of the normal item attributes, including the retrieving and saving of such attributes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_LABELWIDTH
static String	ATTRIBUTE_NAME
static String	COLLAPSE
static String	EXPAND
static String	OPEN_ATTRIBUTE_EXTERNAL
static String	OPEN_ATTRIBUTE_INTERNAL

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
ClassificationAttributeChip(Chip parent, ClassAttributeAssignment assignment) Creates a new ClassificationAttributeChip
ClassificationAttributeChip(DisplayState displayState, Chip parent, Map attributes, String jspURI) Creates a new ClassificationAttributeChip

Method Summary

Modifier and Type	Method and Description
boolean	containsValidValue()
protected ClassAttributeAssignment	getAssignment()
List	getAttributeNames()
protected ClassAttributeAssignment	getClassAttributeAssignment(Chip parent, Map<String,String> attributes) From the given attribute map this method takes the "name" attribute and tries to interpret the given path to return a ClassAttributeAssignment.
protected ClassificationAttribute	getClassificationAttribute()
protected String[]	getClassificationAttributePath(Map<String,String> attributes) Splits name attribute into [ systemName, systemVersion, class , attribute ].
AbstractClassificationAttributeEditorChip	getEditorChip() If this classification attribute is not localizable the single editor for this attribute will be returned.
Map<Language,AbstractClassificationAttributeEditorChip>	getEditorChips()
String	getErrorMessage()
FeatureContainer	getFeatureContainer()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getLabel()
int	getLabelWidth()
protected static int	getLabelWidth(Map<String,String> attributes)
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
protected Product	getProduct()
protected Set<Language>	getReadableLanguages()
String	getTooltip()
protected Set<Language>	getWritableLanguages()
protected Map<String,String>	getXMLAttributes()
boolean	hasError() Returns true if this attribute chip has an error.
protected void	initialize()
boolean	isChanged() Returns true if any of the editors contained in this chip has been changed.
boolean	isEditable()
boolean	isExpanded() If the classification attribute in this chip is localizable this method returns true if the editor list is expanded.
boolean	isLocalized()
boolean	isMandatory()
protected void	openEditor(boolean external)
void	processEvents(Map events) Handles all incoming requests for this chip.
void	reload() Reloads the editor(s) contained in this chip.
void	save() Saves the current value of the editor to the appropriate product feature.
void	setError(boolean error)
void	setErrorMessage(String errorMessage)
protected void	setExpanded(boolean expanded)
protected void	setFeatureContainer(FeatureContainer container)
protected void	setLabelWidth(int width)
void	setMainAttributeName(String name)
void	setParameter(String parameter) Does nothing.
void	validate(DisplayState state, ActionResult result) Validates current input and raises an error in case this classification attribute cannot be saved.

Methods inherited from class de.hybris.platform.hmc.CustomChip

getAttributes, getDefaultJSPURI, getParameter, getParameters

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

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

Field Detail

EXPAND

public static final String EXPAND

See Also:

Constant Field Values

COLLAPSE

public static final String COLLAPSE

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_LABELWIDTH

public static final String ATTRIBUTE_LABELWIDTH

See Also:

Constant Field Values

OPEN_ATTRIBUTE_INTERNAL

public static final String OPEN_ATTRIBUTE_INTERNAL

See Also:

Constant Field Values

OPEN_ATTRIBUTE_EXTERNAL

public static final String OPEN_ATTRIBUTE_EXTERNAL

See Also:

Constant Field Values

Constructor Detail

ClassificationAttributeChip

public ClassificationAttributeChip(DisplayState displayState,
                                   Chip parent,
                                   Map attributes,
                                   String jspURI)

Creates a new ClassificationAttributeChip

ClassificationAttributeChip

public ClassificationAttributeChip(Chip parent,
                                   ClassAttributeAssignment assignment)

Creates a new ClassificationAttributeChip

Method Detail

initialize

protected void initialize()

getReadableLanguages

protected Set<Language> getReadableLanguages()

getWritableLanguages

protected Set<Language> getWritableLanguages()

getClassAttributeAssignment

protected ClassAttributeAssignment getClassAttributeAssignment(Chip parent,
                                                               Map<String,String> attributes)

From the given attribute map this method takes the "name" attribute and tries to interpret the given path to return a ClassAttributeAssignment.

getClassificationAttributePath

protected String[] getClassificationAttributePath(Map<String,String> attributes)

Splits name attribute into [ systemName, systemVersion, class , attribute ].

validate

public void validate(DisplayState state,
                     ActionResult result)

Validates current input and raises an error in case this classification attribute cannot be saved.

Specified by:

validate in interface SpecialValidatingChip

save

public void save()

Saves the current value of the editor to the appropriate product feature. Implements SpecialEditor interface.

Specified by:

save in interface SpecialSaveChip

See Also:

SpecialSaveChip.save()

reload

public void reload()

Reloads the editor(s) contained in this chip. Implements SpecialEditor interface.

Specified by:

reload in interface SpecialReloadChip

See Also:

SpecialReloadChip.reload()

getClassificationAttribute

protected ClassificationAttribute getClassificationAttribute()

getEditorChip

public AbstractClassificationAttributeEditorChip getEditorChip()

If this classification attribute is not localizable the single editor for this attribute will be returned. If it is localizable the editor for the current language will be returned.

Returns:

the attribute editor for the current session language (or, alternatively, the single attribute editor if this attribute is not localizable)

isLocalized

public boolean isLocalized()

Returns:

true if the classification attribute in this chip is localizable

isMandatory

public boolean isMandatory()

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

Overrides:

getJSPURI in class CustomChip

getLabel

public String getLabel()

getLabelWidth

protected static int getLabelWidth(Map<String,String> attributes)

getTooltip

public String getTooltip()

isEditable

public boolean isEditable()

containsValidValue

public boolean containsValidValue()

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

Overrides:

processEvents in class CustomChip

See Also:

Chip.processEvents(java.util.Map)

openEditor

protected void openEditor(boolean external)

isChanged

public boolean isChanged()

Returns true if any of the editors contained in this chip has been changed.

Specified by:

isChanged in interface ChangeIndicatorChip

See Also:

ChangeIndicatorChip.isChanged()

getProduct

protected Product getProduct()

getAttributeNames

public List getAttributeNames()

Specified by:

getAttributeNames in interface SpecialEditor

See Also:

SpecialEditor.getAttributeNames()

getEditorChips

public Map<Language,AbstractClassificationAttributeEditorChip> getEditorChips()

getMenuEntries

public List getMenuEntries()

Description copied from class: AbstractChip

Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.

Specified by:

getMenuEntries in interface Chip

Overrides:

getMenuEntries in class AbstractChip

Returns:

List of Actions;

getLabelWidth

public int getLabelWidth()

setLabelWidth

protected void setLabelWidth(int width)

getXMLAttributes

protected Map<String,String> getXMLAttributes()

setExpanded

protected void setExpanded(boolean expanded)

isExpanded

public boolean isExpanded()

If the classification attribute in this chip is localizable this method returns true if the editor list is expanded.

Returns:

true if the editor list is expanded, false if only one editor (of the current session language) is visible

getAssignment

protected ClassAttributeAssignment getAssignment()

hasError

public boolean hasError()

Returns true if this attribute chip has an error. Usually this means that the chip has been configured to appear at a non-product item or at a product which does not feature the given classification attribute.

Returns:

true if this attribute chip has an error

setError

public void setError(boolean error)

getFeatureContainer

public FeatureContainer getFeatureContainer()

setFeatureContainer

protected void setFeatureContainer(FeatureContainer container)

getErrorMessage

public String getErrorMessage()

setErrorMessage

public void setErrorMessage(String errorMessage)

setMainAttributeName

public void setMainAttributeName(String name)

Specified by:

setMainAttributeName in interface SpecialEditor

See Also:

SpecialEditor.setMainAttributeName(java.lang.String)

setParameter

public void setParameter(String parameter)

Does nothing. All parameters given in the hmc.xml are available using CustomChip.getParameter(String) and CustomChip.getParameters(). Implements SpecialEditor interface.

Specified by:

setParameter in interface SpecialEditor

See Also:

SpecialEditor.setParameter(java.lang.String)