de.hybris.platform.hmc.attribute

Class UrlAsImageDisplayChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeValueChip

de.hybris.platform.hmc.attribute.AbstractAttributeDisplayChip

de.hybris.platform.hmc.attribute.UrlAsImageDisplayChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public class UrlAsImageDisplayChip
extends AbstractAttributeDisplayChip

not used yet!

See Also:

Serialized Form

Field Summary

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
UrlAsImageDisplayChip(DisplayState displayState, Chip parent, String jspURI, Item item, 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.
String	getDisplayValue() Implement this to return the value of this attribute value chip in an appropriate form.
int	getHeight() Returns the height of this display chip, calculated using the given height (or the default height of 50px).
String	getLinkStyle() Returns "class = \"imagelink\"" to provide a hover effect for the result list link.
void	setParameters(Map parameters) Sets the map of parameters used to configure the display chip (may contain width and height).

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

createAttributeDisplayChip, getDefaultJSPURI, getLinkTarget, getLinkTitle, getLinkUrl, isAlignRight, isDefaultLink, setAlignRight

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

getItem, getJSPURI, getProposedUniqueName, getQualifier, getValue, processEvents, setHeight

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

Constructor Detail

UrlAsImageDisplayChip

public UrlAsImageDisplayChip(DisplayState displayState,
                             Chip parent,
                             String jspURI,
                             Item item,
                             String qualifier)

Parameters:

displayState -

parent -

jspURI -

item -

qualifier -

Method Detail

getDisplayValue

public String getDisplayValue()

Description copied from class: AbstractAttributeValueChip

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

Specified by:

getDisplayValue in class AbstractAttributeValueChip

getHeight

public int getHeight()

Returns the height of this display chip, calculated using the given height (or the default height of 50px).

Overrides:

getHeight in class AbstractAttributeValueChip

Returns:

the height of this display chip.

setParameters

public void setParameters(Map parameters)

Sets the map of parameters used to configure the display chip (may contain width and height).

Overrides:

setParameters in class AbstractAttributeDisplayChip

Parameters:

parameters - map of parameters used to configure the display chip.

allowHTMLEscaping

public boolean allowHTMLEscaping()

Description copied from class: AbstractAttributeValueChip

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

Overrides:

allowHTMLEscaping in class AbstractAttributeValueChip

Returns:

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

See Also:

AbstractAttributeValueChip.allowHTMLEscaping()

getLinkStyle

public String getLinkStyle()

Returns "class = \"imagelink\"" to provide a hover effect for the result list link.

Overrides:

getLinkStyle in class AbstractAttributeDisplayChip

Returns:

the string "class = \"imagelink\""

See Also:

AbstractAttributeDisplayChip.getLinkStyle()