de.hybris.platform.cscockpit.services.config.impl

Class AbstractSimpleCustomColumnConfiguration<S,I extends ItemModel>

java.lang.Object

de.hybris.platform.cockpit.services.config.impl.AbstractColumnConfiguration

de.hybris.platform.cockpit.services.config.impl.DefaultCustomColumnConfiguration

de.hybris.platform.cscockpit.services.config.impl.AbstractSimpleCustomColumnConfiguration<S,I>

All Implemented Interfaces:

ColumnConfiguration, MutableColumnConfiguration

Direct Known Subclasses:

AbstractCustomerNameCustomColumn, AbstractProductCustomColumn, AgentGroupColumn, PaymentTransactionEntryCurrencyAmountColumn, TicketDurationColumn

public abstract class AbstractSimpleCustomColumnConfiguration<S,I extends ItemModel>
extends DefaultCustomColumnConfiguration

Base class for custom columns. A custom column can be created by overriding the getItemValue(I, java.util.Locale) method to return the value for the column for the item specified. A custom column can be configured in a cockpit XML configuration file. A custom XML element can be placed in the configuration file to load the column. For example:

    
       Amount
    
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractSimpleCustomColumnConfiguration.SimpleCustomColumnValueHandler

Field Summary

Fields inherited from class de.hybris.platform.cockpit.services.config.impl.AbstractColumnConfiguration

editable, editor, name, selectable, sortable, visible

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimpleCustomColumnConfiguration()

Method Summary

Modifier and Type	Method and Description
UIEditor	getCellEditor()
CellRenderer	getCellRenderer()
DefaultColumnDescriptor	getColumnDescriptor()
protected abstract S	getItemValue(I item, java.util.Locale locale) Override this method to lookup the value for this column.
ValueHandler	getValueHandler()

Methods inherited from class de.hybris.platform.cockpit.services.config.impl.DefaultCustomColumnConfiguration

getAllLabels, getLabel, getLabel, getName, setAllLabels, setCellEditor, setLanguages

Methods inherited from class de.hybris.platform.cockpit.services.config.impl.AbstractColumnConfiguration

getEditor, getLanguages, getParameter, getParameters, getPosition, getWidth, isEditable, isLocalized, isSelectable, isSortable, isVisible, setCellRenderer, setEditable, setEditor, setName, setParameter, setParameters, setPosition, setSelectable, setSortable, setVisible, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSimpleCustomColumnConfiguration

protected AbstractSimpleCustomColumnConfiguration()

Method Detail

getCellEditor

public UIEditor getCellEditor()

Specified by:

getCellEditor in interface ColumnConfiguration

Overrides:

getCellEditor in class DefaultCustomColumnConfiguration

getCellRenderer

public CellRenderer getCellRenderer()

Specified by:

getCellRenderer in interface ColumnConfiguration

Overrides:

getCellRenderer in class AbstractColumnConfiguration

getColumnDescriptor

public DefaultColumnDescriptor getColumnDescriptor()

Specified by:

getColumnDescriptor in interface ColumnConfiguration

Overrides:

getColumnDescriptor in class DefaultCustomColumnConfiguration

getValueHandler

public ValueHandler getValueHandler()

Specified by:

getValueHandler in interface ColumnConfiguration

Overrides:

getValueHandler in class DefaultCustomColumnConfiguration

getItemValue

protected abstract S getItemValue(I item,
                                  java.util.Locale locale)
                           throws ValueHandlerException

Override this method to lookup the value for this column.

Parameters:

item - The item that this column is looked up on

locale - the display local

Returns:

the value to display for this column

Throws:

ValueHandlerException - thrown or error