de.hybris.platform.cockpit.model.listview.impl

Class DefaultColumnModel

java.lang.Object

de.hybris.platform.cockpit.model.listview.impl.AbstractColumnModel

de.hybris.platform.cockpit.model.listview.impl.DefaultColumnModel

All Implemented Interfaces:

ColumnModel, MutableColumnModel

public class DefaultColumnModel
extends AbstractColumnModel

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_WIDTH

Fields inherited from class de.hybris.platform.cockpit.model.listview.impl.AbstractColumnModel

listeners

Constructor Summary

Constructors

Constructor and Description
DefaultColumnModel(ListViewConfiguration config)

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnConfiguration columnConfig, DefaultColumnGroup group) Dynamically adds a column to the specified ColumnGroup group if the group exists.
ColumnDescriptor	addColumnToRootGroup(ColumnConfiguration columnConfig) Dynamically adds a column to the root group and returns newly created ColumnDescriptor.
ColumnDescriptor	addDynamicColumnToRootGroup(ColumnConfiguration columnConfig) Dynamically adds a column to the root group, mark it as "dynamic" and returns newly created ColumnDescriptor.
void	addGroup(ColumnGroup group, DefaultColumnGroup parentGroup) Dynamically adds the group group to the specified group parentGroup if the parent group exists.
int	findColumn(ColumnDescriptor colDescr) Returns the index of the column represented by colDescr or -1
protected void	fireColumnMoved(int fromIndex, int toIndex)
protected void	fireColumnVisibilityChanged()
protected void	fireColumnVisibilityChanged(Integer colIndex)
protected void	fireSortChanged(int columnIndex, boolean ascending)
UIEditor	getCellEditor(int columnIndex) Gets the cell editor.
CellRenderer	getCellRenderer(int columnIndex) Gets the cell renderer.
ColumnDescriptor	getColumn(int columnIndex) Returns the column with index columnIndex.
ColumnConfiguration	getColumnConfiguration(ColumnDescriptor columnDescriptor)
List<ColumnDescriptor>	getColumns() Returns all columns (visible and hidden) held by this model.
String	getColumnWidth(ColumnDescriptor colDescr) Gets the column width.
String	getColumnWidth(ColumnDescriptor colDescr, Boolean returnDefault) Gets the column width.
ListViewConfiguration	getConfiguration()
List<ColumnDescriptor>	getHiddenColumns() Returns all the columns which are currently marked as invisible.
List<ColumnDescriptor>	getHiddenLocalizedColumns(ColumnDescriptor colDescr) Gets the hidden localized columns.
ColumnDescriptor	getLocalizedColumn(ColumnDescriptor colDescr, LanguageModel language) Gets the localized column.
protected List<ColumnDescriptor>	getLocalizedColumns(ColumnDescriptor colDescr)
ListViewMenuPopupBuilder	getMenuPopupBuilder() Gets the menu popup builder which is responsible for building table header menu popups.
CellRenderer	getNewInlineItemRenderer(int columnIndex) Gets the new inline item renderer.
protected ColumnDescriptor	getNonLocalizedColumn(ColumnDescriptor colDescr)
PropertyDescriptor	getPropertyDescriptor(ColumnDescriptor colDescr) Returns the property descriptor for a specific column.
ColumnGroup	getRootColumnGroup() Returns the root ColumnGroup i.e.
int	getSelectedIndex() Returns the index of the currently selected column.
List<Integer>	getSelectedIndexes() Returns the indexes of the currently selected columns.
int	getSortedByColumnIndex() Returns the index of the column by which values are currently sorted.
Object	getValueAt(int columnIndex, TypedObject object) Returns the value of the specified object's cell.
ColumnDescriptor	getVisibleColumn(int columnIndex) Returns the visible column at position columnIndex.
List<ColumnDescriptor>	getVisibleColumns() Returns all the columns which are currently marked as visible.
List<ColumnDescriptor>	getVisibleLocalizedColumns(ColumnDescriptor colDescr) Gets the visible localized columns.
boolean	hideColumn(int columnIndex) Hide column.
boolean	isColumnLocalized(ColumnDescriptor colDescr) Checks if is column localized.
boolean	isColumnSelected(int columnIndex) Returns whether the column with index columnIndex is selected or not.
boolean	isSortAscending() Returns the sort order of the column by which values are currently sorted.
boolean	moveColumn(int fromIndex, int toIndex) Move column.
void	setSelectedIndex(int index) Sets the selected index.
boolean	setSelectedIndexDirectly(int index) Sets the selected index directly.
void	setSelectedIndexes(List<Integer> indexes) Sets the selected indexes.
boolean	setSelectedIndexesDirectly(List<Integer> indexes) Sets the selected indexes directly.
void	setSortAscending(boolean ascending) Sets the sort ascending.
void	setSortedColumnIndex(int columnIndex, boolean ascending) Sets the sorted column index.
void	setValueAt(int columnIndex, TypedObject object, Object value) Sets the value at.
void	setVisibleColumns(List<ColumnDescriptor> columns, boolean force) Sets the visible columns.
boolean	showColumn(ColumnDescriptor column, Integer colIndex) Show column.
protected boolean	showColumnDirectly(ColumnDescriptor column)
protected void	updateConfiguration()
void	updateDynamicColumns(ListModel listModel) Update dynamic columns.

Methods inherited from class de.hybris.platform.cockpit.model.listview.impl.AbstractColumnModel

addColumnModelListener, fireChanged, fireColumnSelectionChanged, removeColumnModelListener

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

protected static final String DEFAULT_WIDTH

See Also:

Constant Field Values

Constructor Detail

DefaultColumnModel

public DefaultColumnModel(ListViewConfiguration config)

Method Detail

getConfiguration

public ListViewConfiguration getConfiguration()

getColumnConfiguration

public ColumnConfiguration getColumnConfiguration(ColumnDescriptor columnDescriptor)

setSelectedIndex

public void setSelectedIndex(int index)

Description copied from interface: MutableColumnModel

Sets the selected index.

Parameters:

index - the new selected index

setSelectedIndexDirectly

public boolean setSelectedIndexDirectly(int index)

Description copied from interface: MutableColumnModel

Sets the selected index directly.

Parameters:

index - the index

Returns:

true, if successful

setSelectedIndexes

public void setSelectedIndexes(List<Integer> indexes)

Description copied from interface: MutableColumnModel

Sets the selected indexes.

Parameters:

indexes - the new selected indexes

setSelectedIndexesDirectly

public boolean setSelectedIndexesDirectly(List<Integer> indexes)

Description copied from interface: MutableColumnModel

Sets the selected indexes directly.

Parameters:

indexes - the selected indexes

Returns:

true, if successful

setVisibleColumns

public void setVisibleColumns(List<ColumnDescriptor> columns,
                              boolean force)

Description copied from interface: MutableColumnModel

Sets the visible columns.

Parameters:

columns - the vis cols

force - the force

hideColumn

public boolean hideColumn(int columnIndex)

Description copied from interface: MutableColumnModel

Hide column.

Parameters:

columnIndex - the col index

Returns:

true, if successful

showColumn

public boolean showColumn(ColumnDescriptor column,
                          Integer colIndex)

Description copied from interface: MutableColumnModel

Show column.

Parameters:

column - the col descr

colIndex - the col index

Returns:

true, if successful

showColumnDirectly

protected boolean showColumnDirectly(ColumnDescriptor column)

getPropertyDescriptor

public PropertyDescriptor getPropertyDescriptor(ColumnDescriptor colDescr)

Returns the property descriptor for a specific column.

Parameters:

colDescr - the col descr

Returns:

the PropertyDescriptor which the column colDescr represents or null if the column does not represent a property column

moveColumn

public boolean moveColumn(int fromIndex,
                          int toIndex)

Description copied from interface: MutableColumnModel

Move column.

Parameters:

fromIndex - the from index

toIndex - the to index

Returns:

true, if successful

getSortedByColumnIndex

public int getSortedByColumnIndex()

Description copied from interface: ColumnModel

Returns the index of the column by which values are currently sorted.

Returns:

zero based position index of the column by which values are currently sorted

See Also:

ColumnModel.isSortAscending()

setSortedColumnIndex

public void setSortedColumnIndex(int columnIndex,
                                 boolean ascending)

Description copied from interface: MutableColumnModel

Sets the sorted column index.

Parameters:

columnIndex - the col index

ascending - the ascending

setSortAscending

public void setSortAscending(boolean ascending)

Description copied from interface: MutableColumnModel

Sets the sort ascending.

Parameters:

ascending - the new sort ascending

isSortAscending

public boolean isSortAscending()

Description copied from interface: ColumnModel

Returns the sort order of the column by which values are currently sorted.

Returns:

true if the sort order is ascending, false otherwise

See Also:

ColumnModel.getSortedByColumnIndex()

findColumn

public int findColumn(ColumnDescriptor colDescr)

Description copied from interface: ColumnModel

Returns the index of the column represented by colDescr or -1

Parameters:

colDescr - column which index should be retrieved

Returns:

the zero based position index of the column with the specified name

getColumn

public ColumnDescriptor getColumn(int columnIndex)

Description copied from interface: ColumnModel

Returns the column with index columnIndex.

Parameters:

columnIndex - the zero based position index of column to be returned

Returns:

the column at position columnIndex

See Also:

ColumnModel.getVisibleColumn(int)

getVisibleColumn

public ColumnDescriptor getVisibleColumn(int columnIndex)

Description copied from interface: ColumnModel

Returns the visible column at position columnIndex.

Parameters:

columnIndex - the zero based position index of the visible column to be returned

Returns:

the visible column at position columnIndex

See Also:

ColumnModel.getColumn(int)

getColumns

public List<ColumnDescriptor> getColumns()

Description copied from interface: ColumnModel

Returns all columns (visible and hidden) held by this model.

Returns:

all the columns held by this model

getRootColumnGroup

public ColumnGroup getRootColumnGroup()

Description copied from interface: ColumnModel

Returns the root ColumnGroup i.e. the column group which holds all other groups and columns, held by this model.

Returns:

the root column group node held by this model

getSelectedIndex

public int getSelectedIndex()

Description copied from interface: ColumnModel

Returns the index of the currently selected column.

Returns:

zero based position index of the currently selected column

getSelectedIndexes

public List<Integer> getSelectedIndexes()

Description copied from interface: ColumnModel

Returns the indexes of the currently selected columns.

Returns:

a list containing zero based position indexes of the currently selected columns

getVisibleColumns

public List<ColumnDescriptor> getVisibleColumns()

Description copied from interface: ColumnModel

Returns all the columns which are currently marked as visible.

Returns:

all the visible columns

getHiddenColumns

public List<ColumnDescriptor> getHiddenColumns()

Description copied from interface: ColumnModel

Returns all the columns which are currently marked as invisible.

Returns:

all the hidden columns

isColumnSelected

public boolean isColumnSelected(int columnIndex)

Description copied from interface: ColumnModel

Returns whether the column with index columnIndex is selected or not.

Parameters:

columnIndex - zero based position index of the column which selection status is to be retrieved

Returns:

true if a column at position columnIndex exists and is marked as selected, false otherwise

getValueAt

public Object getValueAt(int columnIndex,
                         TypedObject object)

Description copied from interface: ColumnModel

Returns the value of the specified object's cell.

Parameters:

columnIndex - zero based column position index of the cell which value is to be returned

object - the object which cell's value is to be returned

Returns:

the value at

setValueAt

public void setValueAt(int columnIndex,
                       TypedObject object,
                       Object value)
                throws ValueHandlerException

Description copied from interface: MutableColumnModel

Sets the value at.

Parameters:

columnIndex - the col index

object - the item

value - the value

Throws:

ValueHandlerException - the value handler exception

getCellEditor

public UIEditor getCellEditor(int columnIndex)

Description copied from interface: ColumnModel

Gets the cell editor.

Parameters:

columnIndex - the column index

Returns:

the cell editor

getCellRenderer

public CellRenderer getCellRenderer(int columnIndex)

Description copied from interface: ColumnModel

Gets the cell renderer.

Parameters:

columnIndex - the column index

Returns:

the cell renderer

getNewInlineItemRenderer

public CellRenderer getNewInlineItemRenderer(int columnIndex)

Description copied from interface: ColumnModel

Gets the new inline item renderer.

Parameters:

columnIndex - the column index

Returns:

the new inline item render

addColumn

public void addColumn(ColumnConfiguration columnConfig,
                      DefaultColumnGroup group)

Dynamically adds a column to the specified ColumnGroup group if the group exists.

Parameters:

columnConfig - the column to add

group - the group to which the column is to be added

addColumnToRootGroup

public ColumnDescriptor addColumnToRootGroup(ColumnConfiguration columnConfig)

Dynamically adds a column to the root group and returns newly created ColumnDescriptor.

Parameters:

columnConfig - the column config

Returns:

the column descriptor

addDynamicColumnToRootGroup

public ColumnDescriptor addDynamicColumnToRootGroup(ColumnConfiguration columnConfig)

Dynamically adds a column to the root group, mark it as "dynamic" and returns newly created ColumnDescriptor.

Parameters:

columnConfig - the column config

Returns:

the column descriptor

addGroup

public void addGroup(ColumnGroup group,
                     DefaultColumnGroup parentGroup)

Dynamically adds the group group to the specified group parentGroup if the parent group exists.

Parameters:

group - the group to add

parentGroup - the parent group to which the group is to be added

getHiddenLocalizedColumns

public List<ColumnDescriptor> getHiddenLocalizedColumns(ColumnDescriptor colDescr)

Description copied from interface: ColumnModel

Gets the hidden localized columns.

Parameters:

colDescr - the col descr

Returns:

the hidden localized columns

getVisibleLocalizedColumns

public List<ColumnDescriptor> getVisibleLocalizedColumns(ColumnDescriptor colDescr)

Description copied from interface: ColumnModel

Gets the visible localized columns.

Parameters:

colDescr - the col descr

Returns:

the visible localized columns

isColumnLocalized

public boolean isColumnLocalized(ColumnDescriptor colDescr)

Description copied from interface: ColumnModel

Checks if is column localized.

Parameters:

colDescr - the col descr

Returns:

true, if is column localized

getLocalizedColumn

public ColumnDescriptor getLocalizedColumn(ColumnDescriptor colDescr,
                                           LanguageModel language)

Description copied from interface: ColumnModel

Gets the localized column.

Parameters:

colDescr - the col descr

language - the lang

Returns:

the localized column

getLocalizedColumns

protected List<ColumnDescriptor> getLocalizedColumns(ColumnDescriptor colDescr)

getNonLocalizedColumn

protected ColumnDescriptor getNonLocalizedColumn(ColumnDescriptor colDescr)

getColumnWidth

public String getColumnWidth(ColumnDescriptor colDescr)

Description copied from interface: ColumnModel

Gets the column width.

Parameters:

colDescr - the col descr

Returns:

the column width

getColumnWidth

public String getColumnWidth(ColumnDescriptor colDescr,
                             Boolean returnDefault)

Description copied from interface: ColumnModel

Gets the column width.

Parameters:

colDescr - the col descr

returnDefault - the return default

Returns:

the column width

updateConfiguration

protected void updateConfiguration()

fireColumnMoved

protected void fireColumnMoved(int fromIndex,
                               int toIndex)

Overrides:

fireColumnMoved in class AbstractColumnModel

fireColumnVisibilityChanged

protected void fireColumnVisibilityChanged()

Overrides:

fireColumnVisibilityChanged in class AbstractColumnModel

fireColumnVisibilityChanged

protected void fireColumnVisibilityChanged(Integer colIndex)

Overrides:

fireColumnVisibilityChanged in class AbstractColumnModel

fireSortChanged

protected void fireSortChanged(int columnIndex,
                               boolean ascending)

Overrides:

fireSortChanged in class AbstractColumnModel

getMenuPopupBuilder

public ListViewMenuPopupBuilder getMenuPopupBuilder()

Description copied from interface: ColumnModel

Gets the menu popup builder which is responsible for building table header menu popups.

Returns:

the menu popup builder

updateDynamicColumns

public void updateDynamicColumns(ListModel listModel)

Description copied from interface: MutableColumnModel

Update dynamic columns.

Parameters:

listModel - the list model