de.hybris.platform.hmc

Class AbstractAutocompleterToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

de.hybris.platform.hmc.AbstractAutocompleterToolbarActionChip

All Implemented Interfaces:

AjaxRequestHandler, Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

ClassificationAutocompleterToolbarChip

public abstract class AbstractAutocompleterToolbarActionChip
extends AbstractToolbarActionChip
implements AjaxRequestHandler

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

AbstractToolbarActionChip.ToolbarActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH
static String	SELECT
static String	VALUE

Fields inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

accepted, ALIGN_LEFT, ALIGN_RIGHT, PERFORM

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
AbstractAutocompleterToolbarActionChip(AbstractToolbarChip parent, String label)

Method Summary

Modifier and Type	Method and Description
protected abstract void	entrySelectedByAjax(String value) Must be implemented by extending class.
protected abstract void	entrySelectedByRequest(String value) Must be implemented by extending class.
Set	getAcceptedEvents()
String	getInputID() Returns an ID which will be used for the dom element which is the input field for this autocompleter.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getMatchesID() Returns an ID which will be used for the dom element which contains the list of matches for this autocompleter.
int	getRange() Returns the number of result list entries which should be shown by this autocompleter component.
String	getValue()
void	processAjaxEvents(HttpServletRequest request, HttpServletResponse response, PrintWriter out, Map requestParameters)
void	processEvents(Map events) Handles all incoming requests for this chip.
protected abstract AutoCompleterResult	search(String searchParam) Must be implemented by extending class.
void	setRange(int range) Sets the number of result list entries which should be shown by this autocompleter component.
void	setValue(String value)

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

addActionListener, getAccessKey, getAlignment, getConfirmationMessage, getEvent, getJavaScript, getLabel, getProposedUniqueName, getToolbarType, getTooltip, getWidth, isEnabled, isPartOf, isVisible, notifyActionPerformed, perform, removeActionListener, setAccessKey, setAlignment, setConfirmationMessage, setEnabled, setEvent, setJavaScript, setLabel, setShowLabel, setTooltip, setVisible, setWidth, showLabel

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

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

Field Detail

SEARCH

public static final String SEARCH

See Also:

Constant Field Values

SELECT

public static final String SELECT

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

Constructor Detail

AbstractAutocompleterToolbarActionChip

public AbstractAutocompleterToolbarActionChip(AbstractToolbarChip parent,
                                              String label)

Method Detail

search

protected abstract AutoCompleterResult search(String searchParam)

Must be implemented by extending class. Should provide a search result (as a AutoCompleterResult) based on the given search parameter. In the resulting AutoCompleterResult you should provide a String value for every result entry which is unique. This value will not be shown in the component but will be used to trigger the entrySelectedByAjax(String) callback. Exactly how the provided string values are matched to the objects you want to be selected, is up to you. But in case you are using the autocompleter to choose from a list of Items then you would obviously want to use the respective item's pk, as it is the easiest way to find the item after it has been selected.

entrySelectedByAjax

protected abstract void entrySelectedByAjax(String value)

Must be implemented by extending class. The value provided is the value that has initially been given in the respective AutoCompleterResult entry (see search(String)).

entrySelectedByRequest

protected abstract void entrySelectedByRequest(String value)

Must be implemented by extending class. The value provided is the value that has initially been given in the respective AutoCompleterResult entry (see search(String)).

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

Specified by:

getJSPURI in class AbstractToolbarActionChip

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 AbstractToolbarActionChip

processAjaxEvents

public void processAjaxEvents(HttpServletRequest request,
                              HttpServletResponse response,
                              PrintWriter out,
                              Map requestParameters)

Specified by:

processAjaxEvents in interface AjaxRequestHandler

getInputID

public final 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 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.

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.

setRange

public void setRange(int range)

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

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

Overrides:

getAcceptedEvents in class AbstractToolbarActionChip

getValue

public String getValue()

setValue

public void setValue(String value)