org.eclipse.nebula.widgets.xviewer

Interface IXViewerFactory

All Known Implementing Classes:

XViewerFactory

public interface IXViewerFactory

Method Summary

Modifier and Type	Method and Description
XViewerSorter	createNewXSorter(XViewer viewer) Returns the default sorter to use for this xviewer
org.eclipse.jface.dialogs.Dialog	getCustomizeDialog(XViewer xViewer)
org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData	getDefaultTableCustomizeData() Returns the default table customization for this viewer including column definitions, sorting and filtering (if any)
org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn	getDefaultXViewerColumn(java.lang.String id) Returns the default column definition for the given id
java.lang.String	getNamespace() Unique namespace for this viewer
IXViewerCustomizations	getXViewerCustomizations() Provides the storage mechanism for save/load of personal/shared customizations
XViewerCustomMenu	getXViewerCustomMenu() Provides custom menu for XViewer
XViewerLoadingReport	getXViewerLoadingReport(XViewer xViewer) Provides for ability to customize loading report that is provided
XViewerTreeReport	getXViewerTreeReport(XViewer xViewer) Provides for ability to customize tree report that is provided
boolean	isAdmin() Will enable certain extra functionality based on admin validity
boolean	isCellGradientOn()
boolean	isFilterUiAvailable()
boolean	isHeaderBarAvailable()
boolean	isLoadedStatusLabelAvailable()
boolean	isSearchUiAvailable()
boolean	isSearhTop()

Method Detail

createNewXSorter

XViewerSorter createNewXSorter(XViewer viewer)

Returns the default sorter to use for this xviewer

getDefaultTableCustomizeData

org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData getDefaultTableCustomizeData()

Returns the default table customization for this viewer including column definitions, sorting and filtering (if any)

getDefaultXViewerColumn

org.eclipse.nebula.widgets.xviewer.core.model.XViewerColumn getDefaultXViewerColumn(java.lang.String id)

Returns the default column definition for the given id

getXViewerCustomizations

IXViewerCustomizations getXViewerCustomizations()

Provides the storage mechanism for save/load of personal/shared customizations

getXViewerCustomMenu

XViewerCustomMenu getXViewerCustomMenu()

Provides custom menu for XViewer

getNamespace

java.lang.String getNamespace()

Unique namespace for this viewer

isAdmin

boolean isAdmin()

Will enable certain extra functionality based on admin validity

getXViewerTreeReport

XViewerTreeReport getXViewerTreeReport(XViewer xViewer)

Provides for ability to customize tree report that is provided

getXViewerLoadingReport

XViewerLoadingReport getXViewerLoadingReport(XViewer xViewer)

Provides for ability to customize loading report that is provided

isSearchUiAvailable

boolean isSearchUiAvailable()

isFilterUiAvailable

boolean isFilterUiAvailable()

isLoadedStatusLabelAvailable

boolean isLoadedStatusLabelAvailable()

isHeaderBarAvailable

boolean isHeaderBarAvailable()

isCellGradientOn

boolean isCellGradientOn()

isSearhTop

boolean isSearhTop()

Returns:

true if search/filter should be before the table; false it is located after the table

getCustomizeDialog

org.eclipse.jface.dialogs.Dialog getCustomizeDialog(XViewer xViewer)

Returns:

dialog to customize the XViewer. if null, nothing will be opened.