Undo架構（三）

21.5 使用外部對象管理Undo狀態

在前面的樣本中，我們自訂的UndoableEdit實現要負責維護可撤銷對象的之前與之後狀態。Swing Undo架構同時支援使用可撤銷編輯實現之外的對象來管理狀態的能力。當使用一個外部對象用於狀態管理時，我們並不需要實現UndoableEdit介面。相反，我們可以使用StateEdit類作為UndoableEdit實現。然後StateEdit類依賴一個類實現StateEditable介面來管理可撤銷對象（在Hashtable中）之前與之後的狀態儲存。

21.5.1 StateEditable介面

StateEditable介面由兩個方法與一個無意義的字串常量組成。

public interface StateEditable {  public final static String RCSID;  public void restoreState(Hashtable state);  public void storeState(Hashtable state);}
支援操作撤銷的對象使用storeState(Hashtable)方法儲存其狀態。這是關於可以修改的對象的狀態的全部資訊。然後使用restoreState(Hashtable)方法重新載入對象的狀態。
為了進行示範，我們來看一下如何重新實現前面的UndoableDrawingPanel樣本。在更新的版本中使用這個介面，可撤銷的繪製面板需要實現此介面，並且儲存與擷取前面圖21-5中所示的多邊形。這是因為多邊形是我們關心撤銷的唯一狀態資訊。源碼顯示在列表21-7中。
package swingstudy.ch21; import java.awt.Polygon;import java.util.Hashtable; import javax.swing.JPanel;import javax.swing.undo.StateEditable; public class UndoableDrawingPanel2 extends JPanel implements StateEditable { private static String POLYGON_KEY = "Polygon"; @Overridepublic void storeState(Hashtable state) {// TODO Auto-generated method stubstate.put(POLYGON_KEY, getPolygon());} @Overridepublic void restoreState(Hashtable state) {// TODO Auto-generated method stubPolygon polygon = (Polygon)state.get(POLYGON_KEY);if(polygon != null) {setPolgyon(polygon);}} }
restoreState()方法返回的Hashtable只包含可以修改的鍵/值對。也有可能Hashtable的get()方法會為我們使用put()方法顯式放入散列表中的內容返回null。所以，如列表21-7所示，我們需要在由散列表擷取狀態資訊之後添加一個if-null檢測語句。

21.5.2 StateEdit類
在我們實現了StateEditable介面之後，我們可以使用StateEdit類作為UndoableEdit實現。其中前面的UndoableDrawingPanel樣本建立了一個自訂的UndoableDrawingEdit，新類建立了一個StateEdit執行個體。
StateEdit建構函式接受一個我們將要修改的StateEditable對象與一個可選的表示名字。在建立StateEdit對象之後，修改StateEditable對象然後通知StateEdit來end() StateEditable對象的修改。當StateEdit對象被通知修改已經結束時，他會對比狀態可編輯對象的之前與之後狀態並且由散列表中移除沒有變化的鍵/值對。然後我們可以通過由UndoableEditSupport類維護的一個列表將UndoabelEdit發送到UndoableEditListener對象的列表。
StateEdit stateEdit = new StateEdit(UndoableDrawingPanel2.this);// Change state of UndoableDrawingPanel2polygon.addPoint(mouseEvent.getX(), mouseEvent.getY());// Done changing statestateEdit.end();undoableEditSupport.postEdit(stateEdit);
在編輯被發送之後，UndoManager管理UndoableEdit的StateEdit執行個體，類似於其他的可撤銷編輯對象。然後UndoManager請求StateEdit對象來通知其StateEditable對象來載入其前一個狀態。對於其他的UndoableEdit對象也是如此。所以，其他的代碼不需要修改。

21.5.3 一個完整的StateEditable/StateEdit樣本
改寫的UndoableDrawingPanel樣本顯示在列表21-8中，與列表21-5的不同之處以粗體顯示。這個版本使用我們剛剛所描述的StateEditable/StateEdit組合。前面的測試程式被包含在main()方法來保持樣本的完整。除了修改了繪製面板的類名，測試並沒有進行修改並且將會得到與我們在圖21-5中所見到的相同的結果，假定多邊形具有相同的點集合。
package swingstudy.ch21; import java.awt.BorderLayout;import java.awt.EventQueue;import java.awt.Graphics;import java.awt.Polygon;import java.awt.event.MouseAdapter;import java.awt.event.MouseEvent;import java.awt.event.MouseListener;import java.util.Hashtable; import javax.swing.JButton;import javax.swing.JFrame;import javax.swing.JPanel;import javax.swing.JToolBar;import javax.swing.event.UndoableEditListener;import javax.swing.undo.StateEdit;import javax.swing.undo.StateEditable;import javax.swing.undo.UndoManager;import javax.swing.undo.UndoableEditSupport; public class UndoableDrawingPanel2 extends JPanel implements StateEditable { private static String POLYGON_KEY = "Polygon";UndoableEditSupport undoableEditSupport = new UndoableEditSupport(this);Polygon polygon = new Polygon(); public UndoableDrawingPanel2() {MouseListener mouseListener = new MouseAdapter() {public void mouseReleased(MouseEvent event) {StateEdit stateEdit = new StateEdit(UndoableDrawingPanel2.this);polygon.addPoint(event.getX(), event.getY());stateEdit.end();undoableEditSupport.postEdit(stateEdit);repaint();}};addMouseListener(mouseListener);} public void addUndoableEditListener(UndoableEditListener undoableEditListener) {undoableEditSupport.addUndoableEditListener(undoableEditListener);} public void removeUndoableEditListener(UndoableEditListener undoableEditListener) {undoableEditSupport.removeUndoableEditListener(undoableEditListener);} @Overridepublic void storeState(Hashtable state) {// TODO Auto-generated method stubstate.put(POLYGON_KEY, getPolygon());} @Overridepublic void restoreState(Hashtable state) {// TODO Auto-generated method stubPolygon polygon = (Polygon)state.get(POLYGON_KEY);if(polygon != null) {setPolygon(polygon);}} public void setPolygon(Polygon newValue) {polygon = newValue;repaint();} public Polygon getPolygon() {Polygon returnValue;if(polygon.npoints == 0) {returnValue = new Polygon();}else {returnValue = new Polygon(polygon.xpoints, polygon.ypoints, polygon.npoints);}return returnValue;} protected void paintComponent(Graphics g) {super.paintComponent(g);g.drawPolygon(polygon);} public static void main(String[] args) {Runnable runner = new Runnable() {public void run() {JFrame frame = new JFrame("Drawing Sample2");frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);UndoableDrawingPanel2 drawingPanel = new UndoableDrawingPanel2(); UndoManager manager = new UndoManager();drawingPanel.addUndoableEditListener(manager); JToolBar toolbar = new JToolBar();JButton undoButton = new JButton(UndoManagerHelper.getUndoAction(manager));toolbar.add(undoButton);JButton redoButton = new JButton(UndoManagerHelper.getRedoAction(manager));toolbar.add(redoButton); frame.add(toolbar, BorderLayout.NORTH);frame.add(drawingPanel, BorderLayout.CENTER);frame.setSize(300, 150);frame.setVisible(true);}};EventQueue.invokeLater(runner);}}

21.6 小結
在本章我們簡單瞭解並且探討了javax.swing.undo包中的Undo架構以及javax.swing.evnet的支援。我們瞭解架構在Swing文本組件中的支援。另外，我們瞭解了如何在我們自己的類中構建支援。通過使用Undo架構中的介面與類，我們可以使得任意可編輯的類同時支援撤銷與重做功能。
下一章將會介紹Swing組件集合的可訪問性支援。到時我們將會瞭解組件的輔助技術與聲音支援。