Package org.eclipse.nebula.widgets.nattable.group.performance

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.performance.ColumnGroupExpandCollapseLayer

All Implemented Interfaces:

ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

public class ColumnGroupExpandCollapseLayer
extends AbstractColumnHideShowLayer

Layer that is used in combination with the performance ColumnGroupHeaderLayer to support expand/collapse of column groups.

Since:

1.6

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

commandHandlers, eventHandlers, eventHelperLock, layerPainter

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

DOT, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ColumnGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer)

Method Summary

Modifier and Type	Method	Description
boolean	doCommand(ILayerCommand command)	Opportunity to respond to a command as it flows down the stack.
Collection<Integer>	getHiddenColumnIndexes()	Will collect and return all indexes of the columns that are hidden in this layer.
int[]	getHiddenColumnIndexesArray()	Will collect and return all indexes of the columns that are hidden in this layer.
boolean	hasHiddenColumns()	Check if this layer actively hides columns.
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

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

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

configure, dispose, getCellPainter, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeight, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, isColumnPositionResizable, isDynamicSizeLayer, 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, getProvidedLabels, getRegionName, hasLayerListener, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterEventHandler, 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, fireLayerEvent, getBoundsByPosition, getCellPainter, getClientAreaProvider, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeight, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getProvidedLabels, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, hasLayerListener, isColumnPositionResizable, isDynamicSizeLayer, isRowPositionResizable, localToUnderlyingRowPosition, registerCommandHandler, registerPersistable, removeLayerListener, setClientAreaProvider, underlyingToLocalRowPosition, underlyingToLocalRowPositions, unregisterCommandHandler, unregisterPersistable

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

loadState, saveState

Constructor Details

ColumnGroupExpandCollapseLayer

public ColumnGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer)

Method Details

doCommand

public boolean doCommand(ILayerCommand command)

Description copied from interface: ILayer

Opportunity to respond to a command as it flows down the stack. If the layer is not interested in the command it should allow the command to keep traveling down the stack.

Note: Before the layer can process a command it must convert the command to its local coordinates using ILayerCommand.convertToTargetLayer(ILayer)

Specified by:

doCommand in interface ILayer

Overrides:

doCommand in class AbstractColumnHideShowLayer

Parameters:

command - The command to execute.

Returns:

true if the command has been handled and was therefore consumed, false otherwise.

isColumnIndexHidden

public boolean isColumnIndexHidden(int columnIndex)

Description copied from class: AbstractColumnHideShowLayer

Will check if the column at the specified index is hidden or not.

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.

Since 2.0 it is recommended to use AbstractColumnHideShowLayer.getHiddenColumnIndexesArray() to avoid unnecessary autoboxing operations.

Specified by:

getHiddenColumnIndexes in class AbstractColumnHideShowLayer

Returns:

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

getHiddenColumnIndexesArray

public int[] getHiddenColumnIndexesArray()

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:

getHiddenColumnIndexesArray in class AbstractColumnHideShowLayer

Returns:

All column indexes that are hidden in this layer.

hasHiddenColumns

public boolean hasHiddenColumns()

Description copied from class: AbstractColumnHideShowLayer

Check if this layer actively hides columns.

Specified by:

hasHiddenColumns in class AbstractColumnHideShowLayer

Returns:

true if columns are hidden by this layer, false if not.