Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "FAQ How to decorate a TableViewer or TreeViewer with Columns?"
m (Removed personal name and email addresses.) |
|||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Eclipse | + | Eclipse does not support decorating TableViewers and TreeViewers with TreeColumns as they have proposed Decorators for TreeViewers. But in many cases where we use TreeViewers with TreeColumns or TableViewers we need to provide some decorations based on some Condition. |
This can be achieved by extending the DecoratingLabelProvider class and creating your own class called as <Your Class Name> for e.g.TableDecoratingLabelProvider and implement ITableLabelProvider in that class. | This can be achieved by extending the DecoratingLabelProvider class and creating your own class called as <Your Class Name> for e.g.TableDecoratingLabelProvider and implement ITableLabelProvider in that class. | ||
| Line 6: | Line 6: | ||
It would look something like this | It would look something like this | ||
| − | < | + | <source lang="java"> |
/** | /** | ||
* Class that supports Decoration of TableViewer and TreeViewer with TreeColumns | * Class that supports Decoration of TableViewer and TreeViewer with TreeColumns | ||
*/ | */ | ||
| − | package | + | package decorators; |
import org.eclipse.jface.viewers.DecoratingLabelProvider; | import org.eclipse.jface.viewers.DecoratingLabelProvider; | ||
| Line 19: | Line 19: | ||
/** | /** | ||
| − | |||
* | * | ||
*/ | */ | ||
public class TableDecoratingLabelProvider extends DecoratingLabelProvider | public class TableDecoratingLabelProvider extends DecoratingLabelProvider | ||
| − | implements ITableLabelProvider { | + | implements ITableLabelProvider { |
ITableLabelProvider provider; | ITableLabelProvider provider; | ||
| Line 32: | Line 31: | ||
*/ | */ | ||
public TableDecoratingLabelProvider(ILabelProvider provider, | public TableDecoratingLabelProvider(ILabelProvider provider, | ||
| − | ILabelDecorator decorator) { | + | ILabelDecorator decorator) { |
| − | super(provider, decorator); | + | super(provider, decorator); |
| − | this.provider = (ITableLabelProvider) provider; | + | this.provider = (ITableLabelProvider) provider; |
| − | + | this.decorator = decorator; | |
} | } | ||
| Line 42: | Line 41: | ||
*/ | */ | ||
public Image getColumnImage(Object element, int columnIndex) { | public Image getColumnImage(Object element, int columnIndex) { | ||
| − | Image image = provider.getColumnImage(element, columnIndex); | + | Image image = provider.getColumnImage(element, columnIndex); |
| − | + | if (decorator != null) { | |
| − | + | Image decorated = decorator.decorateImage(image, element); | |
| − | + | if (decorated != null) { | |
| − | + | return decorated; | |
| − | + | } | |
| − | + | } | |
| − | + | return image; | |
} | } | ||
| Line 56: | Line 55: | ||
*/ | */ | ||
public String getColumnText(Object element, int columnIndex) { | public String getColumnText(Object element, int columnIndex) { | ||
| − | String text = provider.getColumnText(element, columnIndex); | + | String text = provider.getColumnText(element, columnIndex); |
| − | + | if (decorator != null) { | |
| − | + | String decorated = decorator.decorateText(text, element); | |
| − | + | if (decorated != null) { | |
| − | + | return decorated; | |
| − | + | } | |
| − | + | } | |
| − | + | return text; | |
} | } | ||
| − | + | </source> | |
| − | </ | + | |
This class can now handle Trees which have Columns and TableViewers. How you use it is specified below | This class can now handle Trees which have Columns and TableViewers. How you use it is specified below | ||
| Line 72: | Line 70: | ||
While attaching the LabelProvider to your viewer use this Code | While attaching the LabelProvider to your viewer use this Code | ||
| − | < | + | <source lang="java"> |
ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); | ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); | ||
<Your Viewer>.setLabelProvider(new TableDecoratingLabelProvider(<Your LabelProvider>, decorator)); | <Your Viewer>.setLabelProvider(new TableDecoratingLabelProvider(<Your LabelProvider>, decorator)); | ||
| − | </ | + | </source> |
instead of | instead of | ||
| − | < | + | <source lang="java"> |
ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); | ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); | ||
<Your Viewer>.setLabelProvider(new DecoratingLabelProvider(<Your LabelProvider>, decorator)); | <Your Viewer>.setLabelProvider(new DecoratingLabelProvider(<Your LabelProvider>, decorator)); | ||
| − | </ | + | </source> |
| − | + | ||
| − | + | ||
== See Also: == | == See Also: == | ||
*[[FAQ What is a label decorator?]] | *[[FAQ What is a label decorator?]] | ||
*[[FAQ How do I create a label decorator declaratively?]] | *[[FAQ How do I create a label decorator declaratively?]] | ||
Latest revision as of 18:47, 31 January 2015
Eclipse does not support decorating TableViewers and TreeViewers with TreeColumns as they have proposed Decorators for TreeViewers. But in many cases where we use TreeViewers with TreeColumns or TableViewers we need to provide some decorations based on some Condition.
This can be achieved by extending the DecoratingLabelProvider class and creating your own class called as <Your Class Name> for e.g.TableDecoratingLabelProvider and implement ITableLabelProvider in that class.
It would look something like this
/** * Class that supports Decoration of TableViewer and TreeViewer with TreeColumns */ package decorators; import org.eclipse.jface.viewers.DecoratingLabelProvider; import org.eclipse.jface.viewers.ILabelDecorator; import org.eclipse.jface.viewers.ILabelProvider; import org.eclipse.jface.viewers.ITableLabelProvider; import org.eclipse.swt.graphics.Image; /** * */ public class TableDecoratingLabelProvider extends DecoratingLabelProvider implements ITableLabelProvider { ITableLabelProvider provider; ILabelDecorator decorator; /** * @param provider * @param decorator */ public TableDecoratingLabelProvider(ILabelProvider provider, ILabelDecorator decorator) { super(provider, decorator); this.provider = (ITableLabelProvider) provider; this.decorator = decorator; } /* (non-Javadoc) * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnImage(java.lang.Object, int) */ public Image getColumnImage(Object element, int columnIndex) { Image image = provider.getColumnImage(element, columnIndex); if (decorator != null) { Image decorated = decorator.decorateImage(image, element); if (decorated != null) { return decorated; } } return image; } /* (non-Javadoc) * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnText(java.lang.Object, int) */ public String getColumnText(Object element, int columnIndex) { String text = provider.getColumnText(element, columnIndex); if (decorator != null) { String decorated = decorator.decorateText(text, element); if (decorated != null) { return decorated; } } return text; }
This class can now handle Trees which have Columns and TableViewers. How you use it is specified below
While attaching the LabelProvider to your viewer use this Code
ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); <Your Viewer>.setLabelProvider(new TableDecoratingLabelProvider(<Your LabelProvider>, decorator));
instead of
ILabelDecorator decorator = PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(); <Your Viewer>.setLabelProvider(new DecoratingLabelProvider(<Your LabelProvider>, decorator));