| /******************************************************************************* |
| * Copyright (c) 2000, 2009 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.swt.widgets; |
| |
| |
| import org.eclipse.swt.internal.*; |
| import org.eclipse.swt.internal.photon.*; |
| import org.eclipse.swt.*; |
| |
| /** |
| * Instances of this class allow the user to navigate |
| * the file system and select or enter a file name. |
| * <dl> |
| * <dt><b>Styles:</b></dt> |
| * <dd>SAVE, OPEN, MULTI</dd> |
| * <dt><b>Events:</b></dt> |
| * <dd>(none)</dd> |
| * </dl> |
| * <p> |
| * Note: Only one of the styles SAVE and OPEN may be specified. |
| * </p><p> |
| * IMPORTANT: This class is <em>not</em> intended to be subclassed. |
| * </p> |
| * |
| * @see <a href="http://www.eclipse.org/swt/snippets/#filedialog">FileDialog snippets</a> |
| * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> |
| * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> |
| * @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 filterPath = "", fileName = ""; |
| int filterIndex = -1; |
| boolean overwrite = false; |
| static final String FILTER = "*"; |
| |
| /** |
| * 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 <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| */ |
| public FileDialog (Shell parent) { |
| this (parent, SWT.APPLICATION_MODAL); |
| } |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * and a style value describing its behavior and appearance. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * |
| * @param parent a shell which will be the parent of the new instance |
| * @param style the style of dialog to construct |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT#SAVE |
| * @see SWT#OPEN |
| * @see SWT#MULTI |
| */ |
| public FileDialog (Shell parent, int style) { |
| super (parent, checkStyle (parent, style)); |
| checkSubclass (); |
| } |
| |
| /** |
| * Returns the path of the first file that was |
| * selected in the dialog relative to the filter path, or an |
| * empty string if no such file has been selected. |
| * |
| * @return the relative path of the file |
| */ |
| public String getFileName () { |
| return fileName; |
| } |
| |
| /** |
| * Returns a (possibly empty) array with the paths of all files |
| * that were selected in the dialog relative to the filter path. |
| * |
| * @return the relative paths of the files |
| */ |
| public String [] getFileNames () { |
| if (fileName.length () == 0) return new String [0]; |
| return new String [] {fileName}; |
| } |
| |
| /** |
| * Returns the file extensions which the dialog will |
| * use to filter the files it shows. |
| * |
| * @return the file extensions filter |
| */ |
| public String [] getFilterExtensions () { |
| return filterExtensions; |
| } |
| |
| /** |
| * Get the 0-based index of the file extension filter |
| * which was selected by the user, or -1 if no filter |
| * was selected. |
| * <p> |
| * This is an index into the FilterExtensions array and |
| * the FilterNames array. |
| * </p> |
| * |
| * @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; |
| } |
| |
| /** |
| * 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 <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the dialog has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog</li> |
| * </ul> |
| */ |
| public String open () { |
| int parentHandle = 0; |
| if (parent != null && OS.PtWidgetIsRealized(parent.shellHandle)) { |
| parentHandle = parent.shellHandle; |
| } |
| byte [] title = null; |
| if (this.title != null) title = Converter.wcsToMbcs (null, this.title, true); |
| byte [] root_dir = null; |
| if (filterPath != null) { |
| root_dir = Converter.wcsToMbcs (null, filterPath, true); |
| } |
| |
| /* Compute the filter */ |
| String mask = FILTER; |
| /* |
| * Photon does not support filter names. |
| */ |
| if (filterNames == null) filterNames = new String [0]; |
| /* |
| * Photon supports only one filter with multiple patterns |
| * separated by commas. |
| */ |
| if (filterExtensions == null) filterExtensions = new String [0]; |
| if (filterExtensions.length > 0) { |
| String comma = ","; |
| mask = comma; |
| for (int i=0; i<filterExtensions.length; i++) { |
| String ext = filterExtensions [i]; |
| int length = ext.length(); |
| int end, start = 0; |
| do { |
| end = ext.indexOf(';', start); |
| if (end < 0) end = length; |
| String subExt = ext.substring(start, end).trim(); |
| if (subExt.length() > 0) { |
| subExt += comma; |
| if (mask.indexOf(comma + subExt) == -1) mask += subExt; |
| } |
| start = end + 1; |
| } while (end < length); |
| } |
| mask = mask.substring(1, Math.max(1, mask.length() - 1)); |
| } |
| byte [] file_spec = Converter.wcsToMbcs (null, mask, true); |
| byte [] btn1_text = null; |
| if ((style & SWT.SAVE) != 0) { |
| btn1_text = Converter.wcsToMbcs(null, SWT.getMessage("SWT_Save"), true); |
| } |
| int flags = OS.Pt_FSR_NO_FCHECK; |
| PtFileSelectionInfo_t info = new PtFileSelectionInfo_t (); |
| OS.PtFileSelection (parentHandle, null, title, root_dir, file_spec, btn1_text, null, null, info, flags); |
| if (info.ret == OS.Pt_FSDIALOG_BTN2) return null; |
| int length = 0; |
| while (length < info.path.length && info.path [length] != 0) length++; |
| byte [] path = new byte [length]; |
| System.arraycopy (info.path, 0, path, 0, length); |
| String fullPath = new String (Converter.mbcsToWcs (null, path)); |
| length = fullPath.length (); |
| if (length != 0) { |
| int index = length - 1; |
| while (index >= 0 && (fullPath.charAt (index) != '/')) --index; |
| fileName = fullPath.substring (index + 1, length); |
| filterPath = fullPath.substring (0, index); |
| filterIndex = filterExtensions == null || filterExtensions.length == 0 ? -1 : 0; |
| } |
| return fullPath; |
| } |
| |
| /** |
| * Set the initial filename which the dialog will |
| * select by default when opened to the argument, |
| * which may be null. The name will be prefixed with |
| * the filter path when one is supplied. |
| * |
| * @param string the file name |
| */ |
| public void setFileName (String string) { |
| fileName = string; |
| } |
| |
| /** |
| * Set the file extensions which the dialog will |
| * use to filter the files it shows to the argument, |
| * which may be null. |
| * <p> |
| * 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". |
| * </p> |
| * |
| * @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. |
| * <p> |
| * This is an index into the FilterExtensions array and |
| * the FilterNames array. |
| * </p> |
| * |
| * @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. |
| * <p> |
| * Each name is a user-friendly short description shown for |
| * its corresponding filter. The <code>names</code> array must |
| * be the same length as the <code>extensions</code> array. |
| * </p> |
| * |
| * @param names the list of filter names, or null for no filter names |
| * |
| * @see #setFilterExtensions |
| */ |
| public void setFilterNames (String [] names) { |
| filterNames = names; |
| } |
| |
| /** |
| * Sets the directory path that the dialog will use |
| * to the argument, which may be null. File names in this |
| * path will appear in the dialog, filtered according |
| * to the filter extensions. If the string is null, |
| * then the operating system's default filter path |
| * will be used. |
| * <p> |
| * Note that the path string is platform dependent. |
| * For convenience, either '/' or '\' can be used |
| * as a path separator. |
| * </p> |
| * |
| * @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; |
| } |
| } |