Browse Source

Added JavaDoc comments and some formatting of code.

pull/11/head
Eric Kok 11 years ago
parent
commit
648901ceaa
  1. 6
      core/src/org/transdroid/core/gui/DetailsActivity.java
  2. 8
      core/src/org/transdroid/core/gui/DetailsFragment.java
  3. 6
      core/src/org/transdroid/core/gui/SearchHistoryProvider.java
  4. 12
      core/src/org/transdroid/core/gui/TorrentsActivity.java
  5. 6
      core/src/org/transdroid/core/gui/TorrentsFragment.java

6
core/src/org/transdroid/core/gui/DetailsActivity.java

@ -52,6 +52,12 @@ import com.actionbarsherlock.app.SherlockFragmentActivity;
import de.keyboardsurfer.android.widget.crouton.Crouton; import de.keyboardsurfer.android.widget.crouton.Crouton;
/**
* An activity that holds a single torrents details fragment. It is used on devices (i.e. phones) where there is no room
* to show details in the {@link TorrentsActivity} directly. Task execution, such as loading of more details and
* updating file priorities, is performed in this activity via background methods.
* @author Eric Kok
*/
@EActivity(resName = "activity_details") @EActivity(resName = "activity_details")
@OptionsMenu(resName = "activity_details") @OptionsMenu(resName = "activity_details")
public class DetailsActivity extends SherlockFragmentActivity implements TorrentTasksExecutor { public class DetailsActivity extends SherlockFragmentActivity implements TorrentTasksExecutor {

8
core/src/org/transdroid/core/gui/DetailsFragment.java

@ -1,6 +1,7 @@
package org.transdroid.core.gui; package org.transdroid.core.gui;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections;
import java.util.List; import java.util.List;
import org.androidannotations.annotations.AfterViews; import org.androidannotations.annotations.AfterViews;
@ -35,7 +36,8 @@ import de.keyboardsurfer.android.widget.crouton.Crouton;
/** /**
* Fragment that shows detailed statistics about some torrent. These come from some already fetched {@link Torrent} * Fragment that shows detailed statistics about some torrent. These come from some already fetched {@link Torrent}
* object, but it also retrieves further detailed statistics. * object, but it also retrieves further detailed statistics. The actual execution of tasks is performed by the activity
* that contains this fragment, as per the {@link TorrentTasksExecutor} interface.
* @author Eric Kok * @author Eric Kok
*/ */
@EFragment(resName = "fragment_details") @EFragment(resName = "fragment_details")
@ -122,6 +124,7 @@ public class DetailsFragment extends SherlockFragment {
// Check if these are actually the details of the torrent we are now showing // Check if these are actually the details of the torrent we are now showing
if (!torrent.getUniqueID().equals(checkTorrent.getUniqueID())) if (!torrent.getUniqueID().equals(checkTorrent.getUniqueID()))
return; return;
Collections.sort(newTorrentFiles);
this.torrentFiles = newTorrentFiles; this.torrentFiles = newTorrentFiles;
((DetailsAdapter) detailsList.getAdapter()).updateTorrentFiles(newTorrentFiles); ((DetailsAdapter) detailsList.getAdapter()).updateTorrentFiles(newTorrentFiles);
} }
@ -297,7 +300,8 @@ public class DetailsFragment extends SherlockFragment {
&& detailsList.getAdapter().getItem(detailsList.getCheckedItemPositions().keyAt(i)) instanceof TorrentFile) && detailsList.getAdapter().getItem(detailsList.getCheckedItemPositions().keyAt(i)) instanceof TorrentFile)
checkedCount++; checkedCount++;
} }
mode.setTitle(getResources().getQuantityString(R.plurals.navigation_filesselected, checkedCount, checkedCount)); mode.setTitle(getResources().getQuantityString(R.plurals.navigation_filesselected, checkedCount,
checkedCount));
} }
@Override @Override

6
core/src/org/transdroid/core/gui/SearchHistoryProvider.java

@ -5,7 +5,7 @@ import android.content.SearchRecentSuggestionsProvider;
import android.provider.SearchRecentSuggestions; import android.provider.SearchRecentSuggestions;
/** /**
* Provides search suggestions by simply returning previous user entries * Provides search suggestions by simply returning previous user entries.
* @author Eric Kok * @author Eric Kok
*/ */
public class SearchHistoryProvider extends SearchRecentSuggestionsProvider { public class SearchHistoryProvider extends SearchRecentSuggestionsProvider {
@ -19,8 +19,8 @@ public class SearchHistoryProvider extends SearchRecentSuggestionsProvider {
} }
public static void clearHistory(Context context) { public static void clearHistory(Context context) {
SearchRecentSuggestions suggestions = new SearchRecentSuggestions(context, SearchRecentSuggestions suggestions = new SearchRecentSuggestions(context, SearchHistoryProvider.AUTHORITY,
SearchHistoryProvider.AUTHORITY, SearchHistoryProvider.MODE); SearchHistoryProvider.MODE);
suggestions.clearHistory(); suggestions.clearHistory();
} }
} }

12
core/src/org/transdroid/core/gui/TorrentsActivity.java

@ -83,6 +83,13 @@ import com.actionbarsherlock.widget.SearchView;
import de.keyboardsurfer.android.widget.crouton.Crouton; import de.keyboardsurfer.android.widget.crouton.Crouton;
/**
* Main activity that holds the fragment that shows the torrents list, presents a way to filter the list (via an action
* bar spinner or list side list) and potentially shows a torrent details fragment too, if there is room. Task execution
* such as loading of and adding torrents is performs in this activity, using background methods. Finally, the activity
* offers navigation elements such as access to settings and showing connection issues.
* @author Eric Kok
*/
@EActivity(resName = "activity_torrents") @EActivity(resName = "activity_torrents")
@OptionsMenu(resName = "activity_torrents") @OptionsMenu(resName = "activity_torrents")
public class TorrentsActivity extends SherlockFragmentActivity implements OnNavigationListener, TorrentTasksExecutor { public class TorrentsActivity extends SherlockFragmentActivity implements OnNavigationListener, TorrentTasksExecutor {
@ -700,8 +707,9 @@ public class TorrentsActivity extends SherlockFragmentActivity implements OnNavi
public void removeTorrent(Torrent torrent, boolean withData) { public void removeTorrent(Torrent torrent, boolean withData) {
DaemonTaskResult result = RemoveTask.create(currentConnection, torrent, withData).execute(); DaemonTaskResult result = RemoveTask.create(currentConnection, torrent, withData).execute();
if (result instanceof DaemonTaskResult) { if (result instanceof DaemonTaskResult) {
onTaskSucceeded((DaemonTaskSuccessResult) result, getString(withData ? R.string.result_removed_with_data onTaskSucceeded(
: R.string.result_removed, torrent.getName())); (DaemonTaskSuccessResult) result,
getString(withData ? R.string.result_removed_with_data : R.string.result_removed, torrent.getName()));
} else { } else {
onCommunicationError((DaemonTaskFailureResult) result, false); onCommunicationError((DaemonTaskFailureResult) result, false);
} }

6
core/src/org/transdroid/core/gui/TorrentsFragment.java

@ -33,6 +33,12 @@ import com.actionbarsherlock.view.MenuItem;
import com.actionbarsherlock.view.SherlockListView; import com.actionbarsherlock.view.SherlockListView;
import com.actionbarsherlock.view.SherlockListView.MultiChoiceModeListenerCompat; import com.actionbarsherlock.view.SherlockListView.MultiChoiceModeListenerCompat;
/**
* Fragment that shows a list of torrents that are active on the server. It supports sorting and filtering and can show
* connection progress and issues. However, actual task starting and execution and overall navigation elements are part
* of the containing activity, not this fragment.
* @author Eric Kok
*/
@EFragment(resName = "fragment_torrents") @EFragment(resName = "fragment_torrents")
public class TorrentsFragment extends SherlockFragment { public class TorrentsFragment extends SherlockFragment {

Loading…
Cancel
Save