de.hybris.platform.hmc.attribute

Class AbstractAttributeValueChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeValueChip

All Implemented Interfaces:

Chip, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractAttributeDisplayChip

public abstract class AbstractAttributeValueChip
extends AbstractChip

Abstract super class of all attribute value chips.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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
AbstractAttributeValueChip(DisplayState displayState, Chip parent, java.lang.String jspURI, Item item, java.lang.String qualifier)

Method Summary

Modifier and Type	Method and Description
boolean	allowHTMLEscaping() Returns true by default, which means, the displayvalue may be 'html-escaped' within a jsp.
protected abstract java.lang.String	getDefaultJSPURI() Implement this to provide a (default) jsp uri for this chip.
abstract java.lang.String	getDisplayValue() Implement this to return the value of this attribute value chip in an appropriate form.
int	getHeight() Returns the (desired) height of this chip.
Item	getItem()
java.lang.String	getJSPURI() If a jsp uri was given when this chip was constructed, the that uri is returned.
protected java.lang.String	getProposedUniqueName()
java.lang.String	getQualifier()
protected java.lang.Object	getValue()
void	processEvents(java.util.Map events) Does nothing by default, but can be overridden if necessary.
void	setHeight(int newHeight) Sets the (desired) height of this chip.

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, 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

Field Detail

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

AbstractAttributeValueChip

public AbstractAttributeValueChip(DisplayState displayState,
                                  Chip parent,
                                  java.lang.String jspURI,
                                  Item item,
                                  java.lang.String qualifier)

Method Detail

getItem

public Item getItem()

getQualifier

public java.lang.String getQualifier()

getValue

protected java.lang.Object getValue()

getJSPURI

public java.lang.String getJSPURI()

If a jsp uri was given when this chip was constructed, the that uri is returned. Otherwise the default jsp uri of this chips implementation will be returned.

Returns:

a string containinge the uri for the jsp which should render this chip

processEvents

public void processEvents(java.util.Map events)

Does nothing by default, but can be overridden if necessary.

See Also:

Chip.processEvents(java.util.Map)

getDefaultJSPURI

protected abstract java.lang.String getDefaultJSPURI()

Implement this to provide a (default) jsp uri for this chip. It will be used if no uri is given when constructing this chip.

Returns:

a string containinge the uri for the jsp which should render this chip

getDisplayValue

public abstract java.lang.String getDisplayValue()

Implement this to return the value of this attribute value chip in an appropriate form. (Usually you would use this method directly from within jsp's e.g.)

allowHTMLEscaping

public boolean allowHTMLEscaping()

Returns true by default, which means, the displayvalue may be 'html-escaped' within a jsp. The intention of this method is as following: If you implement your own subclass, say an XYZDisplayChip, which relies on showing an html tag (e.g. ) then you would not want this to be escaped, but instead you want this tag to be processed by a browser. In this case you should override this method and return false as to indicate that the displayvalue should not be escaped. Otherwise the default attributeDisplayChip.jsp would try to escape the displayvalue (depending on the global hmc.html.escape property, of course).

Returns:

true true by default, which means, the displayvalue may be 'html-escaped' within a jsp.

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 -

getProposedUniqueName

protected java.lang.String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractChip