bibliothek.gui.dock.support.mode

Interface HistoryRewriter<H,M extends Mode<H>>

Type Parameters:

M - the kind of Mode this rewriter accepts

H - the kind of history this rewriter accepts

All Known Implementing Classes:

CStationContainerHistoryRewriter, GroupingHistoryRewriter

public interface HistoryRewriter<H,M extends Mode<H>>

A HistoryRewriter can rewrite the history information that is associated with a Dockable in a specific Mode. HistoryRewriters are applied at the moment when history information is read, and are used by the ModeManager.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
H	rewrite(Dockable dockable, M mode, H history) Checks whether the history object history is still valid.

Method Detail

rewrite

H rewrite(Dockable dockable,
          M mode,
          H history)

Checks whether the history object history is still valid.

Parameters:

dockable - the element which is about to change its mode

mode - the mode that is going to be applied

history - the history object that will be forwarded to mode, may be null

Returns:

the history object to use, may be null