Package org.eclipse.nebula.widgets.nattable.persistence

Interface IPersistable

All Known Subinterfaces:
ILayer, IRowGroupModel<T>, IUniqueIndexLayer
All Known Implementing Classes:
_001_Getting_Started.BodyLayerStack, _001_Getting_Started.ColumnHeaderLayerStack, _001_Getting_Started.RowHeaderLayerStack, _804_GlazedListsEditorExample.GlazedListsEditorColumnHeaderLayerStack, AbstractColumnHideShowLayer, AbstractIndexLayerTransform, AbstractLayer, AbstractLayerTransform, AbstractRowHideShowLayer, AutomaticSpanningDataProvider, BaseColumnReorderLayerFixture, BaseDataLayerFixture, BaseDataLayerFixture, BaseRowReorderLayerFixture, BlinkLayer, BodyLayerStackFixture, ColumnGroupBodyLayerStack, ColumnGroupExpandCollapseLayer, ColumnGroupExpandCollapseLayer, ColumnGroupGroupHeaderLayer, ColumnGroupHeaderLayer, ColumnGroupHeaderLayer, ColumnGroupModel, ColumnGroupModelFixture, ColumnGroupReorderLayer, ColumnHeaderLayer, ColumnHeaderLayerFixture, ColumnHideShowLayer, ColumnHideShowLayerFixture, ColumnOverrideLabelAccumulator, ColumnReorderLayer, ColumnReorderLayerFixture, ColumnStructureUpdatesExampleGridLayer, ComboBoxFilterRowHeaderComposite, CompositeFreezeLayer, CompositeLayer, CompositeLayerFixture, CornerLayer, DataChangeLayer, DataLayer, DataLayerFixture, DataLayerFixture, DefaultBodyLayerStack, DefaultColumnHeaderDataLayer, DefaultGridLayer, DefaultRowHeaderDataLayer, DetailGlazedListsEventLayer, DimensionallyDependentIndexLayer, DimensionallyDependentLayer, DisplayColumnStyleEditorCommandHandler, DummyGridLayerStack, FilterRowDataLayer, FilterRowDataProvider, FilterRowExampleGridLayer, FilterRowHeaderComposite, FixedSummaryRowHeaderLayer, FixedSummaryRowLayer, FreezeLayer, FullFeaturedBodyLayerStack, FullFeaturedColumnHeaderLayerStack, GenericLayerFixture, GlazedListsColumnHeaderLayerStack, GlazedListsEventLayer, GlazedListsGridLayer, GlazedListsGridLayer, GlazedListsRowHideShowLayer, GridLayer, GridLayerFixture, GroupByDataLayer, GroupByHeaderLayer, GroupByModel, GroupModel, HierarchicalTreeLayer, HoverLayer, InvertedLayer, NatTable, NatTableFixture, NatTableFixture, PersistableFixture, RenameColumnHelper, ResizeColumnHideShowLayer, RowGroupExpandCollapseLayer, RowGroupExpandCollapseLayer, RowGroupHeaderLayer, RowGroupHeaderLayer, RowGroupModel, RowHeaderLayer, RowHideShowLayer, RowHideShowLayerFixture, RowIdHideShowLayer, RowReorderLayer, RowReorderLayerFixture, SelectionExampleBodyLayerStack, SelectionExampleGridLayer, SelectionLayer, SizeConfig, SortHeaderLayer, SortStatePersistor, SpanningDataLayer, StaticFilterExampleGridLayer, SummaryRowLayer, TestLayer, TreeLayer, ViewportLayer, ViewportLayerFixture, ViewportLayerFixture
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
    Description
    static final String
    DOT
    Separator used for properties.
    static final String
    VALUE_SEPARATOR
    Separator used for values.

  • Method Summary

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

    • DOT

      static final String DOT
      Separator used for properties. Example: .BODY.columnWidth.resizableByDefault
      See Also:

    • VALUE_SEPARATOR

      static final String VALUE_SEPARATOR
      Separator used for values. Example: 0,1,2,3,4
      See Also:

  • Method Details

    • 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.