Package com._1c.g5.lwt.viewers

Class AbstractLightViewer<T>

java.lang.Object

com._1c.g5.lwt.viewers.AbstractLightViewer<T>

Type Parameters:

T - - type of items in list/table/tree.

All Implemented Interfaces:

ISelectionChangedListener<T>, org.eclipse.jface.viewers.ISelectionProvider

Direct Known Subclasses:

LightListViewer

public abstract class AbstractLightViewer<T>
extends Object
implements org.eclipse.jface.viewers.ISelectionProvider, ISelectionChangedListener<T>

Instance of this class is support class for working with list/table/tree.
Content provider and label provider should be set (setLabelProvider(ILabelProvider), setContentProvider(IContentProvider)) before setting viewer input (setInput(Object)).

Constructor Summary

Constructors

Constructor	Description
AbstractLightViewer(ILightControl control, int textLocation, int imageLocation)	Constuctor.

Method Summary

Modifier and Type	Method	Description
void	addFilter(ILightViewerFilter<T> filter)	Adds filter to filter elements.
void	addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
void	clearFilters()	Removes all filters from viewed control and renews it.
IContentProvider<T>	getContentProvider()	Returns content provider.
ILightControl	getControl()	Returns viewers control.
protected List<T>	getFilteredElements(List<T> elements, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Filters given elements using viewer filters.
Collection<ILightViewerFilter<T>>	getFilters()	Returns viewer filters.
protected int	getImageLocation()	Returns items image location.
protected Object	getInput()	Returns viewer input.
ILabelProvider<? super T>	getLabelProvider()	Returns label provider.
Comparator<? super T>	getSorter()	Returns sorter used to sort items.
protected int	getTextLocation()	Returns items text location.
boolean	isPreserveSelection()	Returns true if selection will be preserved on renew.
void	removeFilter(ILightViewerFilter<T> filter)	Removes filter from viewer filters.
void	removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)
abstract void	renew()	Recalculates viewed control elements and renews it.
void	selectionChanged(Collection<? extends AbstractLightItem<T>> newSelection)	Handles selection change.
void	setContentProvider(IContentProvider<T> contentProvider)	Sets content provider.
void	setInput(Object input)	Sets viewer input.
void	setLabelProvider(ILabelProvider<? super T> labelProvider)	Sets label provider.
void	setPreserveSelection(boolean preserveSelection)	Sets if selection should be preserved on renew.
void	setSorter(Comparator<? super T> sorter)	Sets sorter used to sort items.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

getSelection, setSelection

Constructor Detail

AbstractLightViewer

public AbstractLightViewer(ILightControl control,
                           int textLocation,
                           int imageLocation)

Constuctor.

Parameters:

control - - control to create viewer for. Cannot be null.

textLocation - - items text location. Can be SWT.LEFT, SWT.CENTER, or SWT.RIGHT.

imageLocation - - items image location. Can be SWT.LEFT or SWT.RIGHT.

See Also:

SWT.CENTER, SWT.RIGHT, SWT.LEFT, AbstractLightItem.setTextLocation(int), AbstractLightItem.setImageLocation(int)

Method Detail

getControl

public ILightControl getControl()

Returns viewers control.

Returns:

viewers control. Cannot return null.

setContentProvider

public void setContentProvider(IContentProvider<T> contentProvider)

Sets content provider. Viewer uses content provider to create list items.

Parameters:

contentProvider - - content provider. Cannot be null.

getContentProvider

public IContentProvider<T> getContentProvider()

Returns content provider.

Returns:

content provider. Can return null.

setLabelProvider

public void setLabelProvider(ILabelProvider<? super T> labelProvider)

Sets label provider. Viewer uses label provider to get items text and icon.

Parameters:

labelProvider - - label provider. Cannot be null.

getLabelProvider

public ILabelProvider<? super T> getLabelProvider()

Returns label provider.

Returns:

label provider. Can return null.

setInput

public void setInput(Object input)

Sets viewer input. Viewer refreshes after input change.

Parameters:

input - - input. Cannot be null.

setSorter

public void setSorter(Comparator<? super T> sorter)

Sets sorter used to sort items.
Set null to turn sorter off.

Parameters:

sorter - - sorter. Can be null.

getSorter

public Comparator<? super T> getSorter()

Returns sorter used to sort items.

Returns:

sorter used to sort items. Can return null.

addFilter

public void addFilter(ILightViewerFilter<T> filter)

Adds filter to filter elements. Viewer renews after filter add.

Parameters:

filter - - filter to add. Cannot be null.

removeFilter

public void removeFilter(ILightViewerFilter<T> filter)

Removes filter from viewer filters. Viewer renews after filter remove

Parameters:

filter - - filter to remove. Cannot be null.

clearFilters

public void clearFilters()

Removes all filters from viewed control and renews it.

getFilters

public Collection<ILightViewerFilter<T>> getFilters()

Returns viewer filters. Changes to returned collection does not affect viewer filters.

Returns:

viewer filters. Cannot return null.

setPreserveSelection

public void setPreserveSelection(boolean preserveSelection)

Sets if selection should be preserved on renew.

Parameters:

preserveSelection - - true if selection should be preserved on renew.

isPreserveSelection

public boolean isPreserveSelection()

Returns true if selection will be preserved on renew.

Returns:

true if selection will be preserved on renew.

addSelectionChangedListener

public void addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)

Specified by:

addSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

removeSelectionChangedListener

public void removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener listener)

Specified by:

removeSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

selectionChanged

public void selectionChanged(Collection<? extends AbstractLightItem<T>> newSelection)

Description copied from interface: ISelectionChangedListener

Handles selection change.

Specified by:

selectionChanged in interface ISelectionChangedListener<T>

Parameters:

newSelection - - new selection. Cannot be null.

renew

public abstract void renew()

Recalculates viewed control elements and renews it.

getTextLocation

protected int getTextLocation()

Returns items text location.

Returns:

items text location.

getImageLocation

protected int getImageLocation()

Returns items image location.

Returns:

items image location.

getInput

protected Object getInput()

Returns viewer input.

Returns:

viewer input. Cannot return null.

getFilteredElements

protected List<T> getFilteredElements(List<T> elements,
                                      org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Filters given elements using viewer filters.

Parameters:

elements - - elements to filter. Cannot be null.

progressMonitor - - progress monitor to report progress. Remaining work should be set before method call. If progress monitor canceled returns empty list. Can be null.

Returns:

filtered elements. Cannot return null.