org.eclipse.nebula.widgets.nattable.group

Class ColumnGroupExpandCollapseLayer

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

org.eclipse.nebula.widgets.nattable.hideshow.AbstractColumnHideShowLayer

org.eclipse.nebula.widgets.nattable.group.ColumnGroupExpandCollapseLayer

All Implemented Interfaces:

IColumnGroupModelListener, ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

public class ColumnGroupExpandCollapseLayer
extends AbstractColumnHideShowLayer
implements IColumnGroupModelListener

Tracks the Expand/Collapse of a Column Group header NOTE: Only relevant when Column Grouping is enabled.

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

underlyingLayer

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

layerPainter

Fields inherited from interface org.eclipse.nebula.widgets.nattable.persistence.IPersistable

DOT, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ColumnGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer, ColumnGroupModel model)

Method Summary

Methods

Modifier and Type	Method and Description
void	columnGroupModelChanged()
Collection<Integer>	getHiddenColumnIndexes() Will collect and return all indexes of the columns that are hidden in this layer.
ColumnGroupModel	getModel()
boolean	isColumnIndexHidden(int columnIndex) Will check if the column at the specified index is hidden or not.

Methods inherited from class org.eclipse.nebula.widgets.nattable.hideshow.AbstractColumnHideShowLayer

getColumnCount, getColumnIndexByPosition, getColumnPositionByIndex, getColumnPositionByX, getColumnPositionsByIndexes, getRowPositionByIndex, getStartXOfColumnPosition, getWidth, handleLayerEvent, invalidateCache, localToUnderlyingColumnPosition, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

configure, dispose, doCommand, getCellByPosition, getCellPainter, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeight, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getStartYOfRowPosition, getUnderlyingLayer, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, isColumnPositionResizable, isRowPositionResizable, loadState, localToUnderlyingRowPosition, saveState, setClientAreaProvider, setUnderlyingLayer, underlyingToLocalRowPosition, underlyingToLocalRowPositions

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

addConfiguration, addLayerListener, clearConfiguration, fireLayerEvent, getBoundsByPosition, getClientAreaProvider, getConfigLabelAccumulator, getRegionName, hasLayerListener, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterPersistable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.ILayer

addLayerListener, configure, dispose, doCommand, fireLayerEvent, getBoundsByPosition, getCellByPosition, getCellPainter, getClientAreaProvider, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeight, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, hasLayerListener, isColumnPositionResizable, isRowPositionResizable, localToUnderlyingRowPosition, registerCommandHandler, registerPersistable, removeLayerListener, setClientAreaProvider, underlyingToLocalRowPosition, underlyingToLocalRowPositions, unregisterCommandHandler, unregisterPersistable

Methods inherited from interface org.eclipse.nebula.widgets.nattable.persistence.IPersistable

loadState, saveState

Constructor Detail

ColumnGroupExpandCollapseLayer

public ColumnGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer,
                              ColumnGroupModel model)

Method Detail

getModel

public ColumnGroupModel getModel()

isColumnIndexHidden

public boolean isColumnIndexHidden(int columnIndex)

Description copied from class: AbstractColumnHideShowLayer

Will check if the column at the specified index is hidden or not. Checks this layer and also the sublayers for the visibility. Note: As the ColumnGroupModel.ColumnGroups are created index based, this method only works correctly with indexes rather than positions.

Specified by:

isColumnIndexHidden in class AbstractColumnHideShowLayer

Parameters:

columnIndex - The column index of the column whose visibility state should be checked.

Returns:

true if the column at the specified index is hidden, false if it is visible.

getHiddenColumnIndexes

public Collection<Integer> getHiddenColumnIndexes()

Description copied from class: AbstractColumnHideShowLayer

Will collect and return all indexes of the columns that are hidden in this layer. Note: It is not intended that it also collects the column indexes of underlying layers. This would cause issues on calculating positions as every layer is responsible for those calculations itself.

Specified by:

getHiddenColumnIndexes in class AbstractColumnHideShowLayer

Returns:

Collection of all column indexes that are hidden in this layer.

columnGroupModelChanged

public void columnGroupModelChanged()

Specified by:

columnGroupModelChanged in interface IColumnGroupModelListener