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

Class RowGroupExpandCollapseLayer<T>

java.lang.Object

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

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

org.eclipse.nebula.widgets.nattable.hideshow.AbstractRowHideShowLayer

org.eclipse.nebula.widgets.nattable.group.RowGroupExpandCollapseLayer<T>

All Implemented Interfaces:

IRowGroupModelListener, ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

public class RowGroupExpandCollapseLayer<T>
extends AbstractRowHideShowLayer
implements IRowGroupModelListener

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
RowGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer, IRowGroupModel<T> model)

Method Summary

Modifier and Type	Method	Description
Collection<Integer>	getHiddenRowIndexes()	Will collect and return all indexes of the rows that are hidden in this layer.
int[]	getHiddenRowIndexesArray()	Will collect and return all indexes of the rows that are hidden in this layer.
IRowGroupModel<T>	getModel()
boolean	hasHiddenRows()	Check if this layer actively hides rows.
protected void	invalidateCache()	Invalidate the cache to ensure that information is rebuild.
boolean	isRowIndexHidden(int rowIndex)	Will check if the row at the specified index is hidden or not.
void	rowGroupModelChanged()

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

cacheVisibleRowIndexes, doCommand, getCellByPosition, getColumnPositionByIndex, getHeight, getRowCount, getRowIndexByPosition, getRowPositionByIndex, getRowPositionByY, getRowPositionsByIndexes, getRowPositionsByIndexes, getStartYOfRowPosition, getUnderlyingLayer, handleLayerEvent, localToUnderlyingRowPosition, underlyingToLocalRowPosition, underlyingToLocalRowPositions

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

configure, dispose, getCellPainter, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowHeightByPosition, getStartXOfColumnPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, isColumnPositionResizable, isDynamicSizeLayer, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, saveState, setClientAreaProvider, setUnderlyingLayer, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions

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, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getProvidedLabels, getRegionLabelsByXY, getRowHeightByPosition, getStartXOfColumnPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, hasLayerListener, isColumnPositionResizable, isDynamicSizeLayer, isRowPositionResizable, localToUnderlyingColumnPosition, registerCommandHandler, registerPersistable, removeLayerListener, setClientAreaProvider, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, unregisterCommandHandler, unregisterPersistable

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

loadState, saveState

Constructor Details

RowGroupExpandCollapseLayer

public RowGroupExpandCollapseLayer(IUniqueIndexLayer underlyingLayer,
 IRowGroupModel<T> model)

Method Details

getModel

public IRowGroupModel<T> getModel()

isRowIndexHidden

public boolean isRowIndexHidden(int rowIndex)

Description copied from class: AbstractRowHideShowLayer

Will check if the row at the specified index is hidden or not. Checks this layer and also the sublayers for the visibility.

Specified by:

isRowIndexHidden in class AbstractRowHideShowLayer

Parameters:

rowIndex - The row index of the row whose visibility state should be checked.

Returns:

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

getHiddenRowIndexes

public Collection<Integer> getHiddenRowIndexes()

Description copied from class: AbstractRowHideShowLayer

Will collect and return all indexes of the rows that are hidden in this layer.

Note: It is not intended that it also collects the row 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 AbstractRowHideShowLayer.getHiddenRowIndexesArray() to avoid unnecessary autoboxing operations.

Specified by:

getHiddenRowIndexes in class AbstractRowHideShowLayer

Returns:

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

getHiddenRowIndexesArray

public int[] getHiddenRowIndexesArray()

Description copied from class: AbstractRowHideShowLayer

Will collect and return all indexes of the rows that are hidden in this layer.

Note: It is not intended that it also collects the row indexes of underlying layers. This would cause issues on calculating positions, as every layer is responsible for those calculations itself.

Specified by:

getHiddenRowIndexesArray in class AbstractRowHideShowLayer

Returns:

All row indexes that are hidden in this layer.

hasHiddenRows

public boolean hasHiddenRows()

Description copied from class: AbstractRowHideShowLayer

Check if this layer actively hides rows.

Specified by:

hasHiddenRows in class AbstractRowHideShowLayer

Returns:

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

rowGroupModelChanged

public void rowGroupModelChanged()

Specified by:

rowGroupModelChanged in interface IRowGroupModelListener

invalidateCache

protected void invalidateCache()

Description copied from class: AbstractRowHideShowLayer

Invalidate the cache to ensure that information is rebuild.

Overrides:

invalidateCache in class AbstractRowHideShowLayer