/*******************************************************************************
* Copyright (c) 2012, 2013 Original authors and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Original authors and others - initial API and implementation
******************************************************************************/
package org.eclipse.nebula.widgets.nattable.group;
import java.util.List;
import java.util.Properties;
import org.eclipse.nebula.widgets.nattable.NatTable;
import org.eclipse.nebula.widgets.nattable.grid.GridRegion;
import org.eclipse.nebula.widgets.nattable.group.ColumnGroupModel.ColumnGroup;
import org.eclipse.nebula.widgets.nattable.group.config.DefaultColumnGroupHeaderLayerConfiguration;
import org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform;
import org.eclipse.nebula.widgets.nattable.layer.DataLayer;
import org.eclipse.nebula.widgets.nattable.layer.LabelStack;
import org.eclipse.nebula.widgets.nattable.layer.SizeConfig;
import org.eclipse.nebula.widgets.nattable.layer.cell.ILayerCell;
import org.eclipse.nebula.widgets.nattable.layer.cell.LayerCell;
import org.eclipse.nebula.widgets.nattable.selection.SelectionLayer;
import org.eclipse.nebula.widgets.nattable.style.DisplayMode;
/**
* Adds the Column grouping functionality to the column headers. Also persists
* the state of the column groups when
* {@link NatTable#saveState(String, Properties)} is invoked.
*
* Internally uses the {@link ColumnGroupModel} to track the column groups.
* <p>
* See ColumnGroupGridExample
*/
public class ColumnGroupGroupHeaderLayer extends AbstractLayerTransform {
private final SizeConfig rowHeightConfig = new SizeConfig(
DataLayer.DEFAULT_ROW_HEIGHT);
private final ColumnGroupModel model;
private final ColumnGroupHeaderLayer columnGroupHeaderLayer;
public ColumnGroupGroupHeaderLayer(
ColumnGroupHeaderLayer columnGroupHeaderLayer,
SelectionLayer selectionLayer, ColumnGroupModel columnGroupModel) {
this(columnGroupHeaderLayer, selectionLayer, columnGroupModel, true);
}
public ColumnGroupGroupHeaderLayer(
ColumnGroupHeaderLayer columnGroupHeaderLayer,
SelectionLayer selectionLayer, ColumnGroupModel columnGroupModel,
boolean useDefaultConfiguration) {
super(columnGroupHeaderLayer);
this.columnGroupHeaderLayer = columnGroupHeaderLayer;
this.model = columnGroupModel;
if (useDefaultConfiguration) {
addConfiguration(new DefaultColumnGroupHeaderLayerConfiguration(
columnGroupModel));
}
}
// Vertical features
// Rows
@Override
public int getRowCount() {
return columnGroupHeaderLayer.getRowCount() + 1;
}
@Override
public int getPreferredRowCount() {
return columnGroupHeaderLayer.getPreferredRowCount() + 1;
}
@Override
public int getRowIndexByPosition(int rowPosition) {
if (rowPosition == 0) {
return rowPosition;
} else {
return columnGroupHeaderLayer
.getRowIndexByPosition(rowPosition - 1);
}
}
// Height
@Override
public int getHeight() {
return rowHeightConfig.getAggregateSize(1)
+ columnGroupHeaderLayer.getHeight();
}
@Override
public int getPreferredHeight() {
return rowHeightConfig.getAggregateSize(1)
+ columnGroupHeaderLayer.getPreferredHeight();
}
@Override
public int getRowHeightByPosition(int rowPosition) {
if (rowPosition == 0) {
return rowHeightConfig.getSize(rowPosition);
} else {
return columnGroupHeaderLayer
.getRowHeightByPosition(rowPosition - 1);
}
}
public void setRowHeight(int rowHeight) {
this.rowHeightConfig.setSize(0, rowHeight);
}
// Row resize
@Override
public boolean isRowPositionResizable(int rowPosition) {
if (rowPosition == 0) {
return rowHeightConfig.isPositionResizable(rowPosition);
} else {
return columnGroupHeaderLayer
.isRowPositionResizable(rowPosition - 1);
}
}
// Y
@Override
public int getRowPositionByY(int y) {
int row0Height = getRowHeightByPosition(0);
if (y < row0Height) {
return 0;
} else {
return 1 + columnGroupHeaderLayer.getRowPositionByY(y - row0Height);
}
}
@Override
public int getStartYOfRowPosition(int rowPosition) {
if (rowPosition == 0) {
return rowHeightConfig.getAggregateSize(rowPosition);
} else {
return getRowHeightByPosition(0)
+ columnGroupHeaderLayer
.getStartYOfRowPosition(rowPosition - 1);
}
}
// Cell features
/**
* If a cell belongs to a column group: column position - set to the start
* position of the group span - set to the width/size of the column group
*
* NOTE: gc.setClip() is used in the CompositeLayerPainter to ensure that
* partially visible Column group header cells are rendered properly.
*/
@Override
public ILayerCell getCellByPosition(int columnPosition, int rowPosition) {
int bodyColumnIndex = getColumnIndexByPosition(columnPosition);
if (rowPosition == 0) {
if (model.isPartOfAGroup(bodyColumnIndex)) {
return new LayerCell(this,
getStartPositionOfGroup(columnPosition), rowPosition,
columnPosition, rowPosition,
getColumnSpan(columnPosition), 1);
} else {
ILayerCell underlyingCell = columnGroupHeaderLayer
.getCellByPosition(columnPosition, rowPosition);
return new LayerCell(this,
underlyingCell.getOriginColumnPosition(),
underlyingCell.getOriginRowPosition(), columnPosition,
rowPosition, underlyingCell.getColumnSpan(),
underlyingCell.getRowSpan() + 1);
}
} else if (rowPosition == 1) {
ILayerCell underlyingCell = columnGroupHeaderLayer
.getCellByPosition(columnPosition, rowPosition - 1);
boolean partOfAGroup = model.isPartOfAGroup(bodyColumnIndex);
return new LayerCell(this,
underlyingCell.getOriginColumnPosition(),
underlyingCell.getOriginRowPosition()
+ (partOfAGroup ? 1 : 0), columnPosition,
rowPosition, underlyingCell.getColumnSpan(),
underlyingCell.getRowSpan() + (partOfAGroup ? 0 : 1));
} else if (rowPosition == 2) {
ILayerCell underlyingCell = columnGroupHeaderLayer
.getCellByPosition(columnPosition, rowPosition - 1);
boolean partOfAGroup = model.isPartOfAGroup(bodyColumnIndex)
|| columnGroupHeaderLayer.isColumnInGroup(bodyColumnIndex);
return new LayerCell(this,
underlyingCell.getOriginColumnPosition(),
underlyingCell.getOriginRowPosition()
+ (partOfAGroup ? 1 : 0), columnPosition,
rowPosition, underlyingCell.getColumnSpan(),
underlyingCell.getRowSpan() + (partOfAGroup ? 0 : 1));
}
return null;
}
/**
* Calculates the span of a cell in a Column Group. Takes into account
* collapsing and hidden columns in the group.
*
* @param columnPosition
* position of any column belonging to the group
*/
protected int getColumnSpan(int columnPosition) {
int columnIndex = getColumnIndexByPosition(columnPosition);
ColumnGroup columnGroup = model.getColumnGroupByIndex(columnIndex);
int sizeOfGroup = columnGroup.getSize();
if (columnGroup.isCollapsed()) {
int sizeOfStaticColumns = columnGroup.getStaticColumnIndexes()
.size();
if (sizeOfStaticColumns == 0) {
return 1;
} else {
sizeOfGroup = sizeOfStaticColumns;
}
}
int startPositionOfGroup = getStartPositionOfGroup(columnPosition);
int endPositionOfGroup = startPositionOfGroup + sizeOfGroup;
List<Integer> columnIndexesInGroup = columnGroup.getMembers();
for (int i = startPositionOfGroup; i < endPositionOfGroup; i++) {
int index = getColumnIndexByPosition(i);
if (!columnIndexesInGroup.contains(Integer.valueOf(index))) {
sizeOfGroup--;
}
}
return sizeOfGroup;
}
/**
* Figures out the start position of the group.
*
* @param selectionLayerColumnPosition
* of any column belonging to the group
* @return first position of the column group
*/
private int getStartPositionOfGroup(int columnPosition) {
int bodyColumnIndex = getColumnIndexByPosition(columnPosition);
ColumnGroup columnGroup = model.getColumnGroupByIndex(bodyColumnIndex);
int leastPossibleStartPositionOfGroup = columnPosition
- columnGroup.getSize();
int i = 0;
for (i = leastPossibleStartPositionOfGroup; i < columnPosition; i++) {
if (ColumnGroupUtils.isInTheSameGroup(getColumnIndexByPosition(i),
bodyColumnIndex, model)) {
break;
}
}
return i;
}
@Override
public String getDisplayModeByPosition(int columnPosition, int rowPosition) {
int columnIndex = getColumnIndexByPosition(columnPosition);
if (rowPosition == 0 && model.isPartOfAGroup(columnIndex)) {
return DisplayMode.NORMAL;
} else {
return columnGroupHeaderLayer.getDisplayModeByPosition(
columnPosition, rowPosition);
}
}
@Override
public LabelStack getConfigLabelsByPosition(int columnPosition,
int rowPosition) {
int columnIndex = getColumnIndexByPosition(columnPosition);
if (rowPosition == 0 && model.isPartOfAGroup(columnIndex)) {
LabelStack stack = new LabelStack(GridRegion.COLUMN_GROUP_HEADER);
if (model.isPartOfACollapseableGroup(columnIndex)) {
ColumnGroup group = model.getColumnGroupByIndex(columnIndex);
if (group.isCollapsed()) {
stack.addLabelOnTop(DefaultColumnGroupHeaderLayerConfiguration.GROUP_COLLAPSED_CONFIG_TYPE);
} else {
stack.addLabelOnTop(DefaultColumnGroupHeaderLayerConfiguration.GROUP_EXPANDED_CONFIG_TYPE);
}
}
return stack;
} else {
if (rowPosition != 0) {
rowPosition--;
}
return columnGroupHeaderLayer.getConfigLabelsByPosition(
columnPosition, rowPosition);
}
}
@Override
public Object getDataValueByPosition(int columnPosition, int rowPosition) {
int columnIndex = getColumnIndexByPosition(columnPosition);
ColumnGroup columnGroup = model.getColumnGroupByIndex(columnIndex);
if (rowPosition == 0) {
if (model.isPartOfAGroup(columnIndex)) {
return columnGroup.getName();
}
} else {
rowPosition--;
}
return columnGroupHeaderLayer.getDataValueByPosition(columnPosition,
rowPosition);
}
@Override
public LabelStack getRegionLabelsByXY(int x, int y) {
int columnIndex = getColumnIndexByPosition(getColumnPositionByX(x));
if (model.isPartOfAGroup(columnIndex) && y < getRowHeightByPosition(0)) {
return new LabelStack(GridRegion.COLUMN_GROUP_HEADER);
} else {
return columnGroupHeaderLayer.getRegionLabelsByXY(x, y
- getRowHeightByPosition(0));
}
}
// ColumnGroupModel delegates
public void addColumnsIndexesToGroup(String colGroupName, int... colIndexes) {
model.addColumnsIndexesToGroup(colGroupName, colIndexes);
}
public void clearAllGroups() {
model.clear();
}
public void setStaticColumnIndexesByGroup(String colGroupName,
int... staticColumnIndexes) {
model.setStaticColumnIndexesByGroup(colGroupName, staticColumnIndexes);
}
public boolean isColumnInGroup(int bodyColumnIndex) {
return model.isPartOfAGroup(bodyColumnIndex);
}
/**
* @see ColumnGroup#setUnbreakable(boolean)
*/
public void setGroupUnbreakable(int columnIndex) {
ColumnGroup columnGroup = model.getColumnGroupByIndex(columnIndex);
columnGroup.setUnbreakable(true);
}
public void setGroupAsCollapsed(int columnIndex) {
ColumnGroup columnGroup = model.getColumnGroupByIndex(columnIndex);
columnGroup.setCollapsed(true);
}
}