Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.jdt.internal.ui.viewsupport
Class JavaUILabelProvider  view JavaUILabelProvider download JavaUILabelProvider.java

java.lang.Object
  extended byorg.eclipse.jface.viewers.LabelProvider
      extended byorg.eclipse.jdt.internal.ui.viewsupport.JavaUILabelProvider
All Implemented Interfaces:
org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.IColorProvider, org.eclipse.jface.viewers.ILabelProvider
Direct Known Subclasses:
AppearanceAwareLabelProvider

public class JavaUILabelProvider
extends org.eclipse.jface.viewers.LabelProvider
implements org.eclipse.jface.viewers.IColorProvider


Field Summary
private  int fImageFlags
           
protected  JavaElementImageProvider fImageLabelProvider
           
private  java.util.ArrayList fLabelDecorators
           
protected  StorageLabelProvider fStorageLabelProvider
           
private  int fTextFlags
           
 
Fields inherited from class org.eclipse.jface.viewers.LabelProvider
 
Constructor Summary
JavaUILabelProvider()
          Creates a new label provider with default flags.
JavaUILabelProvider(int textFlags, int imageFlags)
           
 
Method Summary
 void addLabelDecorator(org.eclipse.jface.viewers.ILabelDecorator decorator)
          Adds a decorator to the label provider
 void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
          Adds a listener to this label provider.
protected  org.eclipse.swt.graphics.Image decorateImage(org.eclipse.swt.graphics.Image image, java.lang.Object element)
           
protected  java.lang.String decorateText(java.lang.String text, java.lang.Object element)
           
 void dispose()
          The LabelProvider implementation of this IBaseLabelProvider method does nothing.
protected  int evaluateImageFlags(java.lang.Object element)
          Evaluates the image flags for a element.
protected  int evaluateTextFlags(java.lang.Object element)
          Evaluates the text flags for a element.
 org.eclipse.swt.graphics.Color getBackground(java.lang.Object element)
          Provides a background color for the given element.
static org.eclipse.jface.viewers.ILabelDecorator[] getDecorators(boolean errortick, org.eclipse.jface.viewers.ILabelDecorator extra)
           
 org.eclipse.swt.graphics.Color getForeground(java.lang.Object element)
          Provides a foreground color for the given element.
 org.eclipse.swt.graphics.Image getImage(java.lang.Object element)
          The LabelProvider implementation of this ILabelProvider method returns null.
 int getImageFlags()
          Gets the image flags.
 java.lang.String getText(java.lang.Object element)
          The LabelProvider implementation of this ILabelProvider method returns the element's toString string.
 int getTextFlags()
          Gets the text flags.
 boolean isLabelProperty(java.lang.Object element, java.lang.String property)
          The LabelProvider implementation of this IBaseLabelProvider method returns true.
 void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
          Removes a listener to this label provider.
 void setImageFlags(int imageFlags)
          Sets the imageFlags
 void setTextFlags(int textFlags)
          Sets the textFlags.
 
Methods inherited from class org.eclipse.jface.viewers.LabelProvider
fireLabelProviderChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fImageLabelProvider

protected JavaElementImageProvider fImageLabelProvider

fStorageLabelProvider

protected StorageLabelProvider fStorageLabelProvider

fLabelDecorators

private java.util.ArrayList fLabelDecorators

fImageFlags

private int fImageFlags

fTextFlags

private int fTextFlags
Constructor Detail

JavaUILabelProvider

public JavaUILabelProvider()
Creates a new label provider with default flags.


JavaUILabelProvider

public JavaUILabelProvider(int textFlags,
                           int imageFlags)
Method Detail

addLabelDecorator

public void addLabelDecorator(org.eclipse.jface.viewers.ILabelDecorator decorator)
Adds a decorator to the label provider


setTextFlags

public final void setTextFlags(int textFlags)
Sets the textFlags.


setImageFlags

public final void setImageFlags(int imageFlags)
Sets the imageFlags


getImageFlags

public final int getImageFlags()
Gets the image flags. Can be overwriten by super classes.


getTextFlags

public final int getTextFlags()
Gets the text flags.


evaluateImageFlags

protected int evaluateImageFlags(java.lang.Object element)
Evaluates the image flags for a element. Can be overwriten by super classes.


evaluateTextFlags

protected int evaluateTextFlags(java.lang.Object element)
Evaluates the text flags for a element. Can be overwriten by super classes.


decorateImage

protected org.eclipse.swt.graphics.Image decorateImage(org.eclipse.swt.graphics.Image image,
                                                       java.lang.Object element)

getImage

public org.eclipse.swt.graphics.Image getImage(java.lang.Object element)
Description copied from class: org.eclipse.jface.viewers.LabelProvider
The LabelProvider implementation of this ILabelProvider method returns null. Subclasses may override.

Specified by:
getImage in interface org.eclipse.jface.viewers.ILabelProvider

decorateText

protected java.lang.String decorateText(java.lang.String text,
                                        java.lang.Object element)

getText

public java.lang.String getText(java.lang.Object element)
Description copied from class: org.eclipse.jface.viewers.LabelProvider
The LabelProvider implementation of this ILabelProvider method returns the element's toString string. Subclasses may override.

Specified by:
getText in interface org.eclipse.jface.viewers.ILabelProvider

dispose

public void dispose()
Description copied from class: org.eclipse.jface.viewers.LabelProvider
The LabelProvider implementation of this IBaseLabelProvider method does nothing. Subclasses may extend.

Specified by:
dispose in interface org.eclipse.jface.viewers.IBaseLabelProvider

addListener

public void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Description copied from interface: org.eclipse.jface.viewers.IBaseLabelProvider
Adds a listener to this label provider. Has no effect if an identical listener is already registered.

Label provider listeners are informed about state changes that affect the rendering of the viewer that uses this label provider.

Specified by:
addListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

isLabelProperty

public boolean isLabelProperty(java.lang.Object element,
                               java.lang.String property)
Description copied from class: org.eclipse.jface.viewers.LabelProvider
The LabelProvider implementation of this IBaseLabelProvider method returns true. Subclasses may override.

Specified by:
isLabelProperty in interface org.eclipse.jface.viewers.IBaseLabelProvider

removeListener

public void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Description copied from interface: org.eclipse.jface.viewers.IBaseLabelProvider
Removes a listener to this label provider. Has no affect if an identical listener is not registered.

Specified by:
removeListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

getDecorators

public static org.eclipse.jface.viewers.ILabelDecorator[] getDecorators(boolean errortick,
                                                                        org.eclipse.jface.viewers.ILabelDecorator extra)

getForeground

public org.eclipse.swt.graphics.Color getForeground(java.lang.Object element)
Description copied from interface: org.eclipse.jface.viewers.IColorProvider
Provides a foreground color for the given element.

Specified by:
getForeground in interface org.eclipse.jface.viewers.IColorProvider

getBackground

public org.eclipse.swt.graphics.Color getBackground(java.lang.Object element)
Description copied from interface: org.eclipse.jface.viewers.IColorProvider
Provides a background color for the given element.

Specified by:
getBackground in interface org.eclipse.jface.viewers.IColorProvider