RestorableFrame.java
     1: //========================================================================================
     2: //  RestorableFrame.java
     3: //    en:Restorable frame -- It is a frame that you can easily save and restore the position, size and state.
     4: //    ja:リストアラブルフレーム -- 位置とサイズと状態の保存と復元が簡単にできるフレームです。
     5: //  Copyright (C) 2003-2017 Makoto Kamada
     6: //
     7: //  This file is part of the XEiJ (X68000 Emulator in Java).
     8: //  You can use, modify and redistribute the XEiJ if the conditions are met.
     9: //  Read the XEiJ License for more details.
    10: //  http://stdkmd.com/xeij/
    11: //========================================================================================
    12: 
    13: //----------------------------------------------------------------------------------------
    14: //  コンストラクタでインスタンスのキーを指定する
    15: //    キーに対応するインスタンスの位置とサイズと状態が指定されていなければダミーの位置とサイズと状態を記憶する
    16: //  クラスメソッドでキーに対応するインスタンスの位置とサイズと状態を指定する
    17: //    キーに対応するインスタンスが既に存在して表示されていたら位置とサイズと状態を復元する
    18: //  コンポーネントリスナーとウインドウステートリスナーでインスタンスの位置とサイズと状態を復元または記憶する
    19: //    表示されていないときは何もしない
    20: //    初めて表示されたときインスタンスの位置とサイズと状態を復元する
    21: //      サイズは表示された後に復元しなければならない
    22: //    2回目以降はインスタンスの位置とサイズと状態を記憶する
    23: //  クラスメソッドでキーに対応するインスタンスの位置とサイズと状態を取り出して保存する
    24: //  インスタンスメソッドは変更しない
    25: //    JFrameをRestorableFrameに置き換えるとき変数宣言の型を変更しなくて済む
    26: //  最大化しているときは位置とサイズを保存しない
    27: //    最大化している状態で位置とサイズを保存してしまうと復元した後に元の大きさに戻せなくなる
    28: //    最大化した状態を復元するときは最大化する前の位置とサイズを復元してから最大化させる
    29: //  水平方向だけ最大化または垂直方向だけ最大化
    30: //    Windows7の場合、通常のウインドウはウインドウの枠を左ダブルクリックするとウインドウを水平方向だけ最大化または垂直方向だけ最大化できる
    31: //    しかし、JFrameには水平方向だけ最大化または垂直方向だけ最大化する機能がないらしい
    32: //    枠を左ダブルクリックしてもウインドウのサイズが変わらない
    33: //    Frame.getExtendedState()はMAXIMIZED_HORIZまたはFrame.MAXIMIZED_VERTを返さない
    34: //    Frame.setExtendedState()にMAXIMIZED_HORIZまたはFrame.MAXIMIZED_VERTを与えてもウインドウのサイズが変わらない
    35: //  Frame.getExtendedState()では全画面表示を判別できない
    36: //    GraphicsEnvironment.getLocalGraphicsEnvironment ().getDefaultScreenDevice ().getFullScreenWindow () == frameで判別する
    37: //----------------------------------------------------------------------------------------
    38: 
    39: package xeij;
    40: 
    41: import java.awt.*;  //BasicStroke,BorderLayout,BoxLayout,Color,Component,Container,Cursor,Desktop,Dimension,Font,Frame,Graphics,Graphics2D,GraphicsDevice,GraphicsEnvironment,GridLayout,Image,Insets,Paint,Point,Rectangle,RenderingHints,Robot,Shape,Stroke,TexturePaint,Toolkit
    42: import java.awt.event.*;  //ActionEvent,ActionListener,ComponentAdapter,ComponentEvent,ComponentListener,FocusAdapter,FocusEvent,FocusListener,InputEvent,KeyAdapter,KeyEvent,KeyListener,MouseAdapter,MouseEvent,MouseListener,MouseMotionAdapter,MouseWheelEvent,WindowAdapter,WindowEvent,WindowListener,WindowStateListener
    43: import java.awt.image.*;  //BufferedImage,DataBuffer,DataBufferByte,DataBufferInt,IndexColorModel
    44: import java.lang.*;  //Boolean,Character,Class,Comparable,Double,Exception,Float,IllegalArgumentException,Integer,Long,Math,Number,Object,Runnable,SecurityException,String,StringBuilder,System
    45: import java.util.*;  //ArrayList,Arrays,Calendar,GregorianCalendar,HashMap,Map,Map.Entry,Timer,TimerTask,TreeMap
    46: import javax.swing.*;  //AbstractSpinnerModel,Box,ButtonGroup,DefaultListModel,ImageIcon,JApplet,JButton,JCheckBox,JCheckBoxMenuItem,JDialog,JFileChooser,JFrame,JLabel,JList,JMenu,JMenuBar,JMenuItem,JPanel,JRadioButton,JScrollPane,JSpinner,JTextArea,JTextField,JTextPane,JViewport,ScrollPaneConstants,SpinnerListModel,SpinnerNumberModel,SwingConstants,SwingUtilities,UIManager,UIDefaults,UnsupportedLookAndFeelException
    47: 
    48: public class RestorableFrame extends JFrame {
    49: 
    50:   //クラス変数
    51:   protected static HashMap<String,RestorableFrame> rfmKeyToFrame;
    52:   protected static HashMap<String,Rectangle> rfmKeyToBounds;
    53:   protected static HashMap<String,Integer> rfmKeyToState;
    54:   protected static HashMap<String,Boolean> rfmKeyToOpened;  //ウインドウが開いているかどうか。これはまとめて保存しやすくするための情報。そもそもインスタンスを作らなければ開けないのだから実際に開く処理はインスタンスを作る側で行う
    55: 
    56:   //クラスメソッド
    57: 
    58:   //rfmInit ()
    59:   //  初期化
    60:   public static void rfmInit () {
    61:     rfmKeyToFrame = new HashMap<String,RestorableFrame> ();
    62:     rfmKeyToBounds = new HashMap<String,Rectangle> ();
    63:     rfmKeyToState = new HashMap<String,Integer> ();
    64:     rfmKeyToOpened = new HashMap<String,Boolean> ();
    65:   }  //rfmInit()
    66: 
    67:   //bounds = rfmGetBounds (key)
    68:   //  インスタンスの位置とサイズを読み出す
    69:   public static Rectangle rfmGetBounds (String key) {
    70:     return rfmKeyToBounds.containsKey (key) ? rfmKeyToBounds.get (key) : new Rectangle ();
    71:   }  //rfmGetBounds(String)
    72: 
    73:   //rfmSetBounds (key, bounds)
    74:   //  インスタンスの位置とサイズを指定する
    75:   public static void rfmSetBounds (String key, Rectangle bounds) {
    76:     rfmKeyToBounds.put (key, bounds);  //新しい位置とサイズ
    77:     if (rfmKeyToFrame.containsKey (key)) {  //インスタンスが既にあるとき
    78:       RestorableFrame frame = rfmKeyToFrame.get (key);  //インスタンス
    79:       if (frame.isShowing ()) {  //表示されている
    80:         frame.setLocation (bounds.x, bounds.y);  //位置を復元する
    81:         if (bounds.width > 0 && bounds.height > 0) {  //サイズが保存されているとき
    82:           frame.setSize (bounds.width, bounds.height);  //サイズを復元する
    83:         }
    84:       }
    85:     }
    86:   }  //rfmSetBounds(String,Rectangle)
    87: 
    88:   //state = rfmGetState (key)
    89:   //  インスタンスの状態を読み出す
    90:   public static int rfmGetState (String key) {
    91:     return rfmKeyToState.containsKey (key) ? rfmKeyToState.get (key) : Frame.NORMAL;
    92:   }  //rfmGetState(String)
    93: 
    94:   //rfmSetState (key, state)
    95:   //  インスタンスの状態を指定する
    96:   public static void rfmSetState (String key, int state) {
    97:     rfmKeyToState.put (key, state);  //新しい状態
    98:     if (rfmKeyToFrame.containsKey (key)) {  //インスタンスが既にあるとき
    99:       RestorableFrame frame = rfmKeyToFrame.get (key);  //インスタンス
   100:       if (frame.isShowing ()) {  //表示されている
   101:         frame.setExtendedState (state);  //状態を復元する
   102:       }
   103:     }
   104:   }  //rfmSetState(String,int)
   105: 
   106:   //opened = rfmGetOpened (key)
   107:   //  ウインドウが開いているかどうかを読み出す
   108:   public static boolean rfmGetOpened (String key) {
   109:     return rfmKeyToOpened.containsKey (key) && rfmKeyToOpened.get (key);
   110:   }  //rfmGetOpened(String)
   111: 
   112:   //rfmSetOpened (key, opened)
   113:   //  ウインドウが開いているかどうかを指定する
   114:   public static void rfmSetOpened (String key, boolean opened) {
   115:     rfmKeyToOpened.put (key, opened);
   116:     //フレームは操作しない
   117:   }  //rfmSetOpened(String,boolean)
   118: 
   119:   //image = rfmCapture (key)
   120:   //  ウインドウをキャプチャする
   121:   public static BufferedImage rfmCapture (String key) {
   122:     if (rfmGetOpened (key)) {  //存在して開いている
   123:       rfmKeyToFrame.get (key).rfmUpdate ();  //レクタングルを更新する
   124:       Rectangle rect = rfmGetBounds (key);
   125:       if (!rect.isEmpty ()) {  //空ではない
   126:         try {
   127:           return new Robot().createScreenCapture (rect);
   128:         } catch (Exception e) {
   129:         }
   130:       }
   131:     }
   132:     return null;
   133:   }  //rfmCapture(String)
   134: 
   135:   //インスタンス変数
   136:   private String rfmKey;  //キー
   137:   private boolean rfmRestored;  //false=まだ復元されていない,true=復元済み
   138: 
   139:   //コンストラクタ
   140:   public RestorableFrame (String key) {
   141:     this (key, "", GraphicsEnvironment.getLocalGraphicsEnvironment ().getDefaultScreenDevice ().getDefaultConfiguration ());
   142:   }
   143:   public RestorableFrame (String key, GraphicsConfiguration gc) {
   144:     this (key, "", gc);
   145:   }
   146:   public RestorableFrame (String key, String title) {
   147:     this (key, title, GraphicsEnvironment.getLocalGraphicsEnvironment ().getDefaultScreenDevice ().getDefaultConfiguration ());
   148:   }
   149:   public RestorableFrame (String key, String title, GraphicsConfiguration gc) {
   150:     super (title, gc);
   151:     rfmKey = key;  //キー
   152:     rfmRestored = false;  //まだ復元されていない
   153:     if (rfmKeyToFrame.containsKey (key)) {  //同じキーを持つインスタンスが既にあるとき
   154:       throw new IllegalArgumentException ("RestorableFrame: Key " + key + " is already used.");
   155:     }
   156:     rfmKeyToFrame.put (key, this);  //インスタンス
   157:     if (rfmKeyToBounds.containsKey (key)) {  //位置とサイズが既に指定されているとき
   158:       rfmRestoreBounds (rfmKeyToBounds.get (key));  //位置とサイズを復元する
   159:     } else {  //位置とサイズがまだ指定されていないとき
   160:       rfmKeyToBounds.put (key, new Rectangle ());  //ダミーの位置とサイズ
   161:     }
   162:     if (rfmKeyToState.containsKey (key)) {  //状態が既に指定されているとき
   163:       setExtendedState (rfmKeyToState.get (key));  //状態を復元する
   164:     } else {  //状態がまだ指定されていないとき
   165:       rfmKeyToState.put (key, Frame.NORMAL);  //ダミーの状態
   166:     }
   167:     //コンポーネントリスナー
   168:     addComponentListener (new ComponentAdapter () {
   169:       @Override public void componentMoved (ComponentEvent ce) {
   170:         rfmUpdate ();  //位置とサイズと状態を復元または記憶する
   171:       }
   172:       @Override public void componentResized (ComponentEvent ce) {
   173:         rfmUpdate ();  //位置とサイズと状態を復元または記憶する
   174:       }
   175:     });
   176:     //ウインドリスナー
   177:     addWindowListener (new WindowAdapter () {
   178:       @Override public void windowClosing (WindowEvent we) {
   179:         //HIDE_ON_CLOSEのときclosedは呼び出されないがclosingは呼び出される
   180:         rfmKeyToOpened.put (rfmKey, false);
   181:       }
   182:       @Override public void windowOpened (WindowEvent we) {
   183:         rfmKeyToOpened.put (rfmKey, true);
   184:       }
   185:     });
   186:     //ウインドウステートリスナー
   187:     addWindowStateListener (new WindowStateListener () {
   188:       @Override public void windowStateChanged (WindowEvent we) {
   189:         rfmUpdate ();  //位置とサイズと状態を復元または記憶する
   190:       }
   191:     });
   192:   }  //new RestorableFrame(String,String,GraphicsConfiguration)
   193: 
   194:   //rfmUpdate ()
   195:   //  位置とサイズと状態を復元または記憶する
   196:   private void rfmUpdate () {
   197:     if (!isShowing ()) {  //表示されていない
   198:       return;
   199:     }
   200:     for (GraphicsDevice gd : GraphicsEnvironment.getLocalGraphicsEnvironment ().getScreenDevices ()) {
   201:       if (gd.getFullScreenWindow () == this) {  //全画面表示
   202:         return;
   203:       }
   204:     }
   205:     if (!rfmRestored) {  //まだ復元されていない
   206:       rfmRestored = true;  //復元済み
   207:       rfmRestoreBounds (rfmKeyToBounds.get (rfmKey));  //位置とサイズを復元する
   208:       setExtendedState (rfmKeyToState.get (rfmKey));  //状態を復元する
   209:     } else {  //復元済み
   210:       Point p = getLocationOnScreen ();  //位置
   211:       Dimension d = getSize ();  //サイズ
   212:       int state = getExtendedState ();  //状態
   213:       //位置とサイズを記憶する
   214:       Rectangle bounds = rfmKeyToBounds.get (rfmKey);  //位置とサイズ
   215:       if ((state & (Frame.ICONIFIED | Frame.MAXIMIZED_HORIZ)) == 0) {  //アイコン化または水平方向に最大化されていない
   216:         //水平方向の要素を記憶する
   217:         bounds.x = p.x;
   218:         bounds.width = d.width;
   219:       }
   220:       if ((state & (Frame.ICONIFIED | Frame.MAXIMIZED_VERT)) == 0) {  //アイコン化または垂直方向に最大化されていない
   221:         //垂直方向の要素を記憶する
   222:         bounds.y = p.y;
   223:         bounds.height = d.height;
   224:       }
   225:       //状態を記憶する
   226:       rfmKeyToState.put (rfmKey, state);  //状態
   227:     }  //if まだ復元されていない/復元済み
   228:   }  //rfmUpdate()
   229: 
   230:   //rfmRestoreBounds (bounds)
   231:   //  位置とサイズを復元する
   232:   //  保存後にマルチスクリーン環境が変化して画面外に復元されると困るので、
   233:   //  ウインドウの上端の64x16ピクセルを含む画面がなければデフォルト画面の左上に復元する
   234:   private void rfmRestoreBounds (Rectangle bounds) {
   235:     Rectangle location = bounds;  //復元する位置
   236:   test:
   237:     {
   238:       Rectangle testBounds = new Rectangle (bounds.x, bounds.y, bounds.width, 16);
   239:       for (GraphicsDevice gd : GraphicsEnvironment.getLocalGraphicsEnvironment ().getScreenDevices ()) {
   240:         for (GraphicsConfiguration gc : gd.getConfigurations ()) {
   241:           Rectangle intersectionBounds = testBounds.intersection (gc.getBounds ());
   242:           if (intersectionBounds.width >= 64 && intersectionBounds.height >= 16) {
   243:             //ウインドウの上端の64x16ピクセルを含む画面が見つかった
   244:             break test;
   245:           }
   246:         }  //for gc
   247:       }  //for gd
   248:       //ウインドウの上端の64x16ピクセルを含む画面が見つからなかった
   249:       location = GraphicsEnvironment.getLocalGraphicsEnvironment ().getDefaultScreenDevice ().getDefaultConfiguration ().getBounds ();
   250:     }
   251:     setLocation (location.x, location.y);  //位置を復元する
   252:     if (bounds.width > 0 && bounds.height > 0) {  //サイズが保存されているとき
   253:       setSize (bounds.width, bounds.height);  //サイズを復元する
   254:     }
   255:   }  //rfmRestoreBounds(Rectangle)
   256: 
   257: }  //class RestorableFrame
   258: 
   259: 
   260: