Package org.eclipse.nebula.widgets.xviewer

Class XViewerFactory

java.lang.Object

org.eclipse.nebula.widgets.xviewer.XViewerFactory

All Implemented Interfaces:

IXViewerFactory

public abstract class XViewerFactory
extends java.lang.Object
implements IXViewerFactory

Constructor Summary

Constructors

Constructor	Description
XViewerFactory(java.lang.String namespace)

Method Summary

Modifier and Type	Method	Description
void	clearColumnRegistration()
boolean	columnRegistered(XViewerColumn column)
XViewerSorter	createNewXSorter(XViewer xViewer)	Returns the default sorter to use for this xviewer
java.util.List<XViewerColumn>	getColumns()
org.eclipse.jface.dialogs.Dialog	getCustomizeDialog(XViewer xViewer)
CustomizeData	getDefaultTableCustomizeData()	Returns the default table customization for this viewer including column definitions, sorting and filtering (if any)
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 viewer)	Provides for ability to customize loading report that is provided
XViewerTreeReport	getXViewerTreeReport(XViewer viewer)	Provides for ability to customize tree report that is provided
boolean	isCellGradientOn()
boolean	isFilterUiAvailable()
boolean	isHeaderBarAvailable()
boolean	isLoadedStatusLabelAvailable()
boolean	isSearchUiAvailable()
boolean	isSearhTop()
void	overrideShowDefault(java.lang.String id, boolean show)
void	registerColumns(java.util.Collection<? extends XViewerColumn> columns)
void	registerColumns(XViewerColumn... columns)
void	setNamespace(java.lang.String namespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.xviewer.IXViewerFactory

isAdmin

Constructor Details

XViewerFactory

public XViewerFactory(java.lang.String namespace)

Method Details

setNamespace

public void setNamespace(java.lang.String namespace)

registerColumns

public void registerColumns(java.util.Collection<? extends XViewerColumn> columns)

registerColumns

public void registerColumns(XViewerColumn... columns)

columnRegistered

public boolean columnRegistered(XViewerColumn column)

clearColumnRegistration

public void clearColumnRegistration()

createNewXSorter

public XViewerSorter createNewXSorter(XViewer xViewer)

Description copied from interface: IXViewerFactory

Returns the default sorter to use for this xviewer

Specified by:

createNewXSorter in interface IXViewerFactory

getDefaultTableCustomizeData

public CustomizeData getDefaultTableCustomizeData()

Description copied from interface: IXViewerFactory

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

Specified by:

getDefaultTableCustomizeData in interface IXViewerFactory

getDefaultXViewerColumn

public XViewerColumn getDefaultXViewerColumn(java.lang.String id)

Description copied from interface: IXViewerFactory

Returns the default column definition for the given id

Specified by:

getDefaultXViewerColumn in interface IXViewerFactory

overrideShowDefault

public void overrideShowDefault(java.lang.String id, boolean show)

getXViewerCustomizations

public IXViewerCustomizations getXViewerCustomizations()

Description copied from interface: IXViewerFactory

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

Specified by:

getXViewerCustomizations in interface IXViewerFactory

getXViewerCustomMenu

public XViewerCustomMenu getXViewerCustomMenu()

Description copied from interface: IXViewerFactory

Provides custom menu for XViewer

Specified by:

getXViewerCustomMenu in interface IXViewerFactory

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IXViewerFactory

Unique namespace for this viewer

Specified by:

getNamespace in interface IXViewerFactory

getColumns

public java.util.List<XViewerColumn> getColumns()

getXViewerTreeReport

public XViewerTreeReport getXViewerTreeReport(XViewer viewer)

Description copied from interface: IXViewerFactory

Provides for ability to customize tree report that is provided

Specified by:

getXViewerTreeReport in interface IXViewerFactory

getXViewerLoadingReport

public XViewerLoadingReport getXViewerLoadingReport(XViewer viewer)

Description copied from interface: IXViewerFactory

Provides for ability to customize loading report that is provided

Specified by:

getXViewerLoadingReport in interface IXViewerFactory

isFilterUiAvailable

public boolean isFilterUiAvailable()

Specified by:

isFilterUiAvailable in interface IXViewerFactory

isHeaderBarAvailable

public boolean isHeaderBarAvailable()

Specified by:

isHeaderBarAvailable in interface IXViewerFactory

isLoadedStatusLabelAvailable

public boolean isLoadedStatusLabelAvailable()

Specified by:

isLoadedStatusLabelAvailable in interface IXViewerFactory

isSearchUiAvailable

public boolean isSearchUiAvailable()

Specified by:

isSearchUiAvailable in interface IXViewerFactory

isCellGradientOn

public boolean isCellGradientOn()

Specified by:

isCellGradientOn in interface IXViewerFactory

isSearhTop

public boolean isSearhTop()

Specified by:

isSearhTop in interface IXViewerFactory

Returns:

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

getCustomizeDialog

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

Specified by:

getCustomizeDialog in interface IXViewerFactory

Returns:

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