| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Wed Jun 12 19:57:03 BST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> |
| <title>IRemoteUIFileManager (PTP API Specification)</title> |
| <meta name="date" content="2013-06-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IRemoteUIFileManager (PTP API Specification)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRemoteUIFileManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConstants.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIServices.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html" target="_top">Frames</a></li> |
| <li><a href="IRemoteUIFileManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.ptp.remote.ui</div> |
| <h2 title="Interface IRemoteUIFileManager" class="title">Interface IRemoteUIFileManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">IRemoteUIFileManager</span></pre> |
| <div class="block">Interface for providing file management operations in the UI. Clients can call these methods to open generic dialogs for |
| operations on remote resources.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#browseDirectory(Shell, java.lang.String, java.lang.String, int)">browseDirectory</a></strong>(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</code> |
| <div class="block">Browse for a remote directory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#browseFile(Shell, java.lang.String, java.lang.String, int)">browseFile</a></strong>(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</code> |
| <div class="block">Browse for a remote file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#browseFiles(Shell, java.lang.String, java.lang.String, int)">browseFiles</a></strong>(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</code> |
| <div class="block">Browse for a set of remote files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#getConnection()">getConnection</a></strong>()</code> |
| <div class="block">Get the last connection that was selected in the browser.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#setConnection(org.eclipse.ptp.remote.core.IRemoteConnection)">setConnection</a></strong>(<a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</code> |
| <div class="block">Set the connection to use for file browsing</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html#showConnections(boolean)">showConnections</a></strong>(boolean enable)</code> |
| <div class="block">Show a list of available connections if possible.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="browseDirectory(Shell, java.lang.String, java.lang.String, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>browseDirectory</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> browseDirectory(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</pre> |
| <div class="block">Browse for a remote directory. The return value is the path of the |
| directory <i>on the remote system</i>. |
| |
| Equivalent to <code>org.eclipse.swt.widgets.DirectoryDialog</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - workbench shell</dd><dd><code>message</code> - message to display in dialog</dd><dd><code>initialPath</code> - initial path to use when displaying files</dd><dd><code>flags</code> - option settings for dialog (not currently used) |
| valid values are NONE (@see IRemoteUIConstants)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the path to the directory relative to the remote system or null |
| if the browser was cancelled</dd></dl> |
| </li> |
| </ul> |
| <a name="browseFile(Shell, java.lang.String, java.lang.String, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>browseFile</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> browseFile(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</pre> |
| <div class="block">Browse for a remote file. The return value is the path of the file <i>on |
| the remote system</i>. |
| |
| Equivalent to <code>org.eclipse.swt.widgets.FileDialog</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - workbench shell</dd><dd><code>message</code> - message to display in dialog</dd><dd><code>initialPath</code> - initial path to use when displaying files</dd><dd><code>flags</code> - options settings for dialog |
| valid values are NONE, SAVE, or OPEN (@see IRemoteUIConstants)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the path to the file relative to the remote system or null if the |
| browser was cancelled</dd></dl> |
| </li> |
| </ul> |
| <a name="browseFiles(Shell, java.lang.String, java.lang.String, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>browseFiles</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] browseFiles(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> initialPath, |
| int flags)</pre> |
| <div class="block">Browse for a set of remote files. The return value is an array of paths |
| of the files <i>on the remote system</i>. |
| |
| Equivalent to <code>org.eclipse.swt.widgets.FileDialog</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - workbench shell</dd><dd><code>message</code> - message to display in dialog</dd><dd><code>initialPath</code> - initial path to use when displaying files</dd><dd><code>flags</code> - options settings for dialog (@see IRemoteUIConstants) |
| valid values are NONE, SAVE, or OPEN (@see IRemoteUIConstants)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the path to the file relative to the remote system or null if the |
| browser was cancelled</dd></dl> |
| </li> |
| </ul> |
| <a name="getConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> getConnection()</pre> |
| <div class="block">Get the last connection that was selected in the browser.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>selected connection</dd></dl> |
| </li> |
| </ul> |
| <a name="setConnection(org.eclipse.ptp.remote.core.IRemoteConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnection</h4> |
| <pre>void setConnection(<a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</pre> |
| <div class="block">Set the connection to use for file browsing</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>connection</code> - connection to use for file browsing</dd></dl> |
| </li> |
| </ul> |
| <a name="showConnections(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>showConnections</h4> |
| <pre>void showConnections(boolean enable)</pre> |
| <div class="block">Show a list of available connections if possible.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - enable connection list</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRemoteUIFileManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConstants.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIServices.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/ptp/remote/ui/IRemoteUIFileManager.html" target="_top">Frames</a></li> |
| <li><a href="IRemoteUIFileManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p> |
| </body> |
| </html> |
