Package org.eclipse.nebula.widgets.xviewer

Class XViewerStyledTextLabelProvider

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.viewers.BaseLabelProvider
org.eclipse.jface.viewers.CellLabelProvider
org.eclipse.jface.viewers.OwnerDrawLabelProvider
org.eclipse.jface.viewers.StyledCellLabelProvider
org.eclipse.nebula.widgets.xviewer.XViewerStyledTextLabelProvider
All Implemented Interfaces:
org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.IToolTipProvider, IXViewerLabelProvider
public abstract class XViewerStyledTextLabelProvider
extends org.eclipse.jface.viewers.StyledCellLabelProvider
implements IXViewerLabelProvider

  • Field Summary

    Fields inherited from class org.eclipse.jface.viewers.StyledCellLabelProvider

    COLORS_ON_SELECTION, NO_FOCUS

  • Constructor Summary

    Constructors 
    Constructor Description
    XViewerStyledTextLabelProvider​(XViewer viewer)
    Creates a XViewerStyledTextLabelProvider that delegates the requests for the styled labels and the images to a DelegatingStyledCellLabelProvider.IStyledLabelProvider.

  • Method Summary

    Modifier and Type Method Description
    void clearXViewerColumnIndexCache()
    When columns get re-ordered, need to clear out this cache so indexing can be re-computed
    abstract org.eclipse.swt.graphics.Color getBackground​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex)  
    java.lang.Object getBackingData​(java.lang.Object element, XViewerColumn xViewerColumn, int columnIndex)
    Returns the backing data object for operations like sorting
    int getColumnGradient​(java.lang.Object element, XViewerColumn xCol, int columnIndex)
    Return value between 0..100 and cell will show bar graph shading that portion of the cell
    org.eclipse.swt.graphics.Image getColumnImage​(java.lang.Object element, int columnIndex)  
    abstract org.eclipse.swt.graphics.Image getColumnImage​(java.lang.Object element, XViewerColumn xCol, int column)  
    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, XViewerColumn xCol, int column)
    Returns the label text for the given column of the given element.
    abstract org.eclipse.swt.graphics.Font getFont​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex)  
    abstract org.eclipse.swt.graphics.Color getForeground​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex)  
    (package private) org.eclipse.jface.viewers.StyledString getStyledText​(java.lang.Object element, int columnIndex)  
    abstract org.eclipse.jface.viewers.StyledString getStyledText​(java.lang.Object element, XViewerColumn xCol, int column)  
    XViewerColumn getTreeColumnOffIndex​(int columnIndex)
    Returns XViewerColumn of the given index
    void update​(org.eclipse.jface.viewers.ViewerCell cell)  

    Methods inherited from class org.eclipse.jface.viewers.StyledCellLabelProvider

    dispose, erase, getColumn, getViewer, initialize, isOwnerDrawEnabled, measure, paint, prepareStyleRange, setOwnerDrawEnabled, styleDecoratedString

    Methods inherited from class org.eclipse.jface.viewers.OwnerDrawLabelProvider

    dispose, initialize, setOwnerDrawEnabled, setUpOwnerDraw

    Methods inherited from class org.eclipse.jface.viewers.CellLabelProvider

    getToolTipBackgroundColor, getToolTipDisplayDelayTime, getToolTipFont, getToolTipForegroundColor, getToolTipImage, getToolTipShift, getToolTipStyle, getToolTipText, getToolTipTimeDisplayed, useNativeToolTip

    Methods inherited from class org.eclipse.jface.viewers.BaseLabelProvider

    addListener, fireLabelProviderChanged, isLabelProperty, removeListener

    Methods inherited from class org.eclipse.core.commands.common.EventManager

    addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • XViewerStyledTextLabelProvider

      public XViewerStyledTextLabelProvider​(XViewer viewer)
      Creates a XViewerStyledTextLabelProvider that delegates the requests for the styled labels and the images to a DelegatingStyledCellLabelProvider.IStyledLabelProvider.
      Parameters:
      labelProvider - the label provider that provides the styled labels and the images

  • Method Details

    • getTreeColumnOffIndex

      public XViewerColumn getTreeColumnOffIndex​(int columnIndex)
      Description copied from interface: IXViewerLabelProvider
      Returns XViewerColumn of the given index
      Specified by:
      getTreeColumnOffIndex in interface IXViewerLabelProvider

    • clearXViewerColumnIndexCache

      public void clearXViewerColumnIndexCache()
      Description copied from interface: IXViewerLabelProvider
      When columns get re-ordered, need to clear out this cache so indexing can be re-computed
      Specified by:
      clearXViewerColumnIndexCache in interface IXViewerLabelProvider

    • getBackingData

      public java.lang.Object getBackingData​(java.lang.Object element, XViewerColumn xViewerColumn, int columnIndex) throws java.lang.Exception
      Description copied from interface: IXViewerLabelProvider
      Returns the backing data object for operations like sorting
      Specified by:
      getBackingData in interface IXViewerLabelProvider
      Throws:
      java.lang.Exception

    • update

      public void update​(org.eclipse.jface.viewers.ViewerCell cell)
      Overrides:
      update in class org.eclipse.jface.viewers.StyledCellLabelProvider

    • getColumnGradient

      public int getColumnGradient​(java.lang.Object element, XViewerColumn xCol, int columnIndex) throws java.lang.Exception
      Description copied from interface: IXViewerLabelProvider
      Return value between 0..100 and cell will show bar graph shading that portion of the cell
      Specified by:
      getColumnGradient in interface IXViewerLabelProvider
      Throws:
      java.lang.Exception

    • getColumnImage

      public org.eclipse.swt.graphics.Image getColumnImage​(java.lang.Object element, int columnIndex)

    • getStyledText

      org.eclipse.jface.viewers.StyledString getStyledText​(java.lang.Object element, int columnIndex)

    • getColumnText

      public java.lang.String getColumnText​(java.lang.Object element, XViewerColumn xCol, int column) throws java.lang.Exception
      Description copied from interface: IXViewerLabelProvider
      Returns the label text for the given column of the given element.
      Specified by:
      getColumnText in interface IXViewerLabelProvider
      Throws:
      java.lang.Exception

    • getColumnText

      public java.lang.String getColumnText​(java.lang.Object element, int columnIndex)
      Description copied from interface: IXViewerLabelProvider
      Returns the label text for the given column of the given element.
      Specified by:
      getColumnText in interface IXViewerLabelProvider

    • getColumnImage

      public abstract org.eclipse.swt.graphics.Image getColumnImage​(java.lang.Object element, XViewerColumn xCol, int column) throws java.lang.Exception
      Throws:
      java.lang.Exception

    • getStyledText

      public abstract org.eclipse.jface.viewers.StyledString getStyledText​(java.lang.Object element, XViewerColumn xCol, int column) throws java.lang.Exception
      Throws:
      java.lang.Exception

    • getBackground

      public abstract org.eclipse.swt.graphics.Color getBackground​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex) throws java.lang.Exception
      Throws:
      java.lang.Exception

    • getForeground

      public abstract org.eclipse.swt.graphics.Color getForeground​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex) throws java.lang.Exception
      Throws:
      java.lang.Exception

    • getFont

      public abstract org.eclipse.swt.graphics.Font getFont​(java.lang.Object element, XViewerColumn viewerColumn, int columnIndex) throws java.lang.Exception
      Throws:
      java.lang.Exception