Package org.eclipse.nebula.widgets.xviewer.customize

Interface IXViewerCustomizations

All Known Implementing Classes:

FileStoreCustomizations, XViewerCustomizations

public interface IXViewerCustomizations

Methods to implement if this XViewer allows the user to save local/shared customizations

Author:

Donald G. Dunne

Method Summary

Modifier and Type	Method	Description
void	deleteCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)	Delete customization
java.util.List<org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData>	getSavedCustDatas()	Load and return saved customizations
org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData	getUserDefaultCustData()	Return customization saved as default
boolean	isCustomizationPersistAvailable()	Return true if this XViewer is allowed to save local/shared customizations
boolean	isCustomizationUserDefault(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)	Return true if given customization is the default
void	saveCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)	Called to have customization saved
void	setUserDefaultCustData(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData newCustData, boolean set)	Set given customization as the user default

Method Detail

saveCustomization

void saveCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)
                throws java.lang.Exception

Called to have customization saved

Throws:

java.lang.Exception

getSavedCustDatas

java.util.List<org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData> getSavedCustDatas()
                                                                                       throws java.lang.Exception

Load and return saved customizations

Throws:

java.lang.Exception

getUserDefaultCustData

org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData getUserDefaultCustData()
                                                                            throws XViewerException

Return customization saved as default

Throws:

XViewerException

isCustomizationUserDefault

boolean isCustomizationUserDefault(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)
                            throws XViewerException

Return true if given customization is the default

Returns:

true if default

Throws:

XViewerException

setUserDefaultCustData

void setUserDefaultCustData(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData newCustData,
                            boolean set)
                     throws java.lang.Exception

Set given customization as the user default

Throws:

java.lang.Exception

deleteCustomization

void deleteCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData custData)
                  throws java.lang.Exception

Delete customization

Throws:

java.lang.Exception

isCustomizationPersistAvailable

boolean isCustomizationPersistAvailable()

Return true if this XViewer is allowed to save local/shared customizations