org.eclipse.nebula.widgets.nattable.persistence

Interface IPersistable

All Known Subinterfaces:

ILayer, IRowGroupModel<T>, IUniqueIndexLayer

All Known Implementing Classes:

AbstractColumnHideShowLayer, AbstractIndexLayerTransform, AbstractLayer, AbstractLayerTransform, AbstractRowHideShowLayer, AutomaticSpanningDataProvider, BaseColumnHideShowLayerFixture, BaseColumnReorderLayerFixture, BaseDataLayerFixture, BaseRowHideShowLayerFixture, BaseRowReorderLayerFixture, BlinkLayer, BodyLayerStackFixture, ColumnGroupBodyLayerStack, ColumnGroupExpandCollapseLayer, ColumnGroupGroupHeaderLayer, ColumnGroupHeaderLayer, ColumnGroupModel, ColumnGroupModelFixture, ColumnGroupReorderLayer, ColumnHeaderLayer, ColumnHeaderLayerFixture, ColumnHideShowLayer, ColumnHideShowLayerFixture, ColumnOverrideLabelAccumulator, ColumnReorderLayer, ColumnReorderLayerFixture, ComboBoxFilterRowHeaderComposite, CompositeFreezeLayer, CompositeLayer, CompositeLayerFixture, CornerLayer, DataLayer, DataLayerFixture, DefaultBodyLayerStack, DefaultColumnHeaderDataLayer, DefaultGridLayer, DefaultRowHeaderDataLayer, DetailGlazedListsEventLayer, DimensionallyDependentIndexLayer, DimensionallyDependentLayer, DisplayColumnStyleEditorCommandHandler, DummyGridLayerStack, FilterRowDataLayer, FilterRowDataProvider, FilterRowHeaderComposite, FreezeLayer, GenericLayerFixture, GlazedListsEventLayer, GlazedListsGridLayer, GlazedListsRowHideShowLayer, GridLayer, GridLayerFixture, GroupByDataLayer, GroupByHeaderLayer, InvertedLayer, NatTable, NatTableFixture, PersistableFixture, RenameColumnHelper, RowGroupExpandCollapseLayer, RowGroupHeaderLayer, RowGroupModel, RowHeaderLayer, RowHideShowLayer, RowHideShowLayerFixture, RowReorderLayer, RowReorderLayerFixture, SelectionLayer, SizeConfig, SortHeaderLayer, SortStatePersistor, SpanningDataLayer, SummaryRowLayer, TestLayer, TreeLayer, ViewportLayer, ViewportLayerFixture, ZoomLayer

public interface IPersistable

Instances implementing this interface can save and load their state from a properties file. The state is therefore a collection of key value pairs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOT Separator used for properties.
static String	VALUE_SEPARATOR Separator used for values.

Method Summary

Methods

Modifier and Type	Method and Description
void	loadState(String prefix, Properties properties) Restore the state out of the given Properties identified by the specified prefix.
void	saveState(String prefix, Properties properties) Saves the state to the given Properties using the specified prefix.

Field Detail

DOT

static final String DOT

Separator used for properties. Example: .BODY.columnWidth.resizableByDefault

See Also:

Constant Field Values

VALUE_SEPARATOR

static final String VALUE_SEPARATOR

Separator used for values. Example: 0,1,2,3,4

See Also:

Constant Field Values

Method Detail

saveState

void saveState(String prefix,
             Properties properties)

Saves the state to the given Properties using the specified prefix. Note: The prefix must be prepended to the property key to support multiple states within one Properties instance.

Parameters:

prefix - The prefix to use for the state keys. Is also used as the state configuration name.

properties - The Properties instance to save the state to.

loadState

void loadState(String prefix,
             Properties properties)

Restore the state out of the given Properties identified by the specified prefix. Note: The prefix must be prepended to the property key to support multiple states within one Properties instance.

Parameters:

prefix - The prefix to use for the state keys. Is also used as the state configuration name.

properties - The Properties instance to load the state from.