Documentation

This page documents and explains public properties of easiFileManager classes and Interfaces;

Classes:

1. easyFileManager

Interfaces:

1. File_action_event_listener
2. File_item_evens_listener
3. FileManager_states_listener
4. Option_item_events_listener

easiFileManager

easiFileManager extends Fragment

Properties:

• public String SDCARD_Path

  The external storage directory path of the OS; The default value is "/sdcard".

• public static final int MODE_SINGLE_FILE_SELECTION

  If passed as the mode the FileManager wouldn't allow selection of multiple files and there is no OptionsBar;

• public static final int MODE_REGULAR_FILE_MANAGMENT

  If passed as the mode the FileManager allows regular file managing; multiple files and folders can be selected; OptionsBar is available and new actions to be performed on selected files can be added as Options;

• public static final String OPTION_DELETE_ID

  Option id of the defualt delete option;

• public static final String OPTION_COPY_ID

  Option id of the defualt copy option;

• public static final String OPTION_MOVE_ID

  Option id of the defualt move option;

• public static final String OPTION_NEW_FOLDER_ID="NEW_FOLDER"

  Option id of the defualt new-folder option;

• public static final int STATE_BROWSING_DIRS_TO_SELECT_COPY_OR_CUT_DESTINATION

  If default options are added and the user clicks on copy or move the file manager would navigate to the sdcard directory so the destination folder can be selected; the state property then becomes equal this value;

• public static final int STATE_BROWSING_DIRS

  If state value equals this value it means user is browsing directories;

• public int state

  Holds the state of FileManager

• public boolean FileManager_is_ready

  Holds true if the FileManager fragment is commited and brought to view; otherwise Holds false; Calling methods that interact with UI while this value is false would throw an exception.

• public List allowed_file_extentions_list

  This List contains the only file extensions which are allowed; If it holds any items then no files other than the ones whose extensions match any of this list's items will be displayed;

• public List allowed_folder_extentions_list

  This List contains the only folder extensions which are allowed; If it holds any items then no folder other than the ones whose extensions match any of this list's items willbe displayed;

• public List excluded_file_extentions_list

  This List contains the file extensions which are not allowed; If allowed_file_extentions_list holds any items then this list is un-effective;

• public List excluded_folder_extentions_list

  This List contains the folder extensions which are not allowed; If allowed_folder_extentions_list holds any items then this list is un-effective;

Methods:

• public void add_on_FileItem_EventListener(File_item_evens_listener file_item_evens_listener)

• public void add_Icon_for_file_type(Bitmap icon,String File_Extention)

• public easyFileManager(Activity activity, String directory_to_browse, int mode, FileManager_states_listener fileManager_states_listener) throws Exception

• public void add_common_options_and_operations()

• public void unselect_all_file_items() throws Exception

• public boolean is_file_extention_allowed(File file)

• public void navigate_to_parent_directory()

• public void navigate_to_directory(File f) throws IOException

• public List get_list_of_option_IDs()

• public void show_pic(final File image_File)

• public void add_folder() throws Exception

• public void add_Option_to_OptionsBar(Bitmap option_icon_bitmap, final Option_item_events_listener option_item_events_listener, String Option_ID, boolean is_available_only_when_files_are_selected)throws Exception

• public void remove_Option_from_OptionsBar(String Option_ID)throws Exception

• public String get_current_path()

• public List get_selected_Files_list()

• public void handle_Back_button_pressed_event()

• public void show_OptionsBar(boolean b)

• public static String getFileType(File file)

• public static String get_FileName_Extention(String s)

• public static File return_nonexisting_file(String dir, String name, String ext)

• public static String add_num_to_name(String name, int i1)

• public static void perform_action_on_file_or_folder(File Folder_or_File,File_action_event_listener action)

File_action_event_listener

Methods:

• void on_File_about_to_be_processed(File f)
• void on_Overall_progress_changed(int amount_of_progress_done, int amount_of_all_the_progress)

File_item_evens_listener

Methods:

• void FileItem_onClickListener(File file);
• void FileItem_onLongClickListener(File file);

FileManager_states_listener

Methods:

• void onFile_Manager_Ready(easyFileManager fileManager);

Option_item_events_listener

Methods:

• void Option_item_OnClickListener(List selected_Files_list);
• void Option_item_OnlongClickListener(List selected_Files_list);