You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by rw...@apache.org on 2016/05/02 23:52:31 UTC
svn commit: r1742040 - in /pivot/trunk/wtk/src/org/apache/pivot/wtk:
TextArea.java TextPane.java TreeView.java VFSBrowser.java
VFSBrowserSheet.java
Author: rwhitcomb
Date: Mon May 2 21:52:31 2016
New Revision: 1742040
URL: http://svn.apache.org/viewvc?rev=1742040&view=rev
Log:
PIVOT-976: More Javadoc fixes for the warnings from Java 8.
Continuing on down the list, now the last (except for DropTarget.java) of
the "wtk" files. Almost all of the changes were missing descriptions for
@param tags.
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java?rev=1742040&r1=1742039&r2=1742040&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java Mon May 2 21:52:31 2016
@@ -210,7 +210,8 @@ public class TextArea extends Component
* Enum representing a scroll direction.
*/
public enum ScrollDirection {
- UP, DOWN
+ UP,
+ DOWN
}
/**
@@ -218,7 +219,7 @@ public class TextArea extends Component
*/
public interface Skin {
/**
- * Returns the insertion point for a given location.
+ * @return The insertion point for a given location.
*
* @param x The X-location to check (likely from the mouse location).
* @param y The Y-location to check.
@@ -622,8 +623,8 @@ public class TextArea extends Component
/**
* Returns a portion of the text content of the text area.
*
- * @param beginIndex
- * @param endIndex
+ * @param beginIndex The beginning location (inclusive) to obtain text from.
+ * @param endIndex The ending location (exclusive) of the text segment to fetch.
* @return A string containing a copy of the text area's text content.
*/
public String getText(int beginIndex, int endIndex) {
@@ -668,7 +669,7 @@ public class TextArea extends Component
/**
* Sets the text content of the text area.
*
- * @param text
+ * @param text The new text for the control (cannot be {@code null}).
*/
public void setText(String text) {
if (text == null) {
@@ -868,16 +869,16 @@ public class TextArea extends Component
}
/**
- * Returns the text area's paragraph sequence.
+ * @return The text area's paragraph sequence.
*/
public ParagraphSequence getParagraphs() {
return paragraphSequence;
}
/**
- * Returns the index of the paragraph containing a given character index.
+ * @return The index of the paragraph containing a given character index.
*
- * @param index
+ * @param index The character index to check.
*/
public int getParagraphAt(int index) {
indexBoundsCheck("index", index, 0, characterCount);
@@ -893,9 +894,9 @@ public class TextArea extends Component
}
/**
- * Returns the character at a given index.
+ * @return The character at a given index.
*
- * @param index
+ * @param index The index of the character to fetch.
*/
public char getCharacterAt(int index) {
indexBoundsCheck("index", index, 0, characterCount - 1);
@@ -910,7 +911,7 @@ public class TextArea extends Component
}
/**
- * Returns the number of characters in the text area, including line break
+ * @return The number of characters in the text area, including line break
* characters.
*/
public int getCharacterCount() {
@@ -983,8 +984,6 @@ public class TextArea extends Component
}
/**
- * Returns the starting index of the selection.
- *
* @return The starting index of the selection.
*/
public int getSelectionStart() {
@@ -992,8 +991,6 @@ public class TextArea extends Component
}
/**
- * Returns the length of the selection.
- *
* @return The length of the selection; may be <tt>0</tt>.
*/
public int getSelectionLength() {
@@ -1042,7 +1039,7 @@ public class TextArea extends Component
/**
* Sets the selection.
*
- * @param selection
+ * @param selection The new span of text to select.
* @see #setSelection(int, int)
*/
public final void setSelection(Span selection) {
@@ -1077,8 +1074,6 @@ public class TextArea extends Component
}
/**
- * Returns the maximum length of the text area's text content.
- *
* @return The maximum length of the text area's text content.
*/
public int getMaximumLength() {
@@ -1111,7 +1106,7 @@ public class TextArea extends Component
}
/**
- * Returns the text area's editable flag.
+ * @return The text area's editable flag.
*/
public boolean isEditable() {
return editable;
@@ -1120,7 +1115,7 @@ public class TextArea extends Component
/**
* Sets the text area's editable flag.
*
- * @param editable
+ * @param editable Whether or not the text should now be editable.
*/
public void setEditable(boolean editable) {
if (this.editable != editable) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java?rev=1742040&r1=1742039&r2=1742040&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java Mon May 2 21:52:31 2016
@@ -62,8 +62,8 @@ public class TextPane extends Container
/**
* Returns the insertion point for a given location.
*
- * @param x
- * @param y
+ * @param x The X-coordinate of the location to check.
+ * @param y The Y-coordinate of the location.
* @return The insertion point for the given location.
*/
public int getInsertionPoint(int x, int y);
@@ -72,9 +72,9 @@ public class TextPane extends Container
* Returns the next insertion point given an x coordinate and a
* character offset.
*
- * @param x
- * @param from
- * @param direction
+ * @param x The current X-coordinate to move from.
+ * @param from The current character offset to move from.
+ * @param direction The direction to move from the current location.
* @return The next insertion point.
*/
public int getNextInsertionPoint(int x, int from, ScrollDirection direction);
@@ -83,15 +83,13 @@ public class TextPane extends Container
* Returns the row index of the character at a given offset within the
* document.
*
- * @param offset
+ * @param offset The character offset to check.
* @return The row index of the character at the given offset.
*/
public int getRowAt(int offset);
/**
- * Returns the total number of rows in the document.
- *
- * @return The number of rows in the document.
+ * @return The total number of rows in the document.
*/
public int getRowCount();
@@ -99,13 +97,13 @@ public class TextPane extends Container
* Returns the bounds of the character at a given offset within the
* document.
*
- * @param offset
+ * @param offset The index of the character we want the bounds for.
* @return The bounds of the character at the given offset.
*/
public Bounds getCharacterBounds(int offset);
/**
- * Returns the current setting of the "tabWidth" style (so "setText"
+ * @return The current setting of the "tabWidth" style (so "setText"
* uses the same value as Ctrl-Tab from user).
*/
public int getTabWidth();
@@ -338,7 +336,7 @@ public class TextPane extends Container
}
/**
- * Returns the document that backs the text pane.
+ * @return The document that backs the text pane.
*/
public Document getDocument() {
return document;
@@ -349,7 +347,7 @@ public class TextPane extends Container
* across multiple TextPanes; because a Document may contain Components, and
* a Component may only be in one Container at a time.
*
- * @param document
+ * @param document The new document to be displayed by this text pane.
*/
public void setDocument(Document document) {
Document previousDocument = this.document;
@@ -414,6 +412,11 @@ public class TextPane extends Container
/**
* Helper function to remove a range of characters from the document and
* notify the listeners just once (instead of once per node).
+ *
+ * @param start The starting location (document offset) of the characters
+ * to be removed.
+ * @param count The number of characters to remove from that location.
+ * @return The document node where the characters were removed.
*/
private Node removeDocumentRange(int start, int count) {
bulkOperation = true;
@@ -777,6 +780,7 @@ public class TextPane extends Container
/**
* Add the text from the given element (and its children) to the given buffer,
* respecting the range of characters to be included.
+ *
* @param text The buffer we're building.
* @param element The current element in the document.
* @param includeSpan The range of text to be included (in document-relative
@@ -817,6 +821,7 @@ public class TextPane extends Container
* Convenience method to get all the text from the current document into a
* single string.
*
+ * @return The complete text of the document as a string.
* @see #setText
*/
public String getText() {
@@ -863,7 +868,7 @@ public class TextPane extends Container
* Convenience method to create a text-only document consisting of one
* paragraph per line of the given text.
*
- * @param text
+ * @param text The new complete text for the document.
*/
public void setText(String text) {
if (text == null) {
@@ -932,8 +937,6 @@ public class TextPane extends Container
}
/**
- * Returns the starting index of the selection.
- *
* @return The starting index of the selection.
*/
public int getSelectionStart() {
@@ -941,8 +944,6 @@ public class TextPane extends Container
}
/**
- * Returns the length of the selection.
- *
* @return The length of the selection; may be <tt>0</tt>.
*/
public int getSelectionLength() {
@@ -1000,7 +1001,7 @@ public class TextPane extends Container
/**
* Sets the selection.
*
- * @param selection
+ * @param selection The new span describing the selection.
* @see #setSelection(int, int)
*/
public final void setSelection(Span selection) {
@@ -1055,7 +1056,7 @@ public class TextPane extends Container
}
/**
- * Returns the text pane's editable flag.
+ * @return The text pane's editable flag.
*/
public boolean isEditable() {
return editable;
@@ -1064,7 +1065,7 @@ public class TextPane extends Container
/**
* Sets the text pane's editable flag.
*
- * @param editable
+ * @param editable Whether or not the text should be editable now.
*/
public void setEditable(boolean editable) {
if (this.editable != editable) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java?rev=1742040&r1=1742039&r2=1742040&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java Mon May 2 21:52:31 2016
@@ -122,7 +122,7 @@ public class TreeView extends Component
/**
* Converts a tree node to a string representation.
*
- * @param node
+ * @param node The actual tree node data object.
* @return The node's string representation, or <tt>null</tt> if the node
* does not have a string representation. <p> Note that this method may
* be called often during keyboard navigation, so implementations should
@@ -138,8 +138,8 @@ public class TreeView extends Component
/**
* Called to begin editing a tree node.
*
- * @param treeView
- * @param path
+ * @param treeView The source of this event.
+ * @param path The path to the node being edited.
*/
public void beginEdit(TreeView treeView, Path path);
@@ -152,7 +152,7 @@ public class TreeView extends Component
public void endEdit(boolean result);
/**
- * Tests whether an edit is currently in progress.
+ * @return Whether an edit is currently in progress.
*/
public boolean isEditing();
}
@@ -438,6 +438,9 @@ public class TreeView extends Component
/**
* Creates a new <tt>BranchHandler</tt> tied to the specified parent and
* listening to events from the specified branch data.
+ *
+ * @param parent The branch handler for our parent node.
+ * @param branchData The nodes for this branch that must be handled.
*/
@SuppressWarnings("unchecked")
public BranchHandler(BranchHandler parent, List<?> branchData) {
@@ -455,7 +458,7 @@ public class TreeView extends Component
}
/**
- * Gets the branch data that this handler is monitoring.
+ * @return The branch data that this handler is monitoring.
*/
public List<?> getBranchData() {
return branchData;
@@ -484,7 +487,7 @@ public class TreeView extends Component
}
/**
- * Gets the path that leads from the root of the tree data to this
+ * @return The path that leads from the root of the tree data to this
* branch. Note: <tt>rootBranchHandler.getPath()</tt> will return an
* empty sequence.
*/
@@ -669,6 +672,7 @@ public class TreeView extends Component
* "row order".
* @param basePath The path to the parent of the inserted item.
* @param index The index of the inserted item within its parent.
+ * @return The number of path elements that were updated.
*/
private int incrementPaths(ArrayList<Path> paths, Path basePath, int index) {
// Calculate the child's path
@@ -722,6 +726,7 @@ public class TreeView extends Component
* @param basePath The path to the parent of the removed items.
* @param index The index of the first removed item within the base.
* @param count The number of items removed.
+ * @return The number of path elements that were updated.
*/
private int clearAndDecrementPaths(ArrayList<Path> paths, Path basePath, int index,
int count) {
@@ -814,6 +819,7 @@ public class TreeView extends Component
* @param paths Sequence of paths guaranteed to be sorted by
* "row order".
* @param basePath The path whose children were sorted.
+ * @return The number of path elements that were updated.
*/
private int clearPaths(ArrayList<Path> paths, Path basePath) {
// Find first descendant in paths list, if it exists
@@ -1086,6 +1092,10 @@ public class TreeView extends Component
}
/**
+ * Set the new selected nodes in the tree.
+ *
+ * @param selectedPaths The new set of paths to the selected nodes.
+ * @return The new set of selected paths (with duplicates eliminated).
* @throws IllegalStateException If selection has been disabled (select mode
* <tt>NONE</tt>).
*/
@@ -1162,6 +1172,9 @@ public class TreeView extends Component
}
/**
+ * Set the single selected path.
+ *
+ * @param path The new path to select.
*/
public void setSelectedPath(Path path) {
if (path == null) {
@@ -1195,7 +1208,7 @@ public class TreeView extends Component
/**
* Adds a path to the selection.
*
- * @param path
+ * @param path The path to the node to be added to the selection.
* @return <tt>true</tt> if the path was added to the selection;
* <tt>false</tt>, otherwise.
* @throws IllegalStateException If multi-select is not enabled.
@@ -1232,8 +1245,8 @@ public class TreeView extends Component
/**
* Removes a path from the selection.
*
- * @param path
- * @return <tt>true</tt> if the path was added to the selection;
+ * @param path Path to the node to be removed from the selection.
+ * @return <tt>true</tt> if the path was removed from the selection;
* <tt>false</tt>, otherwise.
* @throws IllegalStateException If multi-select is not enabled.
*/
@@ -1302,6 +1315,9 @@ public class TreeView extends Component
}
/**
+ * @return Whether or not the node at the given path is part of the
+ * current selection.
+ * @param path Path to the node to check.
*/
public boolean isNodeSelected(Path path) {
if (path == null) {
@@ -1367,6 +1383,7 @@ public class TreeView extends Component
}
/**
+ * @return Whether or not the checkmarks on each node are enabled.
*/
public boolean getCheckmarksEnabled() {
return checkmarksEnabled;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java?rev=1742040&r1=1742039&r2=1742040&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowser.java Mon May 2 21:52:31 2016
@@ -122,6 +122,8 @@ public class VFSBrowser extends Containe
/**
* Creates a new VFSBrowser <p> Note that this version sets, by default,
* the mode to open.
+ *
+ * @throws FileSystemException if there are problems.
*/
public VFSBrowser() throws FileSystemException {
this(null, USER_HOME, null);
@@ -135,6 +137,7 @@ public class VFSBrowser extends Containe
* @param manager The virtual file system we're going to manage.
* @param rootFolder The root folder full name.
* @param homeFolder The default home folder full name.
+ * @throws FileSystemException if there are problems.
*/
public VFSBrowser(FileSystemManager manager, URI rootFolder, URI homeFolder) throws FileSystemException {
this(manager,
@@ -149,6 +152,7 @@ public class VFSBrowser extends Containe
* @param manager The virtual file system we're going to manage.
* @param rootFolder The root folder full name.
* @param homeFolder The home folder full name.
+ * @throws FileSystemException if there are problems.
*/
public VFSBrowser(FileSystemManager manager, String rootFolder, String homeFolder) throws FileSystemException {
if (rootFolder == null) {
@@ -166,8 +170,6 @@ public class VFSBrowser extends Containe
}
/**
- * Returns the current file system manager.
- *
* @return The current file system manager.
*/
public FileSystemManager getManager() {
@@ -193,8 +195,6 @@ public class VFSBrowser extends Containe
}
/**
- * Returns the current root directory.
- *
* @return The current root directory.
*/
public FileObject getRootDirectory() {
@@ -205,7 +205,8 @@ public class VFSBrowser extends Containe
* Sets the root directory from a string. Clears any existing file
* selection.
*
- * @param rootDirectory
+ * @param rootDirectory The new root directory string for this browser.
+ * @throws FileSystemException if there are any problems.
*/
public void setRootDirectory(String rootDirectory) throws FileSystemException {
setRootDirectory(manager.resolveFile(rootDirectory));
@@ -214,7 +215,8 @@ public class VFSBrowser extends Containe
/**
* Sets the root directory. Clears any existing file selection.
*
- * @param rootDirectory
+ * @param rootDirectory The new root directory for this browser.
+ * @throws FileSystemException if there are any problems.
*/
public void setRootDirectory(FileObject rootDirectory) throws FileSystemException {
if (rootDirectory == null) {
@@ -244,7 +246,7 @@ public class VFSBrowser extends Containe
}
/**
- * Returns the current home directory.
+ * @return The current home directory.
*/
public FileObject getHomeDirectory() {
return homeDirectory;
@@ -253,7 +255,8 @@ public class VFSBrowser extends Containe
/**
* Sets the home directory from a string.
*
- * @param homeDirectory
+ * @param homeDirectory The new home directory string for this browser.
+ * @throws FileSystemException if there are any problems.
*/
public void setHomeDirectory(String homeDirectory) throws FileSystemException {
setHomeDirectory(manager.resolveFile(homeDirectory));
@@ -262,7 +265,8 @@ public class VFSBrowser extends Containe
/**
* Sets the home directory.
*
- * @param homeDirectory
+ * @param homeDirectory The new home directory for this browser.
+ * @throws FileSystemException if there are any problems.
*/
public void setHomeDirectory(FileObject homeDirectory) throws FileSystemException {
if (homeDirectory == null) {
@@ -293,9 +297,10 @@ public class VFSBrowser extends Containe
/**
* Adds a file to the file selection.
*
- * @param file
+ * @param file The new file to be selected.
* @return <tt>true</tt> if the file was added; <tt>false</tt> if it was
* already selected.
+ * @throws FileSystemException if there are any problems.
*/
public boolean addSelectedFile(FileObject file) throws FileSystemException {
if (file == null) {
@@ -323,7 +328,7 @@ public class VFSBrowser extends Containe
/**
* Removes a file from the file selection.
*
- * @param file
+ * @param file The file to be unselected.
* @return <tt>true</tt> if the file was removed; <tt>false</tt> if it was
* not already selected.
*/
@@ -356,7 +361,8 @@ public class VFSBrowser extends Containe
/**
* Sets the selection to a single file.
*
- * @param file
+ * @param file The new single file selection (or {@code null} to clear the selection).
+ * @throws FileSystemException if there are any problems.
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
if (file == null) {
@@ -389,6 +395,7 @@ public class VFSBrowser extends Containe
*
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
+ * @throws FileSystemException if there are any problems.
*/
public Sequence<FileObject> setSelectedFiles(Sequence<FileObject> selectedFiles)
throws FileSystemException {
@@ -435,6 +442,8 @@ public class VFSBrowser extends Containe
/**
* Clears the selection.
+ *
+ * @throws FileSystemException if there are any problems.
*/
public void clearSelection() throws FileSystemException {
setSelectedFiles(new ArrayList<FileObject>());
@@ -445,7 +454,7 @@ public class VFSBrowser extends Containe
}
/**
- * Returns the file browser's multi-select state.
+ * @return The file browser's multi-select state.
*/
public boolean isMultiSelect() {
return multiSelect;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java?rev=1742040&r1=1742039&r2=1742040&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheet.java Mon May 2 21:52:31 2016
@@ -39,7 +39,10 @@ public class VFSBrowserSheet extends She
* Enumeration defining supported modes.
*/
public enum Mode {
- OPEN, OPEN_MULTIPLE, SAVE_AS, SAVE_TO
+ OPEN,
+ OPEN_MULTIPLE,
+ SAVE_AS,
+ SAVE_TO
}
private static final String USER_HOME = System.getProperty("user.home");
@@ -107,16 +110,19 @@ public class VFSBrowserSheet extends She
/**
* Creates a new VFSBrowserSheet <p> Note that this version set by default
* mode to open and user home as root folder.
+ *
+ * @throws FileSystemException if there are any problems.
*/
public VFSBrowserSheet() throws FileSystemException {
this(Mode.OPEN);
}
/**
- * Creates a new VFSBrowserSheet <p> Note that this version set by default
- * the user home as root folder.
+ * Creates a new VFSBrowserSheet <p> Note that this version sets by default
+ * the user home as root folder, which is probably not that useful.
*
* @param mode The mode for opening the sheet.
+ * @throws FileSystemException if there are any problems.
* @see Mode
*/
public VFSBrowserSheet(Mode mode) throws FileSystemException {
@@ -128,8 +134,9 @@ public class VFSBrowserSheet extends She
* constructor must be used when a custom root folder has to be set.
*
* @param mode The mode for opening the sheet.
- * @see Mode
* @param rootFolder The root folder full name.
+ * @throws FileSystemException if there are any problems.
+ * @see Mode
*/
public VFSBrowserSheet(Mode mode, String rootFolder) throws FileSystemException {
this(null, mode, rootFolder);
@@ -142,8 +149,9 @@ public class VFSBrowserSheet extends She
* @param manager The VFS FileSystemManager that we will be browsing. If
* <tt>null</tt> the default (local) will be used.
* @param mode The mode for opening the sheet.
- * @see Mode
* @param rootFolder The root folder full name.
+ * @throws FileSystemException if there are any problems.
+ * @see Mode
*/
public VFSBrowserSheet(FileSystemManager manager, Mode mode, String rootFolder)
throws FileSystemException {
@@ -151,23 +159,17 @@ public class VFSBrowserSheet extends She
}
/**
- * Creates a new VFSBrowserSheet
- * <p>
- * Note that this version of the constructor must be used when a custom home folder has to be set.
- *
- * @param manager
- * The VFS FileSystemManager that we will be browsing. If <tt>null</tt> the default (local) will
- * be used.
+ * Creates a new VFSBrowserSheet.
+ * <p> Note that this version of the constructor must be used when a
+ * custom home folder has to be set.
*
- * @param mode
- * The mode for opening the sheet.
+ * @param manager The VFS FileSystemManager that we will be browsing.
+ * If <tt>null</tt> the default (local) will be used.
+ * @param mode The mode for opening the sheet.
+ * @param rootFolder The root folder full name.
+ * @param homeFolder The default for the "home" folder (full name).
+ * @throws FileSystemException if there are any problems.
* @see Mode
- *
- * @param rootFolder
- * The root folder full name.
- *
- * @param homeFolder
- * The default for the "home" folder (full name).
*/
public VFSBrowserSheet(FileSystemManager manager, Mode mode, String rootFolder, String homeFolder)
throws FileSystemException
@@ -193,23 +195,17 @@ public class VFSBrowserSheet extends She
}
/**
- * Creates a new VFSBrowserSheet
- * <p>
- * Note that this version of the constructor must be used when a custom home folder has to be set.
- *
- * @param manager
- * The VFS FileSystemManager that we will be browsing. If <tt>null</tt> the default (local) will
- * be used.
+ * Creates a new VFSBrowserSheet.
+ * <p> Note that this version of the constructor must be used when a
+ * custom home folder has to be set.
*
- * @param mode
- * The mode for opening the sheet.
+ * @param manager The VFS FileSystemManager that we will be browsing.
+ * If <tt>null</tt> the default (local) will be used.
+ * @param mode The mode for opening the sheet.
+ * @param rootFolder The root folder object.
+ * @param homeFolder The default for the "home" folder.
+ * @throws FileSystemException if there are any problems.
* @see Mode
- *
- * @param rootFolder
- * The root folder object.
- *
- * @param homeFolder
- * The default for the "home" folder object.
*/
public VFSBrowserSheet(FileSystemManager manager, Mode mode, FileObject rootFolder, FileObject homeFolder)
throws FileSystemException
@@ -366,7 +362,8 @@ public class VFSBrowserSheet extends She
/**
* Sets the selection to a single file.
*
- * @param file
+ * @param file The new file to be selected (or {@code null} to clear the selection).
+ * @throws FileSystemException if there are any problems.
*/
public void setSelectedFile(FileObject file) throws FileSystemException {
if (file == null) {
@@ -399,6 +396,7 @@ public class VFSBrowserSheet extends She
*
* @param selectedFiles The files to select.
* @return The files that were selected, with duplicates eliminated.
+ * @throws FileSystemException if there are any problems.
*/
public Sequence<FileObject> setSelectedFiles(Sequence<FileObject> selectedFiles)
throws FileSystemException {
@@ -445,6 +443,8 @@ public class VFSBrowserSheet extends She
/**
* Clears the selection.
+ *
+ * @throws FileSystemException if there are any problems.
*/
public void clearSelection() throws FileSystemException {
setSelectedFiles(new ArrayList<FileObject>());