/******************************************************************************* * Copyright (c) 2000, 2012 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.*; import org.eclipse.swt.internal.*; import org.eclipse.swt.internal.win32.*; /** * Instances of this class allow the user to navigate * the file system and select or enter a file name. *
* Note: Only one of the styles SAVE and OPEN may be specified. *
* IMPORTANT: This class is not intended to be subclassed. *
* * @see FileDialog snippets * @see SWT Example: ControlExample, Dialog tab * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class FileDialog extends Dialog { String [] filterNames = new String [0]; String [] filterExtensions = new String [0]; String [] fileNames = new String [0]; String filterPath = "", fileName = ""; int filterIndex = 0; boolean overwrite = false; static final String FILTER = "*.*"; static int BUFFER_SIZE = 1024 * 32; static boolean USE_HOOK = true; static { /* * Feature in Vista. When OFN_ENABLEHOOK is set in the * save or open file dialog, Vista uses the old XP look * and feel. OFN_ENABLEHOOK is used to grow the file * name buffer in a multi-select file dialog. The fix * is to only use OFN_ENABLEHOOK when the buffer has * overrun. */ USE_HOOK = false; } /** * Constructs a new instance of this class given only its parent. * * @param parent a shell which will be the parent of the new instance * * @exception IllegalArgumentException
* The style value is either one of the style constants defined in
* class SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
* This is an index into the FilterExtensions array and * the FilterNames array. *
* * @return index the file extension filter index * * @see #getFilterExtensions * @see #getFilterNames * * @since 3.4 */ public int getFilterIndex () { return filterIndex; } /** * Returns the names that describe the filter extensions * which the dialog will use to filter the files it shows. * * @return the list of filter names */ public String [] getFilterNames () { return filterNames; } /** * Returns the directory path that the dialog will use, or an empty * string if this is not set. File names in this path will appear * in the dialog, filtered according to the filter extensions. * * @return the directory path string * * @see #setFilterExtensions */ public String getFilterPath () { return filterPath; } /** * Returns the flag that the dialog will use to * determine whether to prompt the user for file * overwrite if the selected file already exists. * * @return true if the dialog will prompt for file overwrite, false otherwise * * @since 3.4 */ public boolean getOverwrite () { return overwrite; } long OFNHookProc (long hdlg, long uiMsg, long wParam, long lParam) { switch ((int)uiMsg) { case OS.WM_NOTIFY: OFNOTIFY ofn = new OFNOTIFY (); OS.MoveMemory (ofn, lParam, OFNOTIFY.sizeof); if (ofn.code == OS.CDN_SELCHANGE) { int lResult = (int)OS.SendMessage (ofn.hwndFrom, OS.CDM_GETSPEC, 0, 0); if (lResult > 0) { lResult += OS.MAX_PATH; OPENFILENAME lpofn = new OPENFILENAME (); OS.MoveMemory (lpofn, ofn.lpOFN, OPENFILENAME.sizeof); if (lpofn.nMaxFile < lResult) { long hHeap = OS.GetProcessHeap (); long lpstrFile = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, lResult * TCHAR.sizeof); if (lpstrFile != 0) { if (lpofn.lpstrFile != 0) OS.HeapFree (hHeap, 0, lpofn.lpstrFile); lpofn.lpstrFile = lpstrFile; lpofn.nMaxFile = lResult; OS.MoveMemory (ofn.lpOFN, lpofn, OPENFILENAME.sizeof); } } } } break; } return 0; } /** * Makes the dialog visible and brings it to the front * of the display. * * @return a string describing the absolute path of the first selected file, * or null if the dialog was cancelled or an error occurred * * @exception SWTException* The strings are platform specific. For example, on * some platforms, an extension filter string is typically * of the form "*.extension", where "*.*" matches all files. * For filters with multiple extensions, use semicolon as * a separator, e.g. "*.jpg;*.png". *
** Note: On Mac, setting the file extension filter affects how * app bundles are treated by the dialog. When a filter extension * having the app extension (.app) is selected, bundles are treated * as files. For all other extension filters, bundles are treated * as directories. When no filter extension is set, bundles are * treated as files. *
* * @param extensions the file extension filter * * @see #setFilterNames to specify the user-friendly * names corresponding to the extensions */ public void setFilterExtensions (String [] extensions) { filterExtensions = extensions; } /** * Set the 0-based index of the file extension filter * which the dialog will use initially to filter the files * it shows to the argument. ** This is an index into the FilterExtensions array and * the FilterNames array. *
* * @param index the file extension filter index * * @see #setFilterExtensions * @see #setFilterNames * * @since 3.4 */ public void setFilterIndex (int index) { filterIndex = index; } /** * Sets the names that describe the filter extensions * which the dialog will use to filter the files it shows * to the argument, which may be null. *
* Each name is a user-friendly short description shown for
* its corresponding filter. The names
array must
* be the same length as the extensions
array.
*
* Note that the path string is platform dependent. * For convenience, either '/' or '\' can be used * as a path separator. *
* * @param string the directory path * * @see #setFilterExtensions */ public void setFilterPath (String string) { filterPath = string; } /** * Sets the flag that the dialog will use to * determine whether to prompt the user for file * overwrite if the selected file already exists. * * @param overwrite true if the dialog will prompt for file overwrite, false otherwise * * @since 3.4 */ public void setOverwrite (boolean overwrite) { this.overwrite = overwrite; } }