v1.5.0

Author: sheikh-abdul-aziz

README.md

@@ -22,29 +22,31 @@ This documentation guides you on how to integrate and use the `FileTree` library
 
   **4. Customizing Icons**
 
-  **5. Asynchronous File System**
+  **5. AttributeSet**
 
-  **6. Example (Android View-Based)**
+  **6. Asynchronous File System**
 
-  **7. Frequently Asked Questions (FAQ)**
+  **7. Example (Android View-Based)**
 
   **8. License.**
 
 ## 1. Introduction
 
-The `FileTree` library provides a robust and modular way to manage and display file trees within your IDEs and code editors. It offers the following key features:
+The `FileTree` library offers a comprehensive and modular solution for managing and displaying file trees within IDEs and code editors. It is designed to provide the following key features:
 
-- **Hierarchical File Tree Representation:** Presents files and folders in a hierarchical tree structure.
+- **Hierarchical File Tree Representation:** Displays files and folders in an organized hierarchical tree structure.
 
-- **Hover-Navigated Directory**: Highlights directories as users navigate through them by clicking. This feature enhances user experience by visually indicating the current directory and providing a clear, interactive method for exploring the directory tree.
+- **Hover-Navigated Directory:** Highlights directories as users navigate through them with clicks. This feature enhances user experience by visually indicating the current directory, offering a clear and interactive method for exploring the directory tree.
 
-- **Lazy Loading:** Optimizes loading time by only loading child nodes when expanded.
+- **Lazy Loading:** Improves loading time by loading child nodes only when they are expanded.
 
-- **Asynchronous File System:** Performs file functions like expanding, collapsing, loading files in `FileTree`, etc. in the background thread to avoid blocking the Main UI Thread.
+- **Asynchronous File System:** Executes file operations like expanding, collapsing, and loading files in the `FileTree` on a background thread, preventing the Main UI Thread from being blocked.
 
-- **Customizable Icons:** Allows you to set custom icons for files and folders.
+- **Customizable Icons:** Enables the use of custom icons for files and folders.
 
-- **Flexibility:** Integrates seamlessly with various IDE UI frameworks (Android Views, Swing, SWT, Jetpack Compose).
+- **Concurrent FileMap:** Maintains a record of recently accessed files and directories, facilitating quick access to previously expanded files and directories.
+
+- **RecyclerItemView:** Utilizes the built-in RecycledViewPool of RecyclerView to reuse old views, reducing memory usage by avoiding the creation of new views.
 
 ### Overview
 
@@ -72,37 +74,19 @@ The specific instructions for adding a dependency will depend on your IDE and bu
 
 ### 2.2. Initialization and Loading
 
-**1. Create an Instance:** Instantiate a `FileTree` object, providing the root directory:
-
-```kotlin
-val fileTree = FileTree(this, "/storage/emulated/0")
-```
-
-**2. Load the FileTree:** Call the `loadFileTree()` method to load the initial file tree structure. This will load the root directory and its immediate children:
+**1. Initialize:** Instantiate a `FileTree` object, providing the root directory:
 
 ```kotlin
-fileTree.loadFileTree()
+fileTreeView.initializeFileTree(this, "/storage/emulated/0")
 ```
 ### 2.3. UI Integration
 
-This step involves integrating the `FileTree` library with your IDE's UI framework. The specific implementation will vary depending on your chosen UI framework. Below are common frameworks with basic examples:
+This step involves integrating the `FileTree`  Library within your  project, here's a basic example using Android Views:
 
 - **Android View-Based (Android/Kotlin/Java):** Define `FileTreeView` in your Layout (XML) to display your `FileTree` data.
 
     Docs [Getting Sarted](docs/integration/Android.md)
 
-- **Jetpack Compose (Android/Kotlin):** Define a composable that renders the file tree using your `FileTree` data. 
-
-    Docs [Getting Sarted](docs/integration/Android-Jetpack-Compose.md)
-
-- **Swing (Java):** Use a `JTree` component and create a custom TreeModel that uses the `FileTreeNode` data from your `FileTree` object. 
-
-    Docs [Getting Sarted](docs/integration/Java-Swing.md)
-
-- **SWT (Java):** Similar to Swing, use a `TreeViewer` and a custom `TreeContentProvider` to map your `FileTreeNode` data.
-
-    Docs [Getting Sarted](docs/integration/Java-SWT.md)
-
 ### 2.4. Event Handling
 
 The `FileTree` library provides events that you can use to react to user actions within the file tree:
@@ -151,22 +135,29 @@ import java.io.File
 
 class FileIconProvider : FileTreeIconProvider {
 
-    override fun getChevronExpandIcon(): Int {
-        return R.drawable.ic_chevron_expand
-    }
-
-    override fun getChevronCollapseIcon(): Int {
-        return R.drawable.ic_chevron_collapse
+    override fun getChevronIcon(): Int {
+        return R.drawable.ic_chevron
     }
 
-    override fun getFolderIcon(): Int {
+    override fun getDefaultFolderIcon(): Int {
         return R.drawable.ic_folder
     }
 
     override fun getDefaultFileIcon(): Int {
         return R.drawable.ic_file
     }
 
+    override fun getIconForFolder(folder: File): Int {
+        return when (folder.name) {
+            "app" -> R.drawable.ic_folder
+            "src" -> R.drawable.ic_folder
+            "kotlin" -> R.drawable.ic_folder
+            "java" -> R.drawable.ic_folder
+            "res" -> R.drawable.ic_folder
+            else -> getDefaultFolderIcon()
+        }
+    }
+
     override fun getIconForFile(file: File): Int {
         return when (file.name) {
             "gradlew.bat" -> R.drawable.ic_gradlewbat
@@ -189,11 +180,43 @@ class FileIconProvider : FileTreeIconProvider {
 }
 ```
 
-## 5. Asynchronous File System
+## 5. AttributeSet 
+
+| Attribute Name            | Description                                                                                     | Default Value | XML Attribute                   | Type    |
+|---------------------------|-------------------------------------------------------------------------------------------------|---------------|---------------------------------|---------|
+| **recyclerItemViewCount** | Defines the maximum number of items the RecyclerView can hold in its recycled view pool.        | 200           | `app:recyclerItemViewCount`     | Integer |
+| **recyclerItemViewEnabled** | Enables or disables the use of a recycled view pool for the RecyclerView.                      | true          | `app:recyclerItemViewEnabled`   | Boolean |
+| **itemViewCacheSize**     | Sets the maximum size for the view cache in the RecyclerView.                                   | 100           | `app:itemViewCacheSize`         | Integer |
+| **itemViewCachingEnabled** | Enables or disables caching of item views in the RecyclerView.                                 | true          | `app:itemViewCachingEnabled`    | Boolean |
+| **fileMapMaxSize**        | Specifies the maximum number of entries in the file map, which caches recently accessed files and directories. | 150           | `app:fileMapMaxSize`            | Integer |
+| **fileMapEnabled**        | Enables or disables the file map functionality.                                                 | true          | `app:fileMapEnabled`            | Boolean |
+| **fileTreeAnimation**     | Sets the animation style for expanding and collapsing the file tree.                            | 4             | `app:fileTreeAnimation`         | Integer |
+| **fileTreeAnimationEnabled** | Enables or disables animations for the file tree.                                             | true          | `app:fileTreeAnimationEnabled`  | Boolean |
+
+### Usage Example
+
+To configure these attributes in your XML layout file, use the following syntax:
+
+```xml
+<com.zyron.filetree.widget.FileTreeView
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    app:recyclerItemViewCount="250"
+    app:recyclerItemViewEnabled="true"
+    app:itemViewCacheSize="120"
+    app:itemViewCachingEnabled="true"
+    app:fileMapMaxSize="180"
+    app:fileMapEnabled="true"
+    app:fileTreeAnimation="FallDown"
+    app:fileTreeAnimationEnabled="false"/>
+```
+Adjust these values according to your application's needs to optimize performance and user experience.
+
+## 6. Asynchronous File System
 
 The `FileTree` library typically uses a built-in asynchronous system powered by Kotlin Coroutines to perform core file functions such as expanding, collapsing and loading files in `FileTree` on the background thread. This ensures that the UI thread remains responsive while the functions are executed.
 
-## 6. Example (Android view-based)
+## 7. Example (Android view-based)
 
 Here's a basic example of using the `FileTree` library with Android views:
 
@@ -234,24 +257,6 @@ class MainActivity : AppCompatActivity() {
 }
 ```
 
-## 7. Frequently Asked Questions (FAQ)
-
-**Q:** How do I get the selected file or folder in the file tree?
-
-**A:** Use the event listener for node selection to retrieve the selected node. The selected node will likely represent the FileTreeNode object that you can use to access the underlying File object.
-
-**Q:** How do I refresh the file tree after making changes to the file system?
-
-**A:** Use the `loadFileTree()` method to reload the tree structure. If you only need to update a portion of the tree, you can refresh specific nodes or sections.
-
-**Q:** Can I customize the appearance of the file tree?
-
-**A:** Yes, you can customize the appearance by using custom renderers (Swing, SWT) or composables (Jetpack Compose) to control the display of nodes.
-
-**Q:** Can I use the `FileTree` library for other purposes besides IDEs and Code Editors?
-
-**A:** Yes, the library can be adapted for other applications that require file tree management, such as file explorers or project management tools.
-
 ## 8. License
 ```
 Copyright 2024 Zyron Official.
@@ -267,4 +272,4 @@ 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.
-```
+```

app/build.gradle

@@ -6,14 +6,14 @@ plugins {
 android {
     namespace 'com.zyron.filetree'
     compileSdk 34
-    
+
     defaultConfig {
         applicationId "com.zyron.filetree"
-        minSdk 26
+        minSdk 29
         targetSdk 34
-        versionCode 1
-        versionName "1.0.0"
-        
+        versionCode 2
+        versionName "1.5.0"
+
         vectorDrawables { 
             useSupportLibrary true
         }
@@ -33,7 +33,7 @@ android {
 
     buildFeatures {
         viewBinding true
-        
+
     }
 }
 
@@ -45,4 +45,4 @@ dependencies {
     implementation 'androidx.core:core-ktx:1.13.1'  
     implementation 'androidx.recyclerview:recyclerview:1.3.2'
     implementation 'androidx.preference:preference-ktx:1.2.1'          
-}
+}

app/src/main/kotlin/com/zyron/filetree/executorservice/FileOperationExecutor.kt

@@ -2,7 +2,7 @@ package com.zyron.filetree.executorservice
 
 import android.content.Context
 import android.widget.Toast
-import com.zyron.filetree.interfaces.FileTreeEventListener
+import com.zyron.filetree.events.FileTreeEventListener
 import java.io.File
 
 class FileOperationExecutor(private val context: Context) : FileTreeEventListener {

app/src/main/res/layout/activity_main.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<androidx.drawerlayout.widget.DrawerLayout xmlns:android="http://schemas.android.com/apk/res/android"
+<androidx.drawerlayout.widget.DrawerLayout
+    xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:tools="http://schemas.android.com/tools"
     android:id="@+id/drawer_layout"
@@ -39,17 +40,33 @@
 
     <com.google.android.material.navigation.NavigationView
         android:id="@+id/navigation_view"
-        android:layout_width="348dp"
+        android:layout_width="300dp"
         android:layout_height="match_parent"
         app:drawerLayoutCornerSize="4dp"
         android:padding="8dp"
         android:layout_gravity="start"
         style="@style/Widget.Material3.NavigationView">
-        
-        <com.zyron.filetree.widget.FileTreeView
-            android:id="@+id/file_tree_view"
+
+        <HorizontalScrollView
             android:layout_width="match_parent"
-            android:layout_height="match_parent"/>
+            android:layout_height="match_parent"
+            android:scrollbarSize="0dp"
+            android:fillViewport="true">
+
+            <androidx.core.widget.NestedScrollView
+                android:layout_width="match_parent"
+                android:layout_height="match_parent"
+                android:fillViewport="true">
+
+                <com.zyron.filetree.widget.FileTreeView
+                    android:id="@+id/file_tree_view"
+                    android:layout_width="match_parent"
+                    android:layout_height="wrap_content"
+                    app:fileTreeAnimation="FallDown"/>
+
+            </androidx.core.widget.NestedScrollView>
+
+        </HorizontalScrollView>
 
     </com.google.android.material.navigation.NavigationView>