Package com.iizigo.text

Class TextTableLabelProvider

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
com.iizigo.text.TextTableLabelProvider
All Implemented Interfaces:
EventListener, org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.IToolTipProvider
public class TextTableLabelProvider extends org.eclipse.jface.viewers.StyledCellLabelProvider implements EventListener
Label provider for a string map property for a column table with several text table and filters.
Author:
Christopher Mindus

  • Field Summary

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

    COLORS_ON_SELECTION, NO_FOCUS

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextTableLabelProvider(ArrayList<IzFilter> filters)
    The TextTableLabelProvider being used for the TooltipTableViewer.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Handles dispose.
    org.eclipse.swt.graphics.Color
    getBackground(Object element, int columnIndex)
    Provides a background color for the given element at the specified index
    org.eclipse.swt.graphics.Image
    getColumnImage(Object element, int columnIndex)
    Returns the label image for the given column of the given element.
    String
    getColumnText(Object element, int columnIndex)
    Returns the label text for the given column of the given element.
    KStringProp
    getColumnTextProp(KStringProp ksp, int columnIndex)
    Returns the label text for the given column of the given element.
    KStringProp
    getColumnTextProp(Object element, int columnIndex)
    Returns the label text for the given column of the given element.
    int
    getErrorLevel(Object element, int columnIndex)
    Get the error level for an element at column.
    org.eclipse.swt.graphics.Font
    getFont(Object element, int columnIndex)
    Provides a font for the given element at index columnIndex.
    org.eclipse.swt.graphics.Color
    getForeground(Object element, int columnIndex)
    Provides a foreground color for the given element.
    static org.eclipse.swt.graphics.Image
    getImage(KStringProp kstringProp)
    Gets the image of a KStringProp.
    static org.eclipse.swt.graphics.Image
    getImage(KString kstring)
    Gets the image of a KString.
    org.eclipse.swt.graphics.Image
    getImage(Object element)
    Returns the image for the label of the given element.
    String
    getText(Object element)
    Returns the text for the label of the given element.
    void
    onEvent(GEvent event)
    Called to process an event.
    void
    set2ColumnTreeTable()
    Sets the 2-column tree-table mode.
    void
    setInput(ArrayList<EditorTextTable> textTables)
    Sets the input.
    void
    setItalicFont(org.eclipse.swt.graphics.Font undefined)
    Sets the font to use for text ID's that are defined in other text tables but is not present in the main edited text table.
    void
    update(org.eclipse.jface.viewers.ViewerCell cell)
    Updates the cell contents.

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

    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

    • TextTableLabelProvider

      public TextTableLabelProvider(ArrayList<IzFilter> filters)
      The TextTableLabelProvider being used for the TooltipTableViewer.

  • Method Details

    • getImage

      public static org.eclipse.swt.graphics.Image getImage(KString kstring)
      Gets the image of a KString.
      Parameters:
      kstring - The KString, or null for none.
      Returns:
      The image, or null for none.

    • getImage

      public static org.eclipse.swt.graphics.Image getImage(KStringProp kstringProp)
      Gets the image of a KStringProp.
      Parameters:
      kstringProp - The KStringProp, or null for none.
      Returns:
      The image, or null for none.

    • set2ColumnTreeTable

      public void set2ColumnTreeTable()
      Sets the 2-column tree-table mode.

    • onEvent

      public void onEvent(GEvent event)
      Called to process an event.
      Specified by:
      onEvent in interface EventListener
      Parameters:
      event - The event.

    • update

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

    • setInput

      public void setInput(ArrayList<EditorTextTable> textTables)
      Sets the input. This is required to be called when multiple text tables are edited, not when just one is used.
      Parameters:
      textTables - The text tables.

    • dispose

      public void dispose()
      Handles dispose.
      Specified by:
      dispose in interface org.eclipse.jface.viewers.IBaseLabelProvider
      Overrides:
      dispose in class org.eclipse.jface.viewers.StyledCellLabelProvider

    • setItalicFont

      public void setItalicFont(org.eclipse.swt.graphics.Font undefined)
      Sets the font to use for text ID's that are defined in other text tables but is not present in the main edited text table.

    • getColumnImage

      public org.eclipse.swt.graphics.Image getColumnImage(Object element, int columnIndex)
      Returns the label image for the given column of the given element.
      Parameters:
      element - the object representing the entire row, or null indicating that no input object is set in the viewer
      columnIndex - the zero-based index of the column in which the label appears
      Returns:
      Image or null if there is no image for the given object at columnIndex

    • getColumnText

      public String getColumnText(Object element, int columnIndex)
      Returns the label text for the given column of the given element.
      Parameters:
      element - the object representing the entire row, or null indicating that no input object is set in the viewer
      columnIndex - the zero-based index of the column in which the label appears
      Returns:
      String or null if there is no text for the given object at columnIndex

    • getColumnTextProp

      public KStringProp getColumnTextProp(Object element, int columnIndex)
      Returns the label text for the given column of the given element.
      Parameters:
      element - the object representing the entire row, or null indicating that no input object is set in the viewer
      columnIndex - the zero-based index of the column in which the label appears
      Returns:
      String, KStringProp or null if there is no text for the given object at columnIndex.

    • getColumnTextProp

      public KStringProp getColumnTextProp(KStringProp ksp, int columnIndex)
      Returns the label text for the given column of the given element.
      Parameters:
      ksp - The element property.
      columnIndex - The zero-based index of the column in which the label appears
      Returns:
      String, KStringProp or null if there is no text for the given object at columnIndex.

    • getImage

      public org.eclipse.swt.graphics.Image getImage(Object element)
      Returns the image for the label of the given element. The image is owned by the label provider and must not be disposed directly. Instead, dispose the label provider when no longer needed.
      Parameters:
      element - the element for which to provide the label image
      Returns:
      the image used to label the element, or null if there is no image for the given object

    • getText

      public String getText(Object element)
      Returns the text for the label of the given element.
      Parameters:
      element - the element for which to provide the label text
      Returns:
      the text string used to label the element, or null if there is no text label for the given object

    • getForeground

      public org.eclipse.swt.graphics.Color getForeground(Object element, int columnIndex)
      Provides a foreground color for the given element.
      Parameters:
      element - the element
      columnIndex - the zero-based index of the column in which the color appears
      Returns:
      the foreground color for the element, or null to use the default foreground color

    • getBackground

      public org.eclipse.swt.graphics.Color getBackground(Object element, int columnIndex)
      Provides a background color for the given element at the specified index
      Parameters:
      element - the element
      columnIndex - the zero-based index of the column in which the color appears
      Returns:
      the background color for the element, or null to use the default background color

    • getFont

      public org.eclipse.swt.graphics.Font getFont(Object element, int columnIndex)
      Provides a font for the given element at index columnIndex.
      Parameters:
      element - The element being displayed.
      columnIndex - The index of the column being displayed.
      Returns:
      Font to use, or null for none.

    • getErrorLevel

      public int getErrorLevel(Object element, int columnIndex)
      Get the error level for an element at column.
      Parameters:
      element - The element.
      columnIndex - The zero-based index of the column in which error level is requested.
      Returns:
      -1 for normal, 0=informational (not verified), 1=warning (undefined entry), 2=error.