AbstractDualListboxEditor (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.cockpit.components.duallistbox.AbstractDualListboxEditor<K>

Direct Known Subclasses:

DefaultReferenceDualListboxEditor, DefaultSimpleDualListboxEditor
```
public abstract class AbstractDualListboxEditor<K>
extends Object
```
DualListbox editor, used in wizards It is possible to change behavior of every cell of the editor by extending this editor and overriding related methods. For specific implementation go to: DefaultReferenceDualListboxEditor for editor with search type, DefaultSimpleDualListboxEditor for columns

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<K>`	`assignedValuesList` List of assigned values, that list should be taken as a result returned by editor
`protected Listbox`	`collectionAllItems` List of presented available values used for rendering listbox, presented on the left side of component
`protected Listbox`	`collectionAssignedItems` List of presented assigned values, presented on the right side of component
`protected SearchTextboxDiv`	`inputComponentDiv` Search field presented in editor.
`protected boolean`	`singleSelector` flag for resolving number of assigned values true - there is only one possible result on assigned list, new assignment overwrites the old one false - new assignment is added to the list

Constructor Summary

Constructors
Constructor and Description

AbstractDualListboxEditor(List<K> assignedValuesList)

Constructors
Constructor and Description
`AbstractDualListboxEditor(List<K> assignedValuesList)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToAssignedValuesList(Object obj, Listitem item)` Method for assigning available values to assigned values list.
`protected Image`	`createAssignBtn()` Method creates the button for assigning values
`HtmlBasedComponent`	`createComponentView(Map<String,? extends Object> parameters)`
`protected Table`	`createInternalComponentView()` Method for main presentation view
`protected HtmlBasedComponent`	`fillLeftBottomCell()` Creates left bottom area of the wizard.
`protected HtmlBasedComponent`	`fillLeftTopCell()` Area used for presenting search box
`protected HtmlBasedComponent`	`fillMidBottomCell()` Used for presenting assign button
`protected HtmlBasedComponent`	`fillMidTopCell()` Originally it's just an empty div,but it might be override if you want to present something in that area.
`protected HtmlBasedComponent`	`fillRightBottomCell()` Creates right bottom area of the wizard.
`protected HtmlBasedComponent`	`fillRightTopCell()` Originally that area is empty,but might be usd for extending editor usability.
`protected ListitemRenderer`	`getAssignedCollectionItemListRenderer()`
`protected Label`	`getAssignedValuesLabel()`
`List<K>`	`getAssignedValuesList()`
`protected ListitemRenderer`	`getAvailableCollectionItemListRenderer()`
`protected Label`	`getAvailableValuesLabel()`
`abstract EventListener`	`getOnUserSearchListener()` listener for search, based on the specific implementation
`protected EventListener`	`getRemoveButtonListener()` Listener for removal action for each element at the assigned list
`protected abstract String`	`getSearchInfoBox()` Gets proper label for being presented in search textbox input component
`protected TypeService`	`getTypeService()`
`protected boolean`	`isSingleSelector()`
`protected abstract void`	`parseParams(Map<String,? extends Object> parameters)` prepares input parameters
`protected void`	`prepareCollectionAllItems()` Method prepares the list of available values and applies basic settings
`protected void`	`prepareCollectionAssignedItems()` Method prepares the list of assigned values and applies basic settings
`protected void`	`setResultListData(Listbox collectionItems, List<K> resultList)` Method sets new result list to the proper listbox list.
`void`	`setSingleSelector(boolean singleSelector)`
`protected abstract void`	`updateCollectionAllItems()` updates collection based on proper implementation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - collectionAssignedItems
```
protected Listbox collectionAssignedItems
```
    List of presented assigned values, presented on the right side of component
  - assignedValuesList
```
protected List<K> assignedValuesList
```
    List of assigned values, that list should be taken as a result returned by editor
  - collectionAllItems
```
protected Listbox collectionAllItems
```
    List of presented available values used for rendering listbox, presented on the left side of component
  - singleSelector
```
protected boolean singleSelector
```
    flag for resolving number of assigned values true - there is only one possible result on assigned list, new assignment overwrites the old one false - new assignment is added to the list
  - inputComponentDiv
```
protected SearchTextboxDiv inputComponentDiv
```
    Search field presented in editor. Requires proper label presented inside the field as an argument in constructor.
- Constructor Detail
  - AbstractDualListboxEditor
```
public AbstractDualListboxEditor(List<K> assignedValuesList)
```
- Method Detail
  - getSearchInfoBox
```
protected abstract String getSearchInfoBox()
```
    Gets proper label for being presented in search textbox input component
  - updateCollectionAllItems
```
protected abstract void updateCollectionAllItems()
```
    updates collection based on proper implementation
  - getOnUserSearchListener
```
public abstract EventListener getOnUserSearchListener()
```
    listener for search, based on the specific implementation
  - parseParams
```
protected abstract void parseParams(Map<String,? extends Object> parameters)
```
    prepares input parameters
  - createComponentView
```
public HtmlBasedComponent createComponentView(Map<String,? extends Object> parameters)
```
  - createInternalComponentView
```
protected Table createInternalComponentView()
```
    Method for main presentation view
  - fillLeftBottomCell
```
protected HtmlBasedComponent fillLeftBottomCell()
```
    Creates left bottom area of the wizard. Holds the listbox of available values, but might be override
  - fillRightBottomCell
```
protected HtmlBasedComponent fillRightBottomCell()
```
    Creates right bottom area of the wizard. Holds the list box of assigned values, but might be override if needed
  - fillMidTopCell
```
protected HtmlBasedComponent fillMidTopCell()
```
    Originally it's just an empty div,but it might be override if you want to present something in that area.
  - fillMidBottomCell
```
protected HtmlBasedComponent fillMidBottomCell()
```
    Used for presenting assign button
  - fillRightTopCell
```
protected HtmlBasedComponent fillRightTopCell()
```
    Originally that area is empty,but might be usd for extending editor usability.
  - fillLeftTopCell
```
protected HtmlBasedComponent fillLeftTopCell()
```
    Area used for presenting search box
  - setResultListData
```
protected void setResultListData(Listbox collectionItems,
                                 List<K> resultList)
```
    Method sets new result list to the proper listbox list. That result list is later used for rendering listbox.
  - createAssignBtn
```
protected Image createAssignBtn()
```
    Method creates the button for assigning values
  - addToAssignedValuesList
```
protected void addToAssignedValuesList(Object obj,
                                       Listitem item)
```
    Method for assigning available values to assigned values list. Used for button and for drag&drop
  - prepareCollectionAssignedItems
```
protected void prepareCollectionAssignedItems()
```
    Method prepares the list of assigned values and applies basic settings
  - prepareCollectionAllItems
```
protected void prepareCollectionAllItems()
```
    Method prepares the list of available values and applies basic settings
  - getRemoveButtonListener
```
protected EventListener getRemoveButtonListener()
```
    Listener for removal action for each element at the assigned list
  - getAvailableCollectionItemListRenderer
```
protected ListitemRenderer getAvailableCollectionItemListRenderer()
```
  - getAssignedCollectionItemListRenderer
```
protected ListitemRenderer getAssignedCollectionItemListRenderer()
```
  - getAvailableValuesLabel
```
protected Label getAvailableValuesLabel()
```
  - getAssignedValuesLabel
```
protected Label getAssignedValuesLabel()
```
  - getAssignedValuesList
```
public List<K> getAssignedValuesList()
```
    Returns:
    
    the assignedValuesList
  - getTypeService
```
protected TypeService getTypeService()
```
  - isSingleSelector
```
protected boolean isSingleSelector()
```
  - setSingleSelector
```
public void setSingleSelector(boolean singleSelector)
```

Class AbstractDualListboxEditor<K>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

collectionAssignedItems

assignedValuesList

collectionAllItems

singleSelector

inputComponentDiv

Constructor Detail

AbstractDualListboxEditor

Method Detail

getSearchInfoBox

updateCollectionAllItems

getOnUserSearchListener

parseParams

createComponentView

createInternalComponentView

fillLeftBottomCell

fillRightBottomCell

fillMidTopCell

fillMidBottomCell

fillRightTopCell

fillLeftTopCell

setResultListData

createAssignBtn

addToAssignedValuesList

prepareCollectionAssignedItems

prepareCollectionAllItems

getRemoveButtonListener

getAvailableCollectionItemListRenderer

getAssignedCollectionItemListRenderer

getAvailableValuesLabel

getAssignedValuesLabel

getAssignedValuesList

getTypeService

isSingleSelector

setSingleSelector