1: //========================================================================================
     2: //  JFileChooser2.java
     3: //    en:JFileChooser2 -- Modified JFileChooser
     4: //    ja:JFileChooser2 -- JFileChooserの改造
     5: //  Copyright (C) 2003-2023 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: //  https://stdkmd.net/xeij/
    11: //========================================================================================
    12: 
    13: //----------------------------------------------------------------------------------------
    14: //JFileChooserの改造
    15: //  履歴
    16: //    ファイルチューザーのファイル名のテキストフィールドをコンボボックスに変更する
    17: //    コンボボックスのリストに最近使ったファイルを表示して簡単に選択できるようにする
    18: //  バグ対策
    19: //    ファイルチューザーのテキストフィールドに入力されたファイル名を確実に取り出せるようにする
    20: //    JFileChooserのgetSelectedFile()の説明には
    21: //      Returns the selected file. This can be set either by the programmer via setSelectedFile or by a user action,
    22: //      such as either typing the filename into the UI or selecting the file from a list in the UI.
    23: //    と書かれており、テキストフィールドに入力されたファイル名もgetSelectedFile()で取り出せることになっている
    24: //    しかし、実際にはsetSelectedFile()で設定したかファイルの一覧をクリックして選択したファイル名しか取り出すことができない
    25: //    これでは新しいファイルを作れないだけでなく、
    26: //    ファイルの一覧をクリックしてテキストフィールドに既存のファイル名を表示させた後にそれを書き換えて新規のファイル名を入力すると、
    27: //    入力した新規のファイル名ではなくクリックした既存のファイル名が返るため、既存のファイルを破壊してしまう可能性がある
    28: //----------------------------------------------------------------------------------------
    29: 
    30: package xeij;
    31: 
    32: 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
    33: 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
    34: import java.io.*;  //BufferedInputStream,BufferedOutputStream,BufferedReader,BufferedWriter,File,FileInputStream,FileNotFoundException,FileReader,InputStream,InputStreamReader,IOException,OutputStreamWriter,RandomAccessFile
    35: import java.lang.*;  //Boolean,Character,Class,Comparable,Double,Exception,Float,IllegalArgumentException,Integer,Long,Math,Number,Object,Runnable,SecurityException,String,StringBuilder,System
    36: import java.util.*;  //ArrayList,Arrays,Calendar,GregorianCalendar,HashMap,Map,Map.Entry,Timer,TimerTask,TreeMap
    37: import java.util.regex.*;  //Matcher,Pattern
    38: 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
    39: import javax.swing.event.*;  //CaretListener,ChangeEvent,ChangeListener,DocumentEvent,DocumentListener,ListSelectionListener
    40: import javax.swing.text.*;  //AbstractDocument,BadLocationException,DefaultCaret,Document,DocumentFilter,JTextComponent,ParagraphView,Style,StyleConstants,StyleContext,StyledDocument
    41: 
    42: public class JFileChooser2 extends JFileChooser {
    43: 
    44:   private static final boolean DEBUG = false;
    45: 
    46:   //履歴
    47:   public static final int MAXIMUM_HISTORY_COUNT = 100;  //履歴の長さの上限
    48:   public static final int MAXIMUM_ROW_COUNT = 10;  //コンボボックスの行数の上限
    49:   protected ArrayList<File[]> history;  //履歴。消去するとnew File[0]だけになる。空にはならない
    50: 
    51:   //コンポーネント
    52:   protected JTextField formerTextField;  //元のテキストフィールド
    53:   protected JComboBox<String> comboBox;  //コンボボックス
    54:   protected JTextField comboBoxTextField;  //コンボボックスのテキストフィールド
    55:   protected int ignoreItemEvent;  //コンボボックスのアイテムイベントを0=処理する,0以外=処理しない
    56: 
    57:   //テキストフィールドのファイル名の正規表現
    58:   //  ファイル名をそのまま書くまたは"～"で囲んで書く
    59:   //  ' 'または','で区切って複数のファイル名を書ける
    60:   //  ' 'または','を含むファイル名は"～"で囲めば書ける
    61:   //  '"'を含むファイル名は書けない
    62:   //  0文字のファイル名は書けない
    63:   protected static final Pattern NAME_PATTERN = Pattern.compile ("\\s*+(?:,\\s*+)*+(?:([^\",]++)|\"([^\"]++)\"?+)");
    64: 
    65:   //コンストラクタ
    66:   public JFileChooser2 () {
    67:     this (new File[0]);
    68:   }
    69:   public JFileChooser2 (File file) {
    70:     this (new File[] { file });
    71:   }
    72:   @SuppressWarnings ("this-escape") public JFileChooser2 (File[] files) {
    73:     history = new ArrayList<File[]> ();
    74:     history.add (files);
    75:     formerTextField = null;
    76:     comboBox = null;
    77:     comboBoxTextField = null;
    78:     ignoreItemEvent = 0;
    79:     //元のテキストフィールドを求める
    80:     //  ファイルチューザーの構造が異なると失敗する可能性がある
    81:     if (false) {
    82:       ComponentFactory.printComponentTree (this);  //[this-escape]
    83:       //  0.3. javax.swing.JPanel
    84:       //    0.3.0. javax.swing.JPanel
    85:       //      0.3.0.0. javax.swing.plaf.metal.MetalFileChooserUI$AlignedLabel < javax.swing.JLabel
    86:       //      0.3.0.1. javax.swing.plaf.metal.MetalFileChooserUI$3 < javax.swing.JTextField
    87:     }
    88:     JPanel fileNamePanel;
    89:     try {
    90:       fileNamePanel = (JPanel) ((JPanel) getComponent (3)).getComponent (0);  //ファイル名のパネル
    91:       formerTextField = (JTextField) fileNamePanel.getComponent (1);  //元のテキストフィールド
    92:     } catch (Exception e) {
    93:       e.printStackTrace ();
    94:       return;
    95:     }
    96:     //コンボボックスを作る
    97:     //  元のテキストフィールドはJTextFieldの名無しサブクラスなので直接置き換えるのは難しい
    98:     //  元のテキストフィールドを削除してコンボボックスを追加する
    99:     //  元のテキストフィールドのテキストが更新されたらコンボボックスにコピーする
   100:     comboBox = new JComboBox<String> (new String[0]);  //コンボボックス
   101:     comboBox.setEditable (true);  //編集可能
   102:     comboBox.setMaximumRowCount (MAXIMUM_ROW_COUNT);  //最大行数
   103:     //コンボボックスのテキストフィールドを求める
   104:     comboBoxTextField = (JTextField) comboBox.getEditor ().getEditorComponent ();  //コンボボックスのテキストフィールド
   105:     comboBoxTextField.setColumns (formerTextField.getColumns ());  //桁数をコピーする
   106:     comboBoxTextField.setText (formerTextField.getText ());  //元のテキストフィールドのテキストをコンボボックスにコピーする
   107:     //元のテキストフィールドを削除する
   108:     fileNamePanel.remove (formerTextField);
   109:     //コンボボックスを追加する
   110:     fileNamePanel.add (comboBox);
   111:     //再配置する
   112:     fileNamePanel.validate ();
   113:     //元のテキストフィールドにドキュメントリスナーを設定する
   114:     ((AbstractDocument) formerTextField.getDocument ()).addDocumentListener (new DocumentListener () {
   115:       @Override public void changedUpdate (DocumentEvent de) {
   116:         if (DEBUG) {
   117:           System.out.println ("formerTextField.changedUpdate");
   118:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   119:         }
   120:       }
   121:       @Override public void insertUpdate (DocumentEvent de) {
   122:         if (DEBUG) {
   123:           System.out.println ("formerTextField.insertUpdate");
   124:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   125:         }
   126:         if (ignoreItemEvent == 0) {
   127:           ignoreItemEvent++;
   128:           comboBoxTextField.setText (formerTextField.getText ());  //元のテキストフィールドのテキストをコンボボックスにコピーする
   129:           ignoreItemEvent--;
   130:         }
   131:       }
   132:       @Override public void removeUpdate (DocumentEvent de) {
   133:         if (DEBUG) {
   134:           System.out.println ("formerTextField.removeUpdate");
   135:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   136:         }
   137:         if (ignoreItemEvent == 0) {
   138:           ignoreItemEvent++;
   139:           comboBoxTextField.setText (formerTextField.getText ());  //元のテキストフィールドのテキストをコンボボックスにコピーする
   140:           ignoreItemEvent--;
   141:         }
   142:       }
   143:     });
   144:     //コンボボックスのテキストフィールドにドキュメントリスナーを設定する
   145:     ((AbstractDocument) comboBoxTextField.getDocument ()).addDocumentListener (new DocumentListener () {
   146:       @Override public void changedUpdate (DocumentEvent de) {
   147:         if (DEBUG) {
   148:           System.out.println ("comboBoxTextField.changedUpdate");
   149:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   150:         }
   151:       }
   152:       @Override public void insertUpdate (DocumentEvent de) {
   153:         if (DEBUG) {
   154:           System.out.println ("comboBoxTextField.insertUpdate");
   155:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   156:         }
   157:         if (ignoreItemEvent == 0) {
   158:           ignoreItemEvent++;
   159:           setSelectedFiles (namesToFiles (comboBoxTextField.getText ()));  //コンボボックスのテキストのファイルを選択する
   160:           ignoreItemEvent--;
   161:         }
   162:       }
   163:       @Override public void removeUpdate (DocumentEvent de) {
   164:         if (DEBUG) {
   165:           System.out.println ("comboBoxTextField.removeUpdate");
   166:           System.out.println ("  getText()=\"" + formerTextField.getText () + "\"");
   167:         }
   168:         if (ignoreItemEvent == 0) {
   169:           ignoreItemEvent++;
   170:           setSelectedFiles (namesToFiles (comboBoxTextField.getText ()));  //コンボボックスのテキストのファイルを選択する
   171:           ignoreItemEvent--;
   172:         }
   173:       }
   174:     });
   175:     //コンボボックスにアイテムリスナーを設定する
   176:     comboBox.addItemListener (new ItemListener () {
   177:       @Override public void itemStateChanged (ItemEvent ie) {
   178:         if (DEBUG) {
   179:           System.out.println ("comboBox.itemStateChanged");
   180:           System.out.println ("  getSelectedIndex()=" + comboBox.getSelectedIndex ());
   181:           System.out.println ("  getText()=" + comboBoxTextField.getText ());
   182:         }
   183:         if (ignoreItemEvent == 0) {
   184:           ignoreItemEvent++;
   185:           if (ie.getStateChange () == ItemEvent.SELECTED) {
   186:             int i = comboBox.getSelectedIndex ();
   187:             if (0 <= i) {
   188:               if (i < history.size ()) {
   189:                 File[] files = history.get (i);  //選択されたファイルを
   190:                 history.remove (i);
   191:                 history.add (0, files);  //履歴の先頭に移す
   192:               } else {
   193:                 clearHistory ();  //履歴を消去する
   194:                 //キャンセルしたときも消去が選択されたままなので元に戻す
   195:               }
   196:               historyToComboBox ();  //履歴をコンボボックスにコピーする
   197:               selectLastFiles ();  //履歴の先頭のファイルを選択する
   198:             }
   199:           }
   200:           ignoreItemEvent--;
   201:         }
   202:       }
   203:     });
   204:     historyToComboBox ();  //履歴をコンボボックスにコピーする
   205:     selectLastFiles ();  //履歴の先頭のファイルを選択する
   206:   }
   207: 
   208:   //clearHistory ()
   209:   //  履歴を消去する
   210:   //  コンボボックスは操作しない
   211:   public void clearHistory () {
   212:     if (JOptionPane.showConfirmDialog (
   213:       this,
   214:       Multilingual.mlnJapanese ? "履歴を消去しますか？" : "Do you want to clear history?",
   215:       Multilingual.mlnJapanese ? "確認" : "Confirmation",
   216:       JOptionPane.YES_NO_OPTION,
   217:       JOptionPane.PLAIN_MESSAGE) == JOptionPane.YES_OPTION) {
   218:       history.clear ();  //履歴を消去する
   219:       history.add (0, new File[0]);
   220:     }
   221:   }
   222: 
   223:   //selectLastFiles ()
   224:   //  履歴の先頭のファイルを選択する
   225:   public void selectLastFiles () {
   226:     if (DEBUG) {
   227:       System.out.println ("selectLastFiles");
   228:       if (history.size () != 0) {
   229:         System.out.println ("  " + filesToPaths (history.get (0)));
   230:       }
   231:     }
   232:     if (history.size () != 0) {
   233:       File[] files = history.get (0);
   234:       if (files.length == 0) {
   235:         setCurrentDirectory (new File (".").getAbsoluteFile ().getParentFile ());
   236:       }
   237:       setSelectedFiles (files);
   238:     }
   239:   }
   240: 
   241:   //file = getSelectedFile ()
   242:   //  選択されたファイルを返す
   243:   //  選択されたファイルがないときはnullを返す
   244:   @Override public File getSelectedFile () {
   245:     if (DEBUG) {
   246:       System.out.println ("getSelectedFile");
   247:     }
   248:     File[] files = getSelectedFiles ();
   249:     return files.length == 0 ? null : files[0];
   250:   }
   251: 
   252:   //files = getSelectedFiles ()
   253:   //  選択された複数のファイルを返す
   254:   //  選択されたファイルがないときは長さ0の配列を返す
   255:   @Override public File[] getSelectedFiles () {
   256:     if (DEBUG) {
   257:       System.out.println ("getSelectedFiles");
   258:     }
   259:     if (comboBox == null) {  //コンストラクタの中で準備ができていない
   260:       return super.getSelectedFiles ();
   261:     }
   262:     File[] files = namesToFiles (comboBoxTextField.getText ());
   263:     if (DEBUG) {
   264:       for (int i = 0; i < files.length; i++) {
   265:         File file = files[i];
   266:         System.out.println ("  " + file.getPath ());
   267:       }
   268:     }
   269:     return files;
   270:   }
   271: 
   272:   //setSelectedFile (file)
   273:   //  ファイルを選択する
   274:   @Override public void setSelectedFile (File file) {
   275:     if (DEBUG) {
   276:       System.out.println ("setSelectedFile");
   277:       if (file != null) {
   278:         System.out.println ("  " + file.getPath ());
   279:       }
   280:     }
   281:     //setSelectedFiles (new File[] { file });
   282:     //ignoreItemEvent++;
   283:     super.setSelectedFile (file);
   284:     //ignoreItemEvent--;
   285:   }
   286: 
   287:   //setSelectedFiles (files)
   288:   //  複数のファイルを選択する
   289:   @Override public void setSelectedFiles (File[] files) {
   290:     if (DEBUG) {
   291:       System.out.println ("setSelectedFiles");
   292:       if (files != null) {
   293:         for (File file : files) {
   294:           System.out.println ("  " + file.getPath ());
   295:         }
   296:       }
   297:     }
   298:     //ディレクトリを選択すると親ディレクトリが開いてしまうので末尾に"./"を付ける
   299:     File[] dotFiles = null;
   300:     if (files != null) {
   301:       dotFiles = new File[files.length];
   302:       for (int i = 0; i < files.length; i++) {
   303:         File file = files[i];
   304:         dotFiles[i] = file.isDirectory () ? new File (file, ".") : file;
   305:       }
   306:     }
   307:     //ignoreItemEvent++;
   308:     super.setSelectedFiles (dotFiles);
   309:     //ignoreItemEvent--;
   310:   }
   311: 
   312:   //addHistory (file)
   313:   //  ファイルを履歴に追加する
   314:   public void addHistory (File file) {
   315:     if (DEBUG) {
   316:       System.out.println ("addHistory");
   317:       if (file != null) {
   318:         System.out.println ("  " + file.getPath ());
   319:       }
   320:     }
   321:     if (file != null) {
   322:       addHistory (new File[] { file });
   323:     }
   324:   }
   325: 
   326:   //addHistory (paths)
   327:   //  パス名を並べた文字列をファイルの配列に変換して履歴に追加する
   328:   public void addHistory (String paths) {
   329:     addHistory (pathsToFiles (paths));
   330:   }  //addHistory
   331: 
   332:   //addHistory (files)
   333:   //  複数のファイルを履歴に追加する
   334:   public void addHistory (File[] files) {
   335:     if (DEBUG) {
   336:       System.out.println ("addHistory");
   337:       if (files != null) {
   338:         for (File file : files) {
   339:           System.out.println ("  " + file.getPath ());
   340:         }
   341:       }
   342:     }
   343:     if (files == null || files.length == 0) {  //ファイルがない
   344:       return;
   345:     }
   346:     for (int i = 0; i < history.size (); i++) {
   347:       File[] files2 = history.get (i);
   348:       if (files2.length == 0 ||  //空
   349:           Arrays.equals (files, files2)) {  //一致
   350:         history.remove (i);  //削除する
   351:         i--;
   352:       }
   353:     }
   354:     if (history.size () == MAXIMUM_HISTORY_COUNT) {  //一杯
   355:       history.remove (MAXIMUM_HISTORY_COUNT - 1);  //末尾を削る
   356:     }
   357:     history.add (0, files);  //先頭に追加する
   358:     historyToComboBox ();  //履歴をコンボボックスにコピーする
   359:   }
   360: 
   361:   //pathsList = getHistory ()
   362:   //  履歴をパス名を並べた文字列のリストに変換する
   363:   public ArrayList<String> getHistory () {
   364:     if (DEBUG) {
   365:       System.out.println ("getHistory");
   366:     }
   367:     ArrayList<String> pathsList = new ArrayList<String> ();
   368:     for (File[] files : history) {
   369:       pathsList.add (filesToPaths (files));
   370:     }
   371:     return pathsList;
   372:   }
   373: 
   374:   //setHistory (pathsList)
   375:   //  パス名を並べた文字列のリストを履歴に変換する
   376:   public void setHistory (ArrayList<String> pathsList) {
   377:     if (DEBUG) {
   378:       System.out.println ("setHistory");
   379:       if (pathsList != null) {
   380:         for (String paths : pathsList) {
   381:           System.out.println ("  " + paths);
   382:         }
   383:       }
   384:     }
   385:     history.clear ();
   386:   list:
   387:     for (String paths : pathsList) {  //新しい順
   388:       File[] files = pathsToFiles (paths);
   389:       if (files.length == 0) {  //ファイルがない
   390:         continue list;
   391:       }
   392:       for (File[] newerFiles : history) {
   393:         if (Arrays.equals (files, newerFiles)) {  //既にある
   394:           continue list;
   395:         }
   396:       }
   397:       history.add (files);  //末尾に追加する
   398:       if (history.size () == MAXIMUM_HISTORY_COUNT) {  //一杯になった
   399:         break list;
   400:       }
   401:     }
   402:     historyToComboBox ();  //履歴をコンボボックスにコピーする
   403:   }
   404: 
   405:   //historyToComboBox ()
   406:   //  履歴をコンボボックスにコピーする
   407:   protected void historyToComboBox () {
   408:     if (DEBUG) {
   409:       System.out.println ("historyToComboBox");
   410:       for (File[] files : history) {
   411:         System.out.println ("  " + filesToPaths (files));
   412:       }
   413:     }
   414:     ignoreItemEvent++;
   415:     comboBox.removeAllItems ();
   416:     for (File[] files : history) {
   417:       comboBox.addItem (filesToNames (files));
   418:     }
   419:     comboBox.addItem (Multilingual.mlnJapanese ?
   420:                       "---------- 履歴を消去する ----------" :
   421:                       "---------- Clear history ----------");
   422:     ignoreItemEvent--;
   423:   }
   424: 
   425:   //names = filesToNames (files)
   426:   //  ファイルの配列をファイル名を並べた文字列に変換する
   427:   public String filesToNames (File[] files) {
   428:     StringBuilder sb = new StringBuilder ();
   429:     int n = files.length;
   430:     if (n == 0) {
   431:     } else if (n == 1) {
   432:       sb.append (files[0].getName ());  //ファイル名
   433:     } else {
   434:       for (int i = 0; i < n; i++) {
   435:         if (0 < i) {
   436:           sb.append (' ');
   437:         }
   438:         sb.append ('"').append (files[i].getName ()).append ('"');  //ファイル名
   439:       }
   440:     }
   441:     return sb.toString ();
   442:   }
   443: 
   444:   //files = namesToFiles (names)
   445:   //  ファイル名を並べた文字列をファイルの配列に変換する
   446:   //  ファイル名がないときは長さ0の配列を返す
   447:   public File[] namesToFiles (String names) {
   448:     File directory = getCurrentDirectory ();  //現在のディレクトリ
   449:     ArrayList<File> fileList = new ArrayList<File> ();
   450:     Matcher matcher = NAME_PATTERN.matcher (names);
   451:     while (matcher.find ()) {
   452:       String name = matcher.group (1) != null ? matcher.group (1) : matcher.group (2);
   453:       File file = new File (directory, name).getAbsoluteFile ();
   454:       if (!fileList.contains (file)) {  //重複しない
   455:         fileList.add (file);
   456:       }
   457:     }
   458:     return fileList.toArray (new File[fileList.size ()]);
   459:   }
   460: 
   461:   //paths = filesToPaths (files)
   462:   //  ファイルの配列をパス名を並べた文字列に変換する
   463:   public static String filesToPaths (File[] files) {
   464:     StringBuilder sb = new StringBuilder ();
   465:     int n = files.length;
   466:     if (n == 0) {
   467:     } else if (n == 1) {
   468:       sb.append (files[0].getPath ());  //パス名
   469:     } else {
   470:       for (int i = 0; i < n; i++) {
   471:         if (0 < i) {
   472:           sb.append (' ');
   473:         }
   474:         sb.append ('"').append (files[i].getPath ()).append ('"');  //パス名
   475:       }
   476:     }
   477:     return sb.toString ();
   478:   }
   479: 
   480:   //files = pathsToFiles (paths)
   481:   //  パス名を並べた文字列をファイルの配列に変換する
   482:   //  パス名がないときは長さ0の配列を返す
   483:   public static File[] pathsToFiles (String paths) {
   484:     ArrayList<File> fileList = new ArrayList<File> ();
   485:     Matcher matcher = NAME_PATTERN.matcher (paths);
   486:     while (matcher.find ()) {
   487:       String path = matcher.group (1) != null ? matcher.group (1) : matcher.group (2);
   488:       File file = new File (path).getAbsoluteFile ();
   489:       if (!fileList.contains (file)) {  //重複しない
   490:         fileList.add (file);
   491:       }
   492:     }
   493:     return fileList.toArray (new File[fileList.size ()]);
   494:   }
   495: 
   496: }  //class JFileChooser2
   497: 
   498: 
   499: