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
  22 import com.owncloud.android.R;
  23 import com.owncloud.android.ui.adapter.LocalFileListAdapter;
  24 import com.owncloud.android.utils.Log_OC;
  25
  26
  27 import android.app.Activity;
  28 import android.os.Bundle;
  29 import android.os.Environment;
  30 import android.util.SparseBooleanArray;
  31 import android.view.LayoutInflater;
  32 import android.view.View;
  33 import android.view.ViewGroup;
  34 import android.widget.AdapterView;
  35 import android.widget.ImageView;
  36 import android.widget.ListView;
  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         Log_OC.i(TAG, "onCreateView() end");
  82         return v;
  83     }
  84
  85
  86     /**
  87      * {@inheritDoc}
  88      */
  89     @Override
  90     public void onActivityCreated(Bundle savedInstanceState) {
  91         Log_OC.i(TAG, "onActivityCreated() start");
  92
  93         super.onCreate(savedInstanceState);
  94         mAdapter = new LocalFileListAdapter(mContainerActivity.getInitialDirectory(), getActivity());
  95         setListAdapter(mAdapter);
  96
  97         Log_OC.i(TAG, "onActivityCreated() stop");
  98     }
  99
 100
 101     /**
 102      * Checks the file clicked over. Browses inside if it is a directory. Notifies the container activity in any case.
 103      */
 104     @Override
 105     public void onItemClick(AdapterView<?> l, View v, int position, long id) {
 106         File file = (File) mAdapter.getItem(position);
 107         if (file != null) {
 108             /// Click on a directory
 109             if (file.isDirectory()) {
 110                 // just local updates
 111                 listDirectory(file);
 112                 // notify the click to container Activity
 113                 mContainerActivity.onDirectoryClick(file);
 114
 115             } else {    /// Click on a file
 116                 ImageView checkBoxV = (ImageView) v.findViewById(R.id.custom_checkbox);
 117                 if (checkBoxV != null) {
 118                     if (getListView().isItemChecked(position)) {
 119                         checkBoxV.setImageResource(android.R.drawable.checkbox_on_background);
 120                     } else {
 121                         checkBoxV.setImageResource(android.R.drawable.checkbox_off_background);
 122                     }
 123                 }
 124                 // notify the change to the container Activity
 125                 mContainerActivity.onFileClick(file);
 126             }
 127
 128         } else {
 129             Log_OC.w(TAG, "Null object in ListAdapter!!");
 130         }
 131     }
 132
 133
 134     /**
 135      * Call this, when the user presses the up button
 136      */
 137     public void onNavigateUp() {
 138         File parentDir = null;
 139         if(mDirectory != null) {
 140             parentDir = mDirectory.getParentFile();  // can be null
 141         }
 142         listDirectory(parentDir);
 143     }
 144
 145
 146     /**
 147      * Use this to query the {@link File} object for the directory
 148      * that is currently being displayed by this fragment
 149      *
 150      * @return File     The currently displayed directory
 151      */
 152     public File getCurrentDirectory(){
 153         return mDirectory;
 154     }
 155
 156
 157     /**
 158      * Calls {@link LocalFileListFragment#listDirectory(File)} with a null parameter
 159      * to refresh the current directory.
 160      */
 161     public void listDirectory(){
 162         listDirectory(null);
 163     }
 164
 165
 166     /**
 167      * Lists the given directory on the view. When the input parameter is null,
 168      * it will either refresh the last known directory. list the root
 169      * if there never was a directory.
 170      *
 171      * @param directory     Directory to be listed
 172      */
 173     public void listDirectory(File directory) {
 174
 175         // Check input parameters for null
 176         if(directory == null) {
 177             if(mDirectory != null){
 178                 directory = mDirectory;
 179             } else {
 180                 directory = Environment.getExternalStorageDirectory();  // TODO be careful with the state of the storage; could not be available
 181                 if (directory == null) return; // no files to show
 182             }
 183         }
 184
 185
 186         // if that's not a directory -> List its parent
 187         if(!directory.isDirectory()){
 188             Log_OC.w(TAG, "You see, that is not a directory -> " + directory.toString());
 189             directory = directory.getParentFile();
 190         }
 191
 192         mList.clearChoices();   // by now, only files in the same directory will be kept as selected
 193         mAdapter.swapDirectory(directory);
 194         if (mDirectory == null || !mDirectory.equals(directory)) {
 195             mList.setSelectionFromTop(0, 0);
 196         }
 197         mDirectory = directory;
 198     }
 199
 200
 201     /**
 202      * Returns the fule paths to the files checked by the user
 203      *
 204      * @return      File paths to the files checked by the user.
 205      */
 206     public String[] getCheckedFilePaths() {
 207         String [] result = null;
 208         SparseBooleanArray positions = mList.getCheckedItemPositions();
 209         if (positions.size() > 0) {
 210             Log_OC.d(TAG, "Returning " + positions.size() + " selected files");
 211             result = new String[positions.size()];
 212             for (int i=0; i<positions.size(); i++) {
 213                 result[i] = ((File) mList.getItemAtPosition(positions.keyAt(i))).getAbsolutePath();
 214             }
 215         }
 216         return result;
 217     }
 218
 219
 220     /**
 221      * Interface to implement by any Activity that includes some instance of LocalFileListFragment
 222      *
 223      * @author David A. Velasco
 224      */
 225     public interface ContainerActivity {
 226
 227         /**
 228          * Callback method invoked when a directory is clicked by the user on the files list
 229          *
 230          * @param file
 231          */
 232         public void onDirectoryClick(File directory);
 233
 234         /**
 235          * Callback method invoked when a file (non directory) is clicked by the user on the files list
 236          *
 237          * @param file
 238          */
 239         public void onFileClick(File file);
 240
 241
 242         /**
 243          * Callback method invoked when the parent activity is fully created to get the directory to list firstly.
 244          *
 245          * @return  Directory to list firstly. Can be NULL.
 246          */
 247         public File getInitialDirectory();
 248
 249     }
 250
 251
 252 }