src/com/owncloud/android/ui/fragment/LocalFileListFragment.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2011  Bartek Przybylski
   3  *   Copyright (C) 2012-2013 ownCloud Inc.
   4  *
   5  *   This program is free software: you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License version 2,
   7  *   as published by the Free Software Foundation.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18 package com.owncloud.android.ui.fragment;
  19
  20 import java.io.File;
  21 import java.util.ArrayList;
  22
  23 import android.app.Activity;
  24 import android.os.Bundle;
  25 import android.os.Environment;
  26 import android.util.SparseBooleanArray;
  27 import android.view.LayoutInflater;
  28 import android.view.View;
  29 import android.view.ViewGroup;
  30 import android.widget.AdapterView;
  31 import android.widget.ImageView;
  32 import android.widget.ListView;
  33
  34 import com.owncloud.android.R;
  35 import com.owncloud.android.lib.common.utils.Log_OC;
  36 import com.owncloud.android.ui.adapter.LocalFileListAdapter;
  37
  38
  39 /**
  40  * A Fragment that lists all files and folders in a given LOCAL path.
  41  *
  42  * @author David A. Velasco
  43  *
  44  */
  45 public class LocalFileListFragment extends ExtendedListFragment {
  46     private static final String TAG = "LocalFileListFragment";
  47
  48     /** Reference to the Activity which this fragment is attached to. For callbacks */
  49     private LocalFileListFragment.ContainerActivity mContainerActivity;
  50
  51     /** Directory to show */
  52     private File mDirectory = null;
  53
  54     /** Adapter to connect the data from the directory with the View object */
  55     private LocalFileListAdapter mAdapter = null;
  56
  57
  58     /**
  59      * {@inheritDoc}
  60      */
  61     @Override
  62     public void onAttach(Activity activity) {
  63         super.onAttach(activity);
  64         try {
  65             mContainerActivity = (ContainerActivity) activity;
  66         } catch (ClassCastException e) {
  67             throw new ClassCastException(activity.toString() + " must implement " + LocalFileListFragment.ContainerActivity.class.getSimpleName());
  68         }
  69     }
  70
  71
  72     /**
  73      * {@inheritDoc}
  74      */
  75     @Override
  76     public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
  77         Log_OC.i(TAG, "onCreateView() start");
  78         View v = super.onCreateView(inflater, container, savedInstanceState);
  79         getListView().setChoiceMode(ListView.CHOICE_MODE_MULTIPLE);
  80         disableSwipe(); // Disable pull refresh
  81         setMessageForEmptyList(getString(R.string.local_file_list_empty));
  82         Log_OC.i(TAG, "onCreateView() end");
  83         return v;
  84     }
  85
  86
  87     /**
  88      * {@inheritDoc}
  89      */
  90     @Override
  91     public void onActivityCreated(Bundle savedInstanceState) {
  92         Log_OC.i(TAG, "onActivityCreated() start");
  93
  94         super.onActivityCreated(savedInstanceState);
  95         mAdapter = new LocalFileListAdapter(mContainerActivity.getInitialDirectory(), getActivity());
  96         setListAdapter(mAdapter);
  97
  98         Log_OC.i(TAG, "onActivityCreated() stop");
  99     }
 100
 101     public void selectAll(){
 102         int numberOfFiles = mAdapter.getCount();
 103         for(int i = 0; i < numberOfFiles; i++){
 104             File file = (File) mAdapter.getItem(i);
 105             if (file != null) {
 106                 if (!file.isDirectory()) {
 107                     /// Click on a file
 108                     getListView().setItemChecked(i, true);
 109                     // notify the change to the container Activity
 110                     mContainerActivity.onFileClick(file);
 111                 }
 112             }
 113         }
 114     }
 115
 116     public void deselectAll(){
 117         mAdapter = new LocalFileListAdapter(mContainerActivity.getInitialDirectory(), getActivity());
 118         setListAdapter(mAdapter);
 119     }
 120
 121     /**
 122      * Checks the file clicked over. Browses inside if it is a directory. Notifies the container activity in any case.
 123      */
 124     @Override
 125     public void onItemClick(AdapterView<?> l, View v, int position, long id) {
 126         File file = (File) mAdapter.getItem(position);
 127
 128         if (file != null) {
 129             /// Click on a directory
 130             if (file.isDirectory()) {
 131                 // just local updates
 132                 listDirectory(file);
 133                 // notify the click to container Activity
 134                 mContainerActivity.onDirectoryClick(file);
 135                 // save index and top position
 136                 saveIndexAndTopPosition(position);
 137
 138             } else {    /// Click on a file
 139                 ImageView checkBoxV = (ImageView) v.findViewById(R.id.custom_checkbox);
 140                 if (checkBoxV != null) {
 141                     if (getListView().isItemChecked(position)) {
 142                         checkBoxV.setImageResource(android.R.drawable.checkbox_on_background);
 143                     } else {
 144                         checkBoxV.setImageResource(android.R.drawable.checkbox_off_background);
 145                     }
 146                 }
 147                 // notify the change to the container Activity
 148                 mContainerActivity.onFileClick(file);
 149             }
 150
 151         } else {
 152             Log_OC.w(TAG, "Null object in ListAdapter!!");
 153         }
 154     }
 155
 156
 157     /**
 158      * Call this, when the user presses the up button
 159      */
 160     public void onNavigateUp() {
 161         File parentDir = null;
 162         if(mDirectory != null) {
 163             parentDir = mDirectory.getParentFile();  // can be null
 164         }
 165         listDirectory(parentDir);
 166
 167         // restore index and top position
 168         restoreIndexAndTopPosition();
 169     }
 170
 171
 172     /**
 173      * Use this to query the {@link File} object for the directory
 174      * that is currently being displayed by this fragment
 175      *
 176      * @return File     The currently displayed directory
 177      */
 178     public File getCurrentDirectory(){
 179         return mDirectory;
 180     }
 181
 182
 183     /**
 184      * Calls {@link LocalFileListFragment#listDirectory(File)} with a null parameter
 185      * to refresh the current directory.
 186      */
 187     public void listDirectory(){
 188         listDirectory(null);
 189     }
 190
 191
 192     /**
 193      * Lists the given directory on the view. When the input parameter is null,
 194      * it will either refresh the last known directory. list the root
 195      * if there never was a directory.
 196      *
 197      * @param directory     Directory to be listed
 198      */
 199     public void listDirectory(File directory) {
 200
 201         // Check input parameters for null
 202         if(directory == null) {
 203             if(mDirectory != null){
 204                 directory = mDirectory;
 205             } else {
 206                 directory = Environment.getExternalStorageDirectory();  // TODO be careful with the state of the storage; could not be available
 207                 if (directory == null) return; // no files to show
 208             }
 209         }
 210
 211
 212         // if that's not a directory -> List its parent
 213         if(!directory.isDirectory()){
 214             Log_OC.w(TAG, "You see, that is not a directory -> " + directory.toString());
 215             directory = directory.getParentFile();
 216         }
 217
 218         mList.clearChoices();   // by now, only files in the same directory will be kept as selected
 219         mAdapter.swapDirectory(directory);
 220         if (mDirectory == null || !mDirectory.equals(directory)) {
 221             mList.setSelectionFromTop(0, 0);
 222         }
 223         mDirectory = directory;
 224     }
 225
 226
 227     /**
 228      * Returns the fule paths to the files checked by the user
 229      *
 230      * @return      File paths to the files checked by the user.
 231      */
 232     public String[] getCheckedFilePaths() {
 233         ArrayList<String> result = new ArrayList<String>();
 234         SparseBooleanArray positions = mList.getCheckedItemPositions();
 235         if (positions.size() > 0) {
 236             for (int i = 0; i < positions.size(); i++) {
 237                 if (positions.get(positions.keyAt(i)) == true) {
 238                     result.add(((File) mList.getItemAtPosition(positions.keyAt(i))).getAbsolutePath());
 239                 }
 240             }
 241
 242             Log_OC.d(TAG, "Returning " + result.size() + " selected files");
 243         }
 244         return result.toArray(new String[result.size()]);
 245     }
 246
 247
 248     /**
 249      * Interface to implement by any Activity that includes some instance of LocalFileListFragment
 250      *
 251      * @author David A. Velasco
 252      */
 253     public interface ContainerActivity {
 254
 255         /**
 256          * Callback method invoked when a directory is clicked by the user on the files list
 257          *
 258          * @param file
 259          */
 260         public void onDirectoryClick(File directory);
 261
 262         /**
 263          * Callback method invoked when a file (non directory) is clicked by the user on the files list
 264          *
 265          * @param file
 266          */
 267         public void onFileClick(File file);
 268
 269
 270         /**
 271          * Callback method invoked when the parent activity is fully created to get the directory to list firstly.
 272          *
 273          * @return  Directory to list firstly. Can be NULL.
 274          */
 275         public File getInitialDirectory();
 276
 277     }
 278
 279
 280 }