mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-14 20:45:22 +02:00
Code Issues Wiki Activity

[225506] Add Javadoc for FileDialogFactory

Browse source
This commit is contained in:
Martin Oberhuber 2008-04-10 09:35:34 +00:00
parent ff87b36fd4
commit b20818249f
1 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/dialogs/FileDialogFactory.java
View file

@ -1,11 +1,12 @@
/********************************************************************************* /*********************************************************************************
* Copyright (c) 2008 IBM Corporation. All rights reserved. * Copyright (c) 2008 IBM Corporation. All rights reserved.
* This program and the accompanying materials are made available under the terms * 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 * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* Xuan Chen (IBM) - [225506] initial contribution * Xuan Chen (IBM) - [225506] initial contribution
* Martin Oberhuber (Wind River) - [225506] Adding Javadoc
*********************************************************************************/ *********************************************************************************/
package org.eclipse.rse.files.ui.dialogs; package org.eclipse.rse.files.ui.dialogs;
@ -13,19 +14,38 @@ import org.eclipse.rse.internal.files.ui.dialogs.SaveAsDialog;
import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Shell;
/** /**
* @author xuanchen * Utility class with factory methods for creating some RSE Standard Dialogs,
* for working with remote files.
* *
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
* @since org.eclipse.rse.files.ui 3.0
*/ */
public class FileDialogFactory { public class FileDialogFactory {
/**
* Create an ISaveAsDialog instance with the given title, initialized for
* selecting a file to save to.
*
* @param shell parent shell for the dialog
* @param title title for the dialog
* @return New ISaveAsDialog instance
*/
public static ISaveAsDialog makeSaveAsDialog(Shell shell, String title) public static ISaveAsDialog makeSaveAsDialog(Shell shell, String title)
{ {
return new SaveAsDialog(shell, title); return new SaveAsDialog(shell, title);
} }
/**
* Create an ISaveAsDialog instance, initialized for selecting a folder to
* save to. The dialog title will be a standard title ("Browse for Folder").
*
* @param shell parent shell for the dialog
* @return new ISaveAsDialog instance
*/
public static ISaveAsDialog makeSaveAsDialog(Shell shell) public static ISaveAsDialog makeSaveAsDialog(Shell shell)
{ {
return new SaveAsDialog(shell); return new SaveAsDialog(shell);
} }
} }