|
1 | | -FilePickerLibrary |
2 | | -================= |
| 1 | +# FilePickerLibrary |
3 | 2 |
|
4 | | -[](http://android-arsenal.com/details/1/785) |
5 | | - |
6 | | -[](https://jitpack.io/#DeveloperPaul123/FilePickerLibrary) |
| 3 | +[](https://jitpack.io/#alirezaaa/FilePickerLibrary) |
7 | 4 |
|
8 | 5 | Simple library that allows for picking of files and directories. This is a clean and simple way to allow your user to easily select a file. This library is inspired by Android L and the new Material Design guidelines adding to its sleekness and beauty. |
9 | 6 |
|
10 | | - |
11 | 7 | ![image] (images/main_framed.png) |
12 | 8 |
|
13 | | -<h2>Requirements</h2> |
14 | | -Min SDK Level is 16 |
15 | | - |
16 | | -<h2>Dependency</h2> |
17 | | - |
18 | | -Clone this repository or download the zip. Then extract to your computer. Simply import the library to your project but only include the FPlib module (that's where the library is). If you're using Android Studio then import a module and only include the FPlib module. See the license for usage terms. |
19 | | - |
20 | | -Alternatively you can use gradle. |
21 | | - |
22 | | -Add the following code to your gradle build script. |
23 | | -````java |
24 | | - repositories { |
25 | | - ... |
26 | | - maven {url "https://jitpack.io"} |
27 | | - } |
28 | | - dependencies { |
29 | | - compile 'com.github.DeveloperPaul123:FilePickerLibrary:2.1.1' |
30 | | - } |
31 | | - ```` |
32 | | - |
33 | | -<h2>Usage</h2> |
34 | | -Simply do the following. |
35 | | -```java |
36 | | -Intent filePickerIntent = new Intent(this, FilePickerActivity.class); |
37 | | -filePickerIntent.putExtra(FilePickerActivity.REQUEST_CODE, FilePickerActivity.REQUEST_DIRECTORY); |
38 | | -startActivityForResult(filePickerIntent, FilePickerActivity.REQUEST_DIRECTORY); |
| 9 | +## A Quick Overview What's In |
| 10 | +* compatible down to API Level 16 |
| 11 | + |
| 12 | +## Include to Project |
| 13 | +### Provide the Gradle Dependency |
| 14 | +#### Step 1 |
| 15 | +Add the JitPack in your root `build.gradle` at the end of repositories: |
| 16 | +```gradle |
| 17 | +allprojects { |
| 18 | + repositories { |
| 19 | + ... |
| 20 | + maven { url "https://jitpack.io" } |
| 21 | + } |
| 22 | +} |
39 | 23 | ``` |
40 | | -Make sure to add the int extra for your request code. You can also request for a file path instead of a directory. See the javadocs for more info. To get the file path do the following. |
| 24 | +#### Step 2 |
| 25 | +Add the dependency |
| 26 | +```gradle |
| 27 | +dependencies { |
| 28 | + compile 'com.github.alirezaaa:FilePickerLibrary:3.5.1' |
| 29 | +} |
| 30 | +``` |
| 31 | +### Clone or Download `.zip` file |
| 32 | +Clone this repository or download the compressed file, then extract to your computer. Simply import the `library` module to your project. |
41 | 33 |
|
| 34 | +## Usages |
| 35 | +Use one of the following samples or simply compile and test the sample `app` provided: |
| 36 | +### Material Theme Used (with Modern Builder) |
42 | 37 | ```java |
43 | | - @Override |
44 | | - public void onActivityResult(int requestCode, int resultCode, Intent data) { |
45 | | - |
46 | | - if(requestCode == FilePickerActivity.REQUEST_DIRECTORY |
47 | | - && resultCode == RESULT_OK) { |
48 | | - |
49 | | - String filePath = data. |
50 | | - getStringExtra(FilePickerActivity.FILE_EXTRA_DATA_PATH); |
51 | | - if(filePath != null) { |
52 | | - //do something with filePath... |
53 | | - } |
54 | | - } |
55 | | - super.onActivityResult(requestCode, resultCode, data); |
56 | | - } |
| 38 | +new FilePickerBuilder(this) |
| 39 | + .withColor(android.R.color.holo_blue_bright) |
| 40 | + .withRequest(Request.FILE) |
| 41 | + .withScope(Scope.ALL) |
| 42 | + .withMimeType(MimeType.JPEG) |
| 43 | + .useMaterialActivity(true) |
| 44 | + .launch(REQUEST_FILE); |
57 | 45 | ``` |
58 | | - |
59 | | -<h2>Customization</h2> |
60 | | -You can change the header background in the activity by adding resorce ids to your calling intent as int extras. Below is an example. |
61 | | - |
| 46 | +### `image/png` Mime Type |
62 | 47 | ```java |
63 | | -Intent filePickerIntent = new Intent(this, FilePickerActivity.class); |
64 | | -filePickerIntent.putExtra(FilePickerActivity.REQUEST_CODE, FilePickerActivity.REQUEST_DIRECTORY); |
65 | | -filePickerIntent.putExtra(FilePickerActivity.INTENT_EXTRA_COLOR_ID, R.color.myColor); |
66 | | -startActivityForResult(filePickerIntent, FilePickerActivity.REQUEST_DIRECTORY); |
| 48 | +Intent filePicker = new Intent(this, FilePickerActivity.class); |
| 49 | +filePicker.putExtra(FilePickerActivity.SCOPE, Scope.ALL); |
| 50 | +filePicker.putExtra(FilePickerActivity.REQUEST, Request.FILE); |
| 51 | +filePicker.putExtra(FilePickerActivity.INTENT_EXTRA_COLOR_ID, android.R.color.holo_green_dark); |
| 52 | +filePicker.putExtra(FilePickerActivity.MIME_TYPE, MimeType.PNG); |
| 53 | +startActivityForResult(filePicker, REQUEST_FILE); |
67 | 54 | ``` |
68 | | -You can also change the theme for the activity to make it look like a dialog. |
| 55 | +### Show as a Dialog |
69 | 56 | ```java |
70 | | -Intent filePickerDialogIntent = new Intent(getActivity(), FilePickerActivity.class); |
| 57 | +Intent filePickerDialogIntent = new Intent(this, FilePickerActivity.class); |
71 | 58 | filePickerDialogIntent.putExtra(FilePickerActivity.THEME_TYPE, ThemeType.DIALOG); |
72 | | -filePickerDialogIntent.putExtra(FilePickerActivity.REQUEST_CODE, FilePickerActivity.REQUEST_FILE); |
73 | | -startActivityForResult(filePickerDialogIntent, FilePickerActivity.REQUEST_FILE); |
| 59 | +filePickerDialogIntent.putExtra(FilePickerActivity.REQUEST, Request.FILE); |
| 60 | +startActivityForResult(filePickerDialogIntent, REQUEST_FILE); |
74 | 61 | ``` |
75 | | -In addition you can set a mime type that you want the user to select. The activity will not return a result until that type of file is selected. For example: |
76 | | - |
| 62 | +### Select a Directory |
77 | 63 | ```java |
78 | | -Intent filePicker = new Intent(getActivity(), FilePickerActivity.class); |
79 | | -filePicker.putExtra(FilePickerActivity.SCOPE_TYPE, FileScopeType.ALL); |
80 | | -filePicker.putExtra(FilePickerActivity.REQUEST_CODE, FilePickerActivity.REQUEST_FILE); |
81 | | -filePicker.putExtra(FilePickerActivity.INTENT_EXTRA_COLOR_ID, android.R.color.holo_green_dark); |
82 | | -filePicker.putExtra(FilePickerActivity.MIME_TYPE, FileType.PNG); |
83 | | -startActivityForResult(filePicker, FilePickerActivity.REQUEST_FILE); |
| 64 | +Intent filePickerActivity = new Intent(this, FilePickerActivity.class); |
| 65 | +filePickerActivity.putExtra(FilePickerActivity.SCOPE, Scope.ALL); |
| 66 | +filePickerActivity.putExtra(FilePickerActivity.REQUEST, Request.DIRECTORY); |
| 67 | +filePickerActivity.putExtra(FilePickerActivity.INTENT_EXTRA_FAB_COLOR_ID, android.R.color.holo_green_dark); |
| 68 | +startActivityForResult(filePickerActivity, REQUEST_DIRECTORY); |
84 | 69 | ``` |
85 | | - |
86 | | -Finally, you can now use a builder class to simplify intent creation: |
| 70 | +To have the result, you must override `onActivityResult(int, int, Intent)` method as I did below: |
87 | 71 |
|
88 | 72 | ```java |
89 | | -new FilePickerBuilder(getActivity()).withColor(android.R.color.holo_blue_bright) |
90 | | - .withRequestCode(FilePicker.REQUEST_FILE) |
91 | | - .withScopeType(FileScopeType.ALL) |
92 | | - .withMimeType(FileType.PNG) |
93 | | - .useMaterialActivity(true) |
94 | | - .launch(); |
95 | | -``` |
96 | | -You can also call ` build() ` instead of ` launch() ` and you will get back an activity. Note that `launch()` starts the activity with `startActivityForResult() ` and uses the request code you passed into the builder as the request code for the activity result extra. So when listening for activity results be sure to use the same request code. |
97 | | - |
98 | | -<h2>Demo App</h2> |
99 | | -* **Check out the sample on google play.** |
100 | | - |
101 | | - [](https://play.google.com/store/apps/details?id=com.devpaul.filepicker) |
102 | | - |
103 | | -<h2>Developed By</h2> |
104 | | -**Paul T** |
105 | | - |
106 | | -<h2>License</h2> |
107 | | - |
108 | | -Copyright 2014 Paul T |
109 | | - |
110 | | -Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. |
111 | | - |
112 | | -You may obtain a copy of the License at |
| 73 | +@Override |
| 74 | +public void onActivityResult(int requestCode, int resultCode, Intent data) { |
| 75 | + super.onActivityResult(requestCode, resultCode, data); |
113 | 76 |
|
114 | | -http://www.apache.org/licenses/LICENSE-2.0 |
| 77 | + if ((requestCode == REQUEST_DIRECTORY) && (resultCode == RESULT_OK)) { |
| 78 | + Toast.makeText(this, "Directory Selected: " + data.getStringExtra(FilePickerActivity.FILE_EXTRA_DATA_PATH), Toast.LENGTH_LONG).show(); |
| 79 | + } else if ((requestCode == REQUEST_FILE) && (resultCode == RESULT_OK)) { |
| 80 | + Toast.makeText(this, "File Selected: " + data.getStringExtra(FilePickerActivity.FILE_EXTRA_DATA_PATH), Toast.LENGTH_LONG).show(); |
| 81 | + } |
| 82 | +} |
| 83 | +``` |
| 84 | +## Contributors |
| 85 | +- [Paul T](mailto:developer.paul.123@gmail.com) (developer) |
| 86 | +- [Alireza Eskandarpour Shoferi](https://twitter.com/enormoustheory) (contributor) |
115 | 87 |
|
116 | | -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| 88 | +## License |
| 89 | + Copyright 2014 Paul T |
| 90 | + |
| 91 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 92 | + you may not use this file except in compliance with the License. |
| 93 | + You may obtain a copy of the License at |
| 94 | + |
| 95 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 96 | + |
| 97 | + Unless required by applicable law or agreed to in writing, software |
| 98 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 99 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 100 | + See the License for the specific language governing permissions and |
| 101 | + limitations under the License. |
0 commit comments