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
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<XViewerColumn>columnsprivate java.util.Map<java.lang.String,XViewerColumn>idToColumnprivate java.lang.Stringnamespace
-
Constructor Summary
Constructors Constructor Description XViewerFactory(java.lang.String namespace)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearColumnRegistration()booleancolumnRegistered(XViewerColumn column)XViewerSortercreateNewXSorter(XViewer xViewer)Returns the default sorter to use for this xviewerjava.util.List<XViewerColumn>getColumns()org.eclipse.jface.dialogs.DialoggetCustomizeDialog(XViewer xViewer)CustomizeDatagetDefaultTableCustomizeData()Returns the default table customization for this viewer including column definitions, sorting and filtering (if any)XViewerColumngetDefaultXViewerColumn(java.lang.String id)Returns the default column definition for the given idjava.lang.StringgetNamespace()Unique namespace for this viewerIXViewerCustomizationsgetXViewerCustomizations()Provides the storage mechanism for save/load of personal/shared customizationsXViewerCustomMenugetXViewerCustomMenu()Provides custom menu for XViewerXViewerLoadingReportgetXViewerLoadingReport(XViewer viewer)Provides for ability to customize loading report that is providedXViewerTreeReportgetXViewerTreeReport(XViewer viewer)Provides for ability to customize tree report that is providedbooleanisCellGradientOn()booleanisFilterUiAvailable()booleanisHeaderBarAvailable()booleanisLoadedStatusLabelAvailable()booleanisSearchUiAvailable()booleanisSearhTop()voidoverrideShowDefault(java.lang.String id, boolean show)voidregisterColumns(java.util.Collection<? extends XViewerColumn> columns)voidregisterColumns(XViewerColumn... columns)voidsetNamespace(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
-
-
-
-
Field Detail
-
namespace
private java.lang.String namespace
-
columns
private final java.util.List<XViewerColumn> columns
-
idToColumn
private final java.util.Map<java.lang.String,XViewerColumn> idToColumn
-
-
Method Detail
-
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:IXViewerFactoryReturns the default sorter to use for this xviewer- Specified by:
createNewXSorterin interfaceIXViewerFactory
-
getDefaultTableCustomizeData
public CustomizeData getDefaultTableCustomizeData()
Description copied from interface:IXViewerFactoryReturns the default table customization for this viewer including column definitions, sorting and filtering (if any)- Specified by:
getDefaultTableCustomizeDatain interfaceIXViewerFactory
-
getDefaultXViewerColumn
public XViewerColumn getDefaultXViewerColumn(java.lang.String id)
Description copied from interface:IXViewerFactoryReturns the default column definition for the given id- Specified by:
getDefaultXViewerColumnin interfaceIXViewerFactory
-
overrideShowDefault
public void overrideShowDefault(java.lang.String id, boolean show)
-
getXViewerCustomizations
public IXViewerCustomizations getXViewerCustomizations()
Description copied from interface:IXViewerFactoryProvides the storage mechanism for save/load of personal/shared customizations- Specified by:
getXViewerCustomizationsin interfaceIXViewerFactory
-
getXViewerCustomMenu
public XViewerCustomMenu getXViewerCustomMenu()
Description copied from interface:IXViewerFactoryProvides custom menu for XViewer- Specified by:
getXViewerCustomMenuin interfaceIXViewerFactory
-
getNamespace
public java.lang.String getNamespace()
Description copied from interface:IXViewerFactoryUnique namespace for this viewer- Specified by:
getNamespacein interfaceIXViewerFactory
-
getColumns
public java.util.List<XViewerColumn> getColumns()
-
getXViewerTreeReport
public XViewerTreeReport getXViewerTreeReport(XViewer viewer)
Description copied from interface:IXViewerFactoryProvides for ability to customize tree report that is provided- Specified by:
getXViewerTreeReportin interfaceIXViewerFactory
-
getXViewerLoadingReport
public XViewerLoadingReport getXViewerLoadingReport(XViewer viewer)
Description copied from interface:IXViewerFactoryProvides for ability to customize loading report that is provided- Specified by:
getXViewerLoadingReportin interfaceIXViewerFactory
-
isFilterUiAvailable
public boolean isFilterUiAvailable()
- Specified by:
isFilterUiAvailablein interfaceIXViewerFactory
-
isHeaderBarAvailable
public boolean isHeaderBarAvailable()
- Specified by:
isHeaderBarAvailablein interfaceIXViewerFactory
-
isLoadedStatusLabelAvailable
public boolean isLoadedStatusLabelAvailable()
- Specified by:
isLoadedStatusLabelAvailablein interfaceIXViewerFactory
-
isSearchUiAvailable
public boolean isSearchUiAvailable()
- Specified by:
isSearchUiAvailablein interfaceIXViewerFactory
-
isCellGradientOn
public boolean isCellGradientOn()
- Specified by:
isCellGradientOnin interfaceIXViewerFactory
-
isSearhTop
public boolean isSearhTop()
- Specified by:
isSearhTopin interfaceIXViewerFactory- 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:
getCustomizeDialogin interfaceIXViewerFactory- Returns:
- dialog to customize the XViewer. if null, nothing will be opened.
-
-