org.eclipse.nebula.widgets.xviewer

Interface IXViewerLabelProvider

All Known Implementing Classes:

XViewerLabelProvider, XViewerStyledTextLabelProvider

public interface IXViewerLabelProvider

Method Summary

Modifier and Type	Method and Description
void	clearXViewerColumnIndexCache() When columns get re-ordered, need to clear out this cache so indexing can be re-computed
java.lang.Object	getBackingData(java.lang.Object element, org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xViewerColumn, int columnIndex) Returns the backing data object for operations like sorting
int	getColumnGradient(java.lang.Object element, org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xCol, int columnIndex) Return value between 0..100 and cell will show bar graph shading that portion of the cell
java.lang.String	getColumnText(java.lang.Object element, int columnIndex) Returns the label text for the given column of the given element.
java.lang.String	getColumnText(java.lang.Object element, org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xCol, int columnIndex) Returns the label text for the given column of the given element.
org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn	getTreeColumnOffIndex(int columnIndex) Returns XViewerColumn of the given index

Method Detail

getColumnText

java.lang.String getColumnText(java.lang.Object element,
                               int columnIndex)

Returns the label text for the given column of the given element.

getColumnText

java.lang.String getColumnText(java.lang.Object element,
                               org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xCol,
                               int columnIndex)
                        throws java.lang.Exception

Returns the label text for the given column of the given element.

Throws:

java.lang.Exception

getTreeColumnOffIndex

org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn getTreeColumnOffIndex(int columnIndex)

Returns XViewerColumn of the given index

getColumnGradient

int getColumnGradient(java.lang.Object element,
                      org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xCol,
                      int columnIndex)
               throws java.lang.Exception

Return value between 0..100 and cell will show bar graph shading that portion of the cell

Throws:

java.lang.Exception

getBackingData

java.lang.Object getBackingData(java.lang.Object element,
                                org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn xViewerColumn,
                                int columnIndex)
                         throws java.lang.Exception

Returns the backing data object for operations like sorting

Throws:

java.lang.Exception

clearXViewerColumnIndexCache

void clearXViewerColumnIndexCache()

When columns get re-ordered, need to clear out this cache so indexing can be re-computed