de.hybris.platform.lucenesearch.hmc

Class SearchResultListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

de.hybris.platform.hmc.ItemListChip

de.hybris.platform.hmc.generic.GenericItemListChip

de.hybris.platform.hmc.generic.GenericItemSearchListChip

de.hybris.platform.lucenesearch.hmc.SearchResultListChip

All Implemented Interfaces:

AttributeValueChangeListener, AdditionalColumnProvider, ItemAcceptor, ToolbarProvider, TypedChip, Chip, Serializable, Cloneable, EventListener

public class SearchResultListChip
extends GenericItemSearchListChip
implements AdditionalColumnProvider

A pager view of a lucenesearch result that also shows result scores.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.hybris.platform.hmc.generic.GenericItemSearchListChip

FIRST_PAGE, ITEMS_PER_PAGE, LAST_PAGE, maxDisplayEntryHeight, NEXT_PAGE, PREVIOUS_PAGE, RANGESTART, REFRESH, SEARCHRESULTACTION, SORT, TOGGLE

Fields inherited from class de.hybris.platform.hmc.generic.GenericItemListChip

ADD, COPY_EVENT, CREATE, DELETE_ICON, DELETE_NEW_ENTRY, OPEN_EDITOR, OPEN_EDITOR_EXTERNAL, OPEN_EDITOR_INTERNAL, REMOVE, SELECT_ALL, SELECT_VISIBLE

Fields inherited from class de.hybris.platform.hmc.webchips.ListChip

CLEAR, SELECT

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
SearchResultListChip(DisplayState displayState, SearchResultChip parent, LuceneIndex index, String searchPattern, List searchGroups, LuceneSearchContainer container)

Method Summary

Modifier and Type	Method and Description
boolean	canRemove()
AbstractToolbarChip	createToolbar()
protected void	delete()
String	getAdditionalColumnHeader() Name of the additional column which will be shown at the header of the table.
String	getAdditionalColumnValue(int index) Gets the value to display of the additional column at position index within entry list.
int	getAdditionalColumnWidth() The width to use for this column.
int	getMaxItemsPerPageDefault()
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
float	getScore(int score)
boolean	isEditable()
boolean	isSortable(String qualifier) Will return true if the AttributeDescriptor with the given qualifier is searchable and no comparator is used.
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
protected void	setExpanded(boolean expanded)
boolean	update()

Methods inherited from class de.hybris.platform.hmc.generic.GenericItemSearchListChip

canCreate, getAdditionalColumnProvider, getComparator, getConditionsAsString, getHeightDiff, getItemCount, getItemsPerPageAsInt, getItemsPerPageDefault, getItemsPerPageList, getJSPURI, getMaxEntryHeight, getMaxItemsPerPage, getMaxListHeight, getMinListHeight, getProposedUniqueName, getRangeStart, getRestrictor, getSearchContainer, getSearchCount, getSearchResultActionChipByName, getSearchResultActionChips, getSelectedListEntries, getSortAttributeQualifier, getSortDirection, getSortOrderIdentifier, getTypeName, hasComparator, isExpanded, isNewSearch, setAdditionalColumnProvider, setComparator, setMaxItemsPerPage, setRangeStart, setRestrictor, setSearchContainer, setSortAttributeQualifier, setSortDirection, switchSortDirection

Methods inherited from class de.hybris.platform.hmc.generic.GenericItemListChip

addCreationPreset, addSearchPreset, allowsMultipleSelection, canAdd, canPaste, clearListEntries, clearSelectedListEntries, createListEntryChip, createNewItemEntry, createNewItemEntry, entriesEditable, getAssignableItemsFromClipboard, getCreationPresetQualifiers, getCreationPresets, getEditorNode, getElementTypes, getEntry, getEntryForItem, getIndexOf, getItemNotValidErrorMessage, getMaxCount, getMode, getNewItemEntry, getPresetAttributeName, getPresetSearchType, getRestrictedListEntries, getSearchEditor, getSearchPresets, getVisibleQualifiers, getWidth, isAllSelected, isAutoPerform, isAutoPerform, isAutoSave, isChanged, isConsiderSubtypes, isExternalCreate, isExternalCreate, isMarkedAsMandatory, isPartOfAttribute, isProhibitOpening, isSelectVisible, mandatoryNotAccessible, mandatoryNotAccessible, notifyAttributeValueChange, openEditor, openEditor, refreshEntries, save, saveNewItemEntry, setAutoPerform, setAutoSave, setCanAdd, setCanRemove, setConsiderSubtypes, setCreate, setElementType, setElementTypes, setEntriesEditable, setExternalCreate, setMaxCount, setNewItemEntry, setPresetAttributeName, setPresetSearchType, setProhibitOpening, setSearchEditor, setSelectedItems, setSelectVisible, setWidth, showSearchEditor, subTypesVisible

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

checkValid, getAttributeNodes, getAttributeWidths, getChildNodes, getHeaderCount, getHeaderQualifiers, getItemLayoutNode, getItemType, getTitle, getToolbar, hasFancyRows, setItemLayoutNode, setItemType

Methods inherited from class de.hybris.platform.hmc.webchips.ListChip

addListEntry, addSelectedListEntries, addSelectedListEntry, getListEntries, getListEntryCount, getPosition, getSelectedListEntryCount, isListEntrySelected, isMultipleSelectionAllowed, moveDown, moveUp, removeListEntry, setFancyRows, setMultipleSelection, setMultipleSelectionAllowed, sort, sort

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

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

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

Constructor Detail

SearchResultListChip

public SearchResultListChip(DisplayState displayState,
                            SearchResultChip parent,
                            LuceneIndex index,
                            String searchPattern,
                            List searchGroups,
                            LuceneSearchContainer container)

Method Detail

isEditable

public boolean isEditable()

Overrides:

isEditable in class GenericItemListChip

getScore

public float getScore(int score)

update

public boolean update()

Overrides:

update in class GenericItemSearchListChip

createToolbar

public AbstractToolbarChip createToolbar()

Specified by:

createToolbar in interface ToolbarProvider

Overrides:

createToolbar in class GenericItemSearchListChip

getMaxItemsPerPageDefault

public int getMaxItemsPerPageDefault()

Overrides:

getMaxItemsPerPageDefault in class GenericItemSearchListChip

setExpanded

protected void setExpanded(boolean expanded)

Overrides:

setExpanded in class GenericItemSearchListChip

Parameters:

expanded - If the editor is in the expanded view mode (TRUE) displaying the whole table or in collapsed mode (FALSE) displaying only the header.

getAdditionalColumnValue

public String getAdditionalColumnValue(int index)

Description copied from interface: AdditionalColumnProvider

Gets the value to display of the additional column at position index within entry list.

Specified by:

getAdditionalColumnValue in interface AdditionalColumnProvider

Parameters:

index - the index within the item list for which the column value is needed

Returns:

value which will be displayed for entry at position index

getAdditionalColumnHeader

public String getAdditionalColumnHeader()

Description copied from interface: AdditionalColumnProvider

Name of the additional column which will be shown at the header of the table.

Specified by:

getAdditionalColumnHeader in interface AdditionalColumnProvider

Returns:

column name

getAdditionalColumnWidth

public int getAdditionalColumnWidth()

Description copied from interface: AdditionalColumnProvider

The width to use for this column.

Specified by:

getAdditionalColumnWidth in interface AdditionalColumnProvider

Returns:

column width

isSortable

public boolean isSortable(String qualifier)

Description copied from class: GenericItemSearchListChip

Will return true if the AttributeDescriptor with the given qualifier is searchable and no comparator is used.

Overrides:

isSortable in class GenericItemSearchListChip

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 GenericItemSearchListChip

Returns:

List of Actions;

See Also:

AbstractChip.getMenuEntries()

canRemove

public boolean canRemove()

Overrides:

canRemove in class GenericItemSearchListChip

processEvents

public void processEvents(Map<String,List<String>> 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 GenericItemSearchListChip

delete

protected void delete()