de.hybris.platform.hmc.attribute

Class AutocompleteReferenceEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.ReferenceAttributeEditorChip

de.hybris.platform.hmc.attribute.AutocompleteReferenceEditorChip

All Implemented Interfaces:

AjaxRequestHandler, AttributeTypeAware, ItemAcceptor, Chip, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

DownloadMediaEditorChip, UploadToMediaEditorChip

public class AutocompleteReferenceEditorChip
extends ReferenceAttributeEditorChip
implements ItemAcceptor, AjaxRequestHandler, AttributeTypeAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AJAX_SEARCH
static java.lang.String	AJAX_SELECT
static java.lang.String	LIST_WIDTH
static java.lang.String	RESULTATTRIBUTES
static java.lang.String	SEARCHATTRIBUTES

Fields inherited from class de.hybris.platform.hmc.attribute.ReferenceAttributeEditorChip

CLEAR, COPY, CREATABLE_KEY, CREATE, EDITABLE_KEY, OPEN_EDITOR, OPEN_EDITOR_INTERNAL, OPEN_SEARCH, PASTE

Fields inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

CUSTOM, 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
AutocompleteReferenceEditorChip(DisplayState displayState, Chip parent)
AutocompleteReferenceEditorChip(DisplayState displayState, Chip parent, ComposedType type)

Method Summary

Modifier and Type	Method and Description
boolean	allowsMultipleSelection()
Type	getAttributeType()
Operator	getCondition() Returns the condition to use for the item search.
java.lang.String	getDisplayValue()
static java.lang.String	getEditorType()
java.lang.String	getInputID() Returns an ID which will be used for the dom element which is the input field for this autocompleter.
java.lang.String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
int	getListWidth()
java.lang.String	getMatchesID() Returns an ID which will be used for the dom element which contains the list of matches for this autocompleter.
protected java.lang.String	getProposedUniqueName()
int	getRange() Returns the number of result list entries which should be shown by this autocompleter component.
protected java.util.List<java.lang.String>	getResultAttributes() This method tries to extract comma-separated list of attribute qualifiers which have been configured in the hmc.xml (using the parameter tag with 'resultattributes' as key name).
protected java.util.List<java.lang.String>	getSearchAttributes() This method tries to extract comma-separated list of attribute qualifiers which have been configured in the hmc.xml (using the parameter tag with 'searchattributes' as key name).
protected AutoCompleterResult	getSearchResult(java.lang.String searchParam)
void	processAjaxEvents(HttpServletRequest request, HttpServletResponse response, java.io.PrintWriter out, java.util.Map requestParameters)
void	processEvents(java.util.Map events) Handles all incoming requests for this chip.
protected void	select(java.lang.String pk)
void	setAttributeType(Type type)
void	setListWidth(int listWidth)
void	setParameters(java.util.Map map) Sets the parameters which where provided by the xml configuration.
void	setRange(int range) Sets the number of result list entries which should be shown by this autocompleter component.
void	setSelectedItems(java.util.List items)

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

addCreationPreset, addSearchPreset, canCreate, canPaste, getAssignableItemFromClipboard, getCreationPresets, getEditorNode, getItemType, getMenuEntries, getNoSelectionKey, getPresetSearchType, getSearchPresets, getSelectedItemAsString, hasItem, isAttributeTypeReadable, isAutoPerform, isCreatable, isElementReadable, isElementWriteable, isPartOf, isRefreshAfterSelect, openEditor, openEditor, setCreatable, setItemType, setNoSelectionKey, setPresetSearchType, setRefreshAfterSelect, setValue

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

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, convertValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getFieldID, getHeight, getInitialValue, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getValue, getWidth, isAjaxUpdatable, isChanged, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setValidValue, setWidth, valuesAreDifferent

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

LIST_WIDTH

public static final java.lang.String LIST_WIDTH

See Also:

Constant Field Values

AJAX_SELECT

public static final java.lang.String AJAX_SELECT

See Also:

Constant Field Values

AJAX_SEARCH

public static final java.lang.String AJAX_SEARCH

See Also:

Constant Field Values

SEARCHATTRIBUTES

public static final java.lang.String SEARCHATTRIBUTES

See Also:

Constant Field Values

RESULTATTRIBUTES

public static final java.lang.String RESULTATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

AutocompleteReferenceEditorChip

public AutocompleteReferenceEditorChip(DisplayState displayState,
                                       Chip parent,
                                       ComposedType type)

AutocompleteReferenceEditorChip

public AutocompleteReferenceEditorChip(DisplayState displayState,
                                       Chip parent)

Method Detail

getJSPURI

public java.lang.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

allowsMultipleSelection

public boolean allowsMultipleSelection()

Specified by:

allowsMultipleSelection in interface ItemAcceptor

setSelectedItems

public void setSelectedItems(java.util.List items)

Specified by:

setSelectedItems in interface ItemAcceptor

getDisplayValue

public java.lang.String getDisplayValue()

getInputID

public final java.lang.String getInputID()

Returns an ID which will be used for the dom element which is the input field for this autocompleter.

Returns:

an ID which will be used for the dom element which is the input field for this autocompleter.

getMatchesID

public final java.lang.String getMatchesID()

Returns an ID which will be used for the dom element which contains the list of matches for this autocompleter.

Returns:

an ID which will be used for the dom element which contains the list of matches for this autocompleter.

processEvents

public void processEvents(java.util.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 ReferenceAttributeEditorChip

processAjaxEvents

public void processAjaxEvents(HttpServletRequest request,
                              HttpServletResponse response,
                              java.io.PrintWriter out,
                              java.util.Map requestParameters)

Specified by:

processAjaxEvents in interface AjaxRequestHandler

select

protected void select(java.lang.String pk)

getSearchAttributes

protected java.util.List<java.lang.String> getSearchAttributes()

This method tries to extract comma-separated list of attribute qualifiers which have been configured in the hmc.xml (using the parameter tag with 'searchattributes' as key name). If there are no (valid) qualifiers found, the default searchattribute which is configured for the current attribute type is returned.

getResultAttributes

protected java.util.List<java.lang.String> getResultAttributes()

This method tries to extract comma-separated list of attribute qualifiers which have been configured in the hmc.xml (using the parameter tag with 'resultattributes' as key name). If there are no (valid) qualifiers found, the default reference configuration for the current attribute type is returned

getSearchResult

protected AutoCompleterResult getSearchResult(java.lang.String searchParam)

getProposedUniqueName

protected java.lang.String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractAttributeEditorChip

getRange

public int getRange()

Returns the number of result list entries which should be shown by this autocompleter component. Default is 15.

Returns:

the number of result list entries which should be shown by this autocompleter component.

getCondition

public Operator getCondition()

Returns the condition to use for the item search. Currently the two conditions "contains" and "startswith" are supported. The default is "contains".

Returns:

the condition (one of "contains" and "startswith") to use for the item search.

setRange

public void setRange(int range)

Sets the number of result list entries which should be shown by this autocompleter component.

getEditorType

public static java.lang.String getEditorType()

Returns:

the editor type of this chip.

getAttributeType

public Type getAttributeType()

Specified by:

getAttributeType in interface AttributeTypeAware

Since:

3.0 M3

setAttributeType

public void setAttributeType(Type type)

Specified by:

setAttributeType in interface AttributeTypeAware

Since:

3.0 M3

setParameters

public void setParameters(java.util.Map map)

Description copied from class: AbstractAttributeEditorChip

Sets the parameters which where provided by the xml configuration.

Overrides:

setParameters in class ReferenceAttributeEditorChip

Parameters:

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

getListWidth

public int getListWidth()

Returns:

the listWidth

setListWidth

public void setListWidth(int listWidth)

Parameters:

listWidth - the listWidth to set