org.eclipse.nebula.widgets.xviewer.customize

Class FileStoreCustomizations

java.lang.Object

org.eclipse.nebula.widgets.xviewer.customize.FileStoreCustomizations

All Implemented Interfaces:

IXViewerCustomizations

public class FileStoreCustomizations
extends java.lang.Object
implements IXViewerCustomizations

Constructor Summary

Constructors

Constructor and Description
FileStoreCustomizations(java.io.File pathToCustomizations, java.lang.String fileNamePrefix, java.lang.String fileNamePostfix, java.lang.String defaultCustomizationFileName, java.lang.String defaultCustomDataXml)

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreCustomizations

public FileStoreCustomizations(java.io.File pathToCustomizations,
                               java.lang.String fileNamePrefix,
                               java.lang.String fileNamePostfix,
                               java.lang.String defaultCustomizationFileName,
                               java.lang.String defaultCustomDataXml)

Method Detail

deleteCustomization

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

Description copied from interface: IXViewerCustomizations

Delete customization

Specified by:

deleteCustomization in interface IXViewerCustomizations

Throws:

java.lang.Exception

getSavedCustDatas

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

Description copied from interface: IXViewerCustomizations

Load and return saved customizations

Specified by:

getSavedCustDatas in interface IXViewerCustomizations

Throws:

XViewerException

getUserDefaultCustData

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

Description copied from interface: IXViewerCustomizations

Return customization saved as default

Specified by:

getUserDefaultCustData in interface IXViewerCustomizations

Throws:

XViewerException

isCustomizationPersistAvailable

public boolean isCustomizationPersistAvailable()

Description copied from interface: IXViewerCustomizations

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

Specified by:

isCustomizationPersistAvailable in interface IXViewerCustomizations

isCustomizationUserDefault

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

Description copied from interface: IXViewerCustomizations

Return true if given customization is the default

Specified by:

isCustomizationUserDefault in interface IXViewerCustomizations

Returns:

true if default

Throws:

XViewerException

saveCustomization

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

Description copied from interface: IXViewerCustomizations

Called to have customization saved

Specified by:

saveCustomization in interface IXViewerCustomizations

Throws:

java.lang.Exception

setUserDefaultCustData

public void setUserDefaultCustData(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData newCustData,
                                   boolean set)
                            throws XViewerException

Description copied from interface: IXViewerCustomizations

Set given customization as the user default

Specified by:

setUserDefaultCustData in interface IXViewerCustomizations

Throws:

XViewerException