org.eclipse.nebula.jface.pshelfviewer

Class PShelfViewer

java.lang.Object

org.eclipse.jface.viewers.Viewer

org.eclipse.jface.viewers.ContentViewer

org.eclipse.jface.viewers.StructuredViewer

org.eclipse.nebula.jface.pshelfviewer.PShelfViewer

All Implemented Interfaces:

org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.IPostSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider

public class PShelfViewer
extends org.eclipse.jface.viewers.StructuredViewer

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer

org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollector, org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollectorWithProviders

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<?>	lastFiredSelection

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

WIDGET_DATA_KEY

Constructor Summary

Constructors

Constructor and Description
PShelfViewer(org.eclipse.swt.widgets.Composite container, int style, IShelfViewerFactory viewerFactory) Create an instance of this viewer

Method Summary

Modifier and Type	Method and Description
protected void	assertContentProviderType(org.eclipse.jface.viewers.IContentProvider provider)
protected org.eclipse.swt.widgets.Widget	doFindInputItem(java.lang.Object element)
protected org.eclipse.swt.widgets.Widget	doFindItem(java.lang.Object element)
protected void	doUpdateItem(org.eclipse.swt.widgets.Widget item, java.lang.Object element, boolean fullMap)
protected void	fireSelectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)
org.eclipse.swt.widgets.Control	getControl()
PShelf	getPShelf() Returns the underlying PShelf Control.
protected java.util.List	getSelectionFromWidget()
org.eclipse.jface.viewers.Viewer	getViewerForItem(PShelfItem item) Returns a viewer, whose widget is embedded in item.
protected void	inputChanged(java.lang.Object input, java.lang.Object oldInput)
protected void	internalInitializeWidget()
protected void	internalRefresh(java.lang.Object element)
boolean	isTransferSelection() Transfer selection behavior.
protected void	labelProviderChanged()
protected void	removeAll() Removes all shelves.
void	reveal(java.lang.Object element)
protected void	setSelectionToWidget(java.util.List l, boolean reveal)
void	setTransferSelection(boolean transferSelection) Sets transfer selection behavior when another PShelf item is revealed.

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

addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, associate, buildLabel, disassociate, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilteredChildren, getFilters, getItem, getRawChildren, getRoot, getSelection, getSortedChildren, getSorter, getStructuredSelection, handleDispose, handleDoubleSelect, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, hookControl, internalRefresh, internalUpdate, mapElement, needsRefilter, preservingSelection, refresh, refresh, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setContentProvider, setFilters, setInput, setLabelProvider, setSelection, setSelectionToWidget, setSorter, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, update, update, updateItem, updateSelection, usingElementMap

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

getContentProvider, getInput, getLabelProvider

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

addHelpListener, addSelectionChangedListener, fireHelpRequested, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection

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

addSelectionChangedListener, removeSelectionChangedListener, setSelection

Field Detail

lastFiredSelection

protected java.util.List<?> lastFiredSelection

Constructor Detail

PShelfViewer

public PShelfViewer(org.eclipse.swt.widgets.Composite container,
                    int style,
                    IShelfViewerFactory viewerFactory)

Create an instance of this viewer

Parameters:

container - composite that holds the PShelf widget

style - style of the PShelf

viewerFactory - associated view factory

Method Detail

getControl

public org.eclipse.swt.widgets.Control getControl()

Specified by:

getControl in class org.eclipse.jface.viewers.Viewer

See Also:

Viewer.getControl()

getPShelf

public PShelf getPShelf()

Returns the underlying PShelf Control.

Returns:

PShelf control.

isTransferSelection

public boolean isTransferSelection()

Transfer selection behavior. See setTransferSelection(boolean).

Returns:

Transfer selection behavior

setTransferSelection

public void setTransferSelection(boolean transferSelection)

Sets transfer selection behavior when another PShelf item is revealed. When set to true, PShelfViewer tries to set current selection to newly revealed viewer. This is helpful when individual viewers show the same model in different arrangement. False (the default) causes each viewer to retain its own selection.

Parameters:

transferSelection -

labelProviderChanged

protected void labelProviderChanged()

Overrides:

labelProviderChanged in class org.eclipse.jface.viewers.ContentViewer

See Also:

ContentViewer.labelProviderChanged()

getViewerForItem

public org.eclipse.jface.viewers.Viewer getViewerForItem(PShelfItem item)

Returns a viewer, whose widget is embedded in item. Viewer is the one previously created by IShelfViewerFactory passed to constructor of PShelfViewer.

Parameters:

item -

Returns:

Viewer or null if IShelfViewerFactory didn't create any viewer for the widget.

inputChanged

protected void inputChanged(java.lang.Object input,
                            java.lang.Object oldInput)

Overrides:

inputChanged in class org.eclipse.jface.viewers.Viewer

See Also:

Viewer.inputChanged(java.lang.Object, java.lang.Object)

internalInitializeWidget

protected void internalInitializeWidget()

fireSelectionChanged

protected void fireSelectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

Overrides:

fireSelectionChanged in class org.eclipse.jface.viewers.Viewer

removeAll

protected void removeAll()

Removes all shelves.

doFindInputItem

protected org.eclipse.swt.widgets.Widget doFindInputItem(java.lang.Object element)

Specified by:

doFindInputItem in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.doFindInputItem(java.lang.Object)

doFindItem

protected org.eclipse.swt.widgets.Widget doFindItem(java.lang.Object element)

Specified by:

doFindItem in class org.eclipse.jface.viewers.StructuredViewer

doUpdateItem

protected void doUpdateItem(org.eclipse.swt.widgets.Widget item,
                            java.lang.Object element,
                            boolean fullMap)

Specified by:

doUpdateItem in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.doUpdateItem(org.eclipse.swt.widgets.Widget, java.lang.Object, boolean)

getSelectionFromWidget

protected java.util.List getSelectionFromWidget()

Specified by:

getSelectionFromWidget in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.getSelectionFromWidget()

internalRefresh

protected void internalRefresh(java.lang.Object element)

Specified by:

internalRefresh in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.internalRefresh(java.lang.Object)

reveal

public void reveal(java.lang.Object element)

Specified by:

reveal in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.reveal(java.lang.Object)

setSelectionToWidget

protected void setSelectionToWidget(java.util.List l,
                                    boolean reveal)

Specified by:

setSelectionToWidget in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.setSelectionToWidget(java.util.List, boolean)

assertContentProviderType

protected void assertContentProviderType(org.eclipse.jface.viewers.IContentProvider provider)

Overrides:

assertContentProviderType in class org.eclipse.jface.viewers.StructuredViewer

See Also:

StructuredViewer.assertContentProviderType(org.eclipse.jface.viewers.IContentProvider)