GroupByCellTextPainter (Nebula NatTable 2.0.0-SNAPSHOT API)

java.lang.Object
- org.eclipse.nebula.widgets.nattable.painter.cell.AbstractCellPainter
- - org.eclipse.nebula.widgets.nattable.painter.cell.CellPainterWrapper
  - - org.eclipse.nebula.widgets.nattable.painter.cell.BackgroundPainter
    - - org.eclipse.nebula.widgets.nattable.painter.cell.AbstractTextPainter
      - org.eclipse.nebula.widgets.nattable.painter.cell.TextPainter
        
        org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy.GroupByCellTextPainter

All Implemented Interfaces:

ICellPainter
```
public class GroupByCellTextPainter
extends TextPainter
```
Specialized TextPainter that is used for grouping rows. It will only render text in the tree column and in columns that contain group by summary values.
Extracted to a separate class to be able to create theme configurations where you are able to wrap this painter easily, instead of creating similar inner classes all the time.

Field Summary
- Fields inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.AbstractTextPainter
  calculateByTextHeight, calculateByTextLength, DOT, EMPTY, LINE_SEPARATOR, lineSpacing, NEW_LINE_REGEX, paintBg, paintFg, spacing, wordWrapping, wrapText

Constructor Summary

Constructors
Constructor Description

GroupByCellTextPainter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getTextToDisplay(ILayerCell cell, org.eclipse.swt.graphics.GC gc, int availableLength, String text)`	Computes dependent on the configuration of the TextPainter the text to display.

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.TextPainter
calculatePadding, getPreferredHeight, getPreferredWidth, isCalculateWrappedHeight, paintCell, performRowResize, setCalculateWrappedHeight, setNewMinLength

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.AbstractTextPainter
convertDataType, getLengthFromCache, getLineSpacing, getNumberOfNewLines, isCalculateByTextHeight, isCalculateByTextLength, isTrimText, isWordWrapping, isWrapText, paintDecoration, renderStrikethrough, renderUnderlined, resetGC, setCalculateByTextHeight, setCalculateByTextLength, setLineSpacing, setStrikethrough, setTrimText, setUnderline, setupGCFromConfig, setWordWrapping, setWrapText

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.BackgroundPainter
getBackgroundColour

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.CellPainterWrapper
getCellPainterAt, getWrappedPainter, getWrappedPainterBounds, setWrappedPainter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupByCellTextPainter
```
public GroupByCellTextPainter()
```
- Method Detail
  - getTextToDisplay
```
protected String getTextToDisplay(ILayerCell cell,
                                  org.eclipse.swt.graphics.GC gc,
                                  int availableLength,
                                  String text)
```
    Description copied from class: AbstractTextPainter
    
    Computes dependent on the configuration of the TextPainter the text to display. If word wrapping is enabled new lines are inserted if the available space is not enough. If calculation of available space is enabled, the space is automatically widened for the text to display, and if no calculation is enabled the text is cut and modified to end with "..." to fit into the available space
    
    Overrides:
    
    getTextToDisplay in class AbstractTextPainter
    
    Parameters:
    
    cell - the current cell to paint
    
    gc - the current GC
    
    availableLength - the available space for the text to display
    
    text - the text that should be modified for display
    
    Returns:
    
    the modified text