GralFileSelector

java.lang.Object
- org.vishia.gral.base.GralWidgetBase
- - org.vishia.gral.widget.GralFileSelector

All Implemented Interfaces:

GralWidgetBase_ifc

Direct Known Subclasses:

FcmdFileCard
```
public class GralFileSelector
extends GralWidgetBase
```
This class is a large widget which contains a list to select files in a directory, supports navigation in the directory tree and shows the current path in an extra text field. Additional 'search in files' is supported.

The type of a file is a FileRemote. This type inherits from File and is supported for a local file system on PC. It is possible to work with any remote file system.

The graphical user interface allows some action to do with the right mouse menu:
- Refresh content
- sort files by date latest, newest, by size largest, smallest, by name and by extension.
- Search content in files with a dialog window.
Callback to users program:
The method setActionOnFileSelected(GralUserAction) allows any action while the user select any file. For example a user's program can show the content of the file.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`GralFileSelector.Callbacks`
`static class`	`GralFileSelector.Constants`
`private static class`	`GralFileSelector.ERefresh` Name of the current file.
`static class`	`GralFileSelector.FavorPath` Entry in the favorite list.
`protected class`	`GralFileSelector.FileSelectList` Implementation of the base widget.
`static class`	`GralFileSelector.Gui` Inner data of Graphical User Interface.
`protected static class`	`GralFileSelector.InternalData`
`static class`	`GralFileSelector.MenuTexts` This class is instantiated static and contains English menu texts.
`class`	`GralFileSelector.WindowConfirmSearch` A window for search-in-file dialogue.

Nested classes/interfaces inherited from class org.vishia.gral.base.GralWidgetBase
GralWidgetBase.GralWidgComposite, GralWidgetBase.TimeOrderCreateImplWidget

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) GralFileSelector.Callbacks`	`action`
`static GralFileSelector.MenuTexts`	`contextMenuTexts`
`private EventSource`	`evSrc`
`protected <any>`	`fillinEv` Event as back event for fillin.
`protected GralFileSelector.Gui`	`gui`
`protected GralFileSelector.InternalData`	`idata`
`static java.lang.String`	`sVersion` Version, history and copyright/copyleft.
`protected GralFileSelector.WindowConfirmSearch`	`windSearch`

Fields inherited from class org.vishia.gral.base.GralWidgetBase
_cdata, _wdgPos, bVisibleState, gralMng, name, pixSize

Constructor Summary

Constructors
Constructor and Description
`GralFileSelector(GralPos refPosParent, java.lang.String posName, GralWindow windFileSelector, int rows, int[] columns, boolean bWithFavor, java.lang.String sExecBtn, GralViewFileContent fileViewer, GralFileProperties wdgFileProperties)` Creates a new instance of this comprehensive widget for file selection, search and viewing

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`actionUserKey(int keyCode, java.lang.Object userDataOfLine, GralTableLine_ifc<FileRemote> line)` This method is called on any user key or mouse event while operating in the file table.
`GralTableLine_ifc<GralFileSelector.FavorPath>`	`add(java.lang.String name, java.lang.String path)`
`GralTableLine_ifc<GralFileSelector.FavorPath>`	`addFavor(GralFileSelector.FavorPath favorPathInfo)` Adds a line to this table.
`void`	`addFavor(java.util.List<GralFileSelector.FavorPath> list)`
`protected java.lang.String`	`buildKey(FileRemote file, boolean bAllCompleteWithFileInfoP, java.lang.String[] retSortName)`
`void`	`checkRefresh(long since)` Refreshes cyclically
`void`	`clear()`
`void`	`closeDialog()`
`private void`	`completeLine(GralTableLine_ifc<FileRemote> tline, FileRemote file, long timeNow)`
`static GralFileSelector`	`createGralFileSelectorWindow(GralMng mng, boolean visible, java.lang.String posName, java.lang.String sExec, java.util.List<GralFileSelector.FavorPath> favors)`
`FileRemote`	`currentDir()` Gets the directory which is currently shown.
`FileRemote`	`currentFile()` Gets the current selected file.
`protected void`	`doActionExec(int key, GralWidget_ifc widgd, java.lang.Object... params)`
`protected void`	`doActionGetFileName(int key, GralWidget_ifc widgd, java.lang.Object... params)` Copies the name of the current selected file as file name into the #widgPathDir as presetting for save, rename etc.
`void`	`doActionSelectFileTableFromFavor()` Called from click on line in favor table to select this favor and show the adequate file table.
`void`	`doActivateFavor()` Activates the favor card.
`(package private) void`	`doFileLineSelect(GralTable.TableLineData line)`
`void`	`fillFavorPaths(java.util.List<GralFileSelector.FavorPath> listfavorPaths)` Add all favor paths from the SelectTab newly
`void`	`fillIn(FileRemote fileIn, boolean bDonotRefrehs)` Fills the content with given directory.
`protected void`	`fillIn(java.util.List<java.io.File> files)`
`void`	`fillInCurrentDir()` It is the refresh operation.
`void`	`fillInOriginDir()` Fills the content with the first directory or the directory which was set with `#setOriginDir(File)`.
`(package private) void`	`finishShowFileTable()` Finishes a newly showed file table.
`void`	`forcefillIn(FileRemote fileIn, boolean bDonotRefrehs)`
`FileRemote`	`getCurrentDir()` same as `currentDir()`.
`java.lang.String`	`getCurrentDirPath()` Creates the window to confirm search in files.
`GralWidgetBase_ifc`	`getFocusedWidget()` Returns the widget which is in focus of a panel or comprehensive widget.
`java.lang.String`	`getLabelCurrFavor()`
`java.util.List<FileRemote>`	`getSelectedFiles(boolean bAlsoDirs, int mask)` Gets the selected file from this panel.
`boolean`	`isInFocus()` Returns true if this widget is the focused one.
`boolean`	`isVisible()` Returns whether the widget is visible or not.
`void`	`openDialog(FileRemote startFile, java.lang.String sTitle, java.lang.String sBtnText, GralUserAction actionEnter, GralUserAction actionButton)` Prepares the action and appearance and shows the window or the widget (get visible).
`void`	`refresh()` Refreshes the content especially after change as copy, delete etc.
`boolean`	`remove()` Removes the widget from the lists in its panel and from the graphical representation.
`boolean`	`selectFile(java.lang.String name)` Selects the file with the given name in the table
`void`	`selectFileTable(java.lang.String sFavor, FileRemote startFile)`
`protected void`	`selectFileTableFromFavor(GralFileSelector.FavorPath favor, FileRemote fileStart)` Called either from tab selection or from a line in the favor table (`doActionSelectFileTableFromFavor()`.
`GralUserAction`	`setActionOnEnterDirectory(GralUserAction newAction)` This action will be called on pressing enter or mouse-click on a directory.
`GralUserAction`	`setActionOnEnterFile(GralUserAction newAction)` Sets the action which is called if any file is entered.
`GralUserAction`	`setActionOnEnterPathNewFile(GralUserAction newAction)` This action will be called on pressing enter or mouse-click on the path text field if it contains any text which can't assigned to an existing file.
`void`	`setActionOnFileSelected(GralUserAction actionOnLineSelected)` Sets an action which is called any time when another line in a file table is selected.
`void`	`setActionOnFocusedFileTable(GralUserAction newAction)` Sets the action which is called if any file is entered.
`GralUserAction`	`setActionOnSaveButton(GralUserAction newAction, java.lang.String textButton)` Sets the action which is called if any file is entered.
`GralUserAction`	`setActionSaveFavors(GralUserAction newAction)` This action will be called on context menu for the Favor tab to save its content.
`GralUserAction`	`setActionSetFileLineAttrib(GralUserAction newAction)` Sets the action which is called if any file is set to the table.
`void`	`setDateFormat(java.lang.String sFormat)` Maybe called after construction, should be called before `#setToPanel(GralMngBuild_ifc)`
`void`	`setFocus()` Sets the focus of the associated table widget.
`void`	`setFocus(int delay, int latest)`
`void`	`setFocusedWidget(GralWidgetBase_ifc widg)` If this widget is a comprehensive widget or a panel, it sets one of the content as focused.
`(package private) void`	`setNewDirFile(java.lang.String sPathP)`
`void`	`setOriginDir(FileRemote dir)`
`void`	`setSortOrder(char sortOrder)` Sets the sort order of entries.
`boolean`	`setVisible(boolean visible)` Sets this widget visible on graphic or invisible.
`(package private) void`	`showFile(FileRemote file1)` This routine is invoked in callback of `#callbackChildren1` for `fillIn(FileRemote, boolean)` in the refresh thread.
`protected void`	`showFileInfo(GralTable.TableLineData line)` If given in ctor, opens the file property window and show file properties.
`(package private) void`	`stop()`
`protected void`	`updateFavorWithCurrentDir()` Updates the current favor with the current file table's directory path.
`java.io.File`	`XXXgetSelectedFile()` Gets the selected file from this panel.

Methods inherited from class org.vishia.gral.base.GralWidgetBase
checkImplWidgetCreation, createImplWidget_Gthread, createImplWidget, getImplAccess, getName, gralMng, hasFocus, pos, removeImplWidget_Gthread, resizePostPreparation, setFocused, toString, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - sVersion
```
public static final java.lang.String sVersion
```
    Version, history and copyright/copyleft.
    - 2023-01-22 "big" refactoring: Sort data in sub classes because there was no overview on debugging.
    - 2023-01-19 now also a file select window possible with favors, some enhancements.
    - 2023-01-18 chg The [Favor] button is removed, instead, the #widgFavorTabs as on left side the tab "+sel" to select the favor table. A more intuitive approach.
    - 2023-01-18 new #openDialog(FileRemote, String, String, GralUserAction) now from the GralFileSelectWindow, which should be get deprecated or removed, because this class contains the #windFileSelector.
    - 2023-01-18 refactoring, new field for file name
      Enter on file entry writes the filename either in the given filename field or in the path field
      
      2023-01-17 save button, function ctrl-N in path field to get the file name
      2023-01-15 Now GralFileProperties is able to aggregate.
      2023-01-14 Now a favor which is selected is marked green, remove of tabs works. (!)
      2023-01-06 progress, practical usage for The.file.Commander
      2022-12-21 progress, tabs for file cards with GralHorizontalSelector as before in Fcmd only
      2022-12-21 progress, now switch between both tables and also [F3] key with a view window.
      2022-12-20 Favor table activated now at last.
      2022-12-17 improved while test, positions use now the new GralPos.setAsFrame(). A test class org.vishia.gral.test.basics.Test_GralFileSelector is created for test.
      2021-12-18 Hartmut: new feature: fillIn(FileRemote, boolean), if the file is a file not directory then this file is highlighted. Firstly used on InspcCurveViewApp to get cfg and data from the same directory, re-read the same file is before by saving the gotten file before.
      2018-10-28 Hartmut: The Creation and Position is old style yet. Should invoked in the graphic thread. to do: create and position in other (main) thread, createImplWidget_Gthread for Swt incarnation.
      2018-10-28 Hartmut: The #widgFavorTable is unused yet, create only if position is given.
      2018-10-28 Hartmut: questionWindow is removed yet, to do: should have better solution. Status line!
      2018-10-28 Hartmut: #GralFileSelector(String, int, int[], int[]): The rows argument is used yet for table zLinesMax. The old last argument size was never used. replaced by the column designation for the #widgFavorTable. If it is null, do not create a #widgFavorTable.
      2016-05-02 Hartmut: actionFileSearch writes a result list in the panel of the file window. Yet you can copy the path and insert in the directory text widget to select the file. to do: Pressing enter to select, store the list etc.
      2016-05-02 Hartmut now: derived from GralWidget, it is a large widget
      2016-05-03 Hartmut new: setVisible(boolean) for this large widget.
      2015-11-19 Hartmut chg: fillInCurrentDir() does not refresh if it was refreshed in the last seconds.
      2014-12-26 Hartmut chg: fillIn(FileRemote, boolean) now with new meaning of boolean: show newly without refresh with the file system. This is used in callback routines which does a refresh but does not invoke showFile(FileRemote) especially called from Fcmd.refreshFilePanel(FileRemote).
      2014-01-02 Hartmut chg: does not call 'file.refreshProperties(null);' in #actionSetPath because the property whether it is a directory or not should be known. Prevents a timeout waiting in graphic thread!!!
      2013-09-06 Hartmut chg: Now a new request of fillIn can be executed with aborting the old one.
      2013-09-15 Hartmut chg: New implementation of fillIn(FileRemote, boolean) using the new FileRemote#getChildren(org.vishia.fileRemote.FileRemote.ChildrenEvent).
      2013-09-14 Hartmut chg: Sets the background to magenta while refreshing.
      2013-09-05 Hartmut chg: getSelectedFiles(boolean, int) now has that 2 arguments for directory and mark mask. Now it is possible and necessary for the application to choice whether directories are gotten too. The usage is improved. If some files are marked but not visible, it was able that the user does not know about this situation and an unexpected behavior for the user is done. Now only marked files are returned if the current file is marked too. The method is correct named 'selected' because the selection is returned, either the current file or all marked.
      2013-06-15 Hartmut chg: fillIn(FileRemote, boolean) modi of refresh.
      2013-05-30 Hartmut new: switch refresh mode on and off
      2013-05-20 Hartmut chg: #fillInRefreshed(FileRemote, boolean) now does not clear the table but writes only lines if the data are changed. This method can be called in a higher frequency without disturbing the appearance of the table. Used for cyclically refresh.
      2013-05-20 Hartmut new: Context menu for sort etc. It was part of Fcmd, now here.
      2013-04-30 Hartmut new: context menu now available. Sort, refresh, deselect
      2013-04-30 Hartmut new: checkRefresh(long), chg: Don't change the content in the table if the content is identical with the current presentation in table, for refreshing.
      2013-04-30 Hartmut chg: fillIn(FileRemote, boolean) now uses the FileRemote#timeRefresh
      2013-04-28 Hartmut new: #actionOnMarkLine changes the select status of FileRemote#setMarked(int)
      2013-04-12 Hartmut adapt Event, FileRemote: The attributes Event.data1, data2, oData, refData are removed. Any special data should be defined in any derived instance of the event. A common universal data concept may be error-prone because unspecified types and meanings. FileRemote: Dedicated attributes for CallbackCmd#successCode etc.
      2013-03-28 Hartmut chg: #setToPanel(GralMngBuild_ifc, String, int, int[], char) preserves the panel before calling.
      2012-11-11 Hartmut bugfix: #fillInRefreshed(File, boolean): If all files are complete with file info, nevertheless the RefreshTimed#delayedFillin(int) was called because the whole routine was called with false as bCompleteWithFileInfo-argument. Now that is prevented if all files were tested already.
      2012-10-12 Hartmut chg {@link WindowFileSelection#openDialog(String, String)} with title.
      2012-10-01 Hartmut new now {@link #fillIn(File, boolean)} doesn't get the file properties if it is called with false. This makes it faster to show large content of folders on remote devices (in PC-network). If a file is selected it replaces its properties.
      2012-09-24 Hartmut new.jar files opened as zip file.
      2012-07-30 Hartmut improved using of extra thread on refreshing file properties. Write first 'waiting', the other thread writes the content maybe delayed. The user can abort the access if a response is not kept.
      2012-07-28 Hartmut improved zipfile access.
      2012-07-29 Hartmut improved access to the file system using the new capabilities of FileRemote. to do consequently writing 'wait for response' in table and access to the file in another thread.
      2012-07-01 Hartmut new {@link #setActionOnEnterPathNewFile(GralUserAction)}. Now this widget is used to select a file to read and save in an application other than the.File.commander.
      2012-07-01 Hartmut Refactoring usage of FileRemote: Normally the java.io.File is used. The FileRemote is a specialization, which is not used in all cases.
      2012-06-17 new Hartmut: Now sorts list with name, size, date, format of size and date in list adjusted: Separate timestamp of file for today, last year.
      2012-06-09 new Hartmut: {@link GralFileSelector.WindowFileSelection}, not ready yet.
      2012-04-16 chg: Capability to sort enhanced.
      2012-04-10 chg: Now ctrl-PgUp to select parent dir, like in Norton Commander, ctrl-PgDn to entry in dir (parallel to Enter).
      2012-03-09 new {@link #kColFilename} etc.
      2012-02-14 corr: Anytime a file was selected as current, it was added in the {@link #idxSelectFileInDir}. Not only if the directory was changed. It is necessary for refresh to select the current file again.
      2011-12-11 chg: If the directory is empty, show --empty-- because the table should not be empty.
      2011-11-27 new: {@link FileAndName#isWriteable}-property.
      2011-11-20 new: Phenomenal basic idea: The files may be located in remote hardware. It means, that a File can't be access here. Therefore the path, name, date, length in the class {@link FileAndName} are the data represents on this process on PC. The access to the file is given with remote access. Usage of inner class FileAndName containing path, name, date, length instead a File instance.
      2011-10-02 new: {@link #setActionOnEnterFile(GralUserAction)}. It executes this action if Enter is pressed (or mouse-left- or doubleclick-to do).
      2011-10-01 new: {@link #setOriginDir(File)} and {@link #fillInOriginDir()}. The origin dir is the directory of first selection or can be set by user. If the user navigates misty, the origin dir helps to find again the start point.
      2011-09-28 new: {@link #getCurrentDir()}
      2011-08-14 created. Firstly used for the Java commander. But it is a universal file select widget.
      Copyright/Copyleft:
      For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
      
      You can use this source without any restriction for any desired purpose.
      You can redistribute copies of this source to everybody.
      Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
      But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
      You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
      If you intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - windSearch
```
protected GralFileSelector.WindowConfirmSearch windSearch
```
  - contextMenuTexts
```
public static GralFileSelector.MenuTexts contextMenuTexts
```
  - idata
```
protected final GralFileSelector.InternalData idata
```
  - gui
```
protected final GralFileSelector.Gui gui
```
  - evSrc
```
private final EventSource evSrc
```
  - fillinEv
```
protected final <any> fillinEv
```
    Event as back event for fillin.
  - action
```
final GralFileSelector.Callbacks action
```
- Constructor Detail
  - GralFileSelector
```
public GralFileSelector(GralPos refPosParent,
                        java.lang.String posName,
                        GralWindow windFileSelector,
                        int rows,
                        int[] columns,
                        boolean bWithFavor,
                        java.lang.String sExecBtn,
                        GralViewFileContent fileViewer,
                        GralFileProperties wdgFileProperties)
```
    Creates a new instance of this comprehensive widget for file selection, search and viewing
    
    Parameters:
    
    refPosParent - Reference position for the whole spread for this comprehensive widget in a panel.
    
    posName - "@position=name" or "name", see GralWidget#GralWidget(String, char)
    
    rows - Number of rows intended to use for the file list (max length)
    
    columns - should have the form new int[]{2,0,-6,-12}, the width of field for size, datd can be justified. last is date (timestamp), before last is file size, first is mark. The 0 is the rest length of the file name. to do proportional determination?
    
    bWithFavor - true then a favor table is created, select favor. False: prevent this capability
    
    sExecBtn - if given then this widget contains a [exec] button for file-save action etc. with this text. The text can be changed also with #openDialog(FileRemote, String, String, GralUserAction)
    
    fileViewer - Instance of a file viewer (for content). It is possible to share one fileViewer to more instances of this.
    
    wdgFileProperties - maybe null, then this fuction is not available. Should be instantiated recommended by GralFileProperties.createWindow(GralPos, String, String) but maybe concurrently used for more as one GralFileSelector. The Key shows file properties and allows rename and change properties.
- Method Detail
  - setDateFormat
```
public void setDateFormat(java.lang.String sFormat)
```
    Maybe called after construction, should be called before #setToPanel(GralMngBuild_ifc)
    
    Parameters:
    
    name -
  - createGralFileSelectorWindow
```
public static GralFileSelector createGralFileSelectorWindow(GralMng mng,
                                                            boolean visible,
                                                            java.lang.String posName,
                                                            java.lang.String sExec,
                                                            java.util.List<GralFileSelector.FavorPath> favors)
```
    Parameters:
    
    mng - The GralMng is necessary because only the String given pos is used.
    
    posName -
    
    sExec - If given, it is the initial text for the [Exec] button, if null Ecec button is not present.
    
    favors - If given initial favors, at least an empty list. If null no favors possible.
    
    Returns:
  - getCurrentDirPath
```
public java.lang.String getCurrentDirPath()
```
    Creates the window to confirm search in files. This window can be created only one time for all file panels, if the application has more as one. On activating the directory and the file panel to show results should be given. But only one search process can be run simultaneously.
    
    Returns:
    
    The created window.
  - setOriginDir
```
public void setOriginDir(FileRemote dir)
```
  - setSortOrder
```
public void setSortOrder(char sortOrder)
```
    Sets the sort order of entries. Valid chars for 'sortOrder' are:
    - n: sort by name, case sensitive, A..Z a..z in ASCII order
    - N: sort by name, non case-sensitive, Aa..Zz, other characters in ASCII order but '_' first.
    - x: sort by extension, case sensitive. sort by names with equal extension, case sensitive
    - X: sort by extension, non case sensitive. sort by names with equal extension, non case sensitive
    - d: sort by timestamp, newest first
    - o: sort by timestamp, oldest first.
    - l: sort by size, largest first.
    - s: sort by size, smallest first.
    Parameters:
    
    sortOrder -
  - setActionOnFileSelected
```
public void setActionOnFileSelected(GralUserAction actionOnLineSelected)
```
    Sets an action which is called any time when another line in a file table is selected.
    
    Parameters:
    
    actionOnLineSelected - The action, null to switch off this functionality.
  - setActionOnEnterFile
```
public GralUserAction setActionOnEnterFile(GralUserAction newAction)
```
    Sets the action which is called if any file is entered. It means the Enter-Key is pressed or a mouse double-click is done on a file.
    
    Parameters:
    
    newAction - The action to use. The action is invoked with to do
    
    Returns:
    
    The current assigned action or null.
  - setActionOnSaveButton
```
public GralUserAction setActionOnSaveButton(GralUserAction newAction,
                                            java.lang.String textButton)
```
    Sets the action which is called if any file is entered. It means the Enter-Key is pressed or a mouse double-click is done on a file.
    
    Parameters:
    
    newAction - The action to use. The action is invoked with to do
    
    Returns:
    
    The current assigned action or null.
  - setActionOnFocusedFileTable
```
public void setActionOnFocusedFileTable(GralUserAction newAction)
```
    Sets the action which is called if any file is entered. It means the Enter-Key is pressed or a mouse double-click is done on a file.
    
    Parameters:
    
    newAction - The action to use. The action is invoked with to do
  - setActionOnEnterDirectory
```
public GralUserAction setActionOnEnterDirectory(GralUserAction newAction)
```
    This action will be called on pressing enter or mouse-click on a directory. Usual the directory can be entered and showed. But the user can do any other action. If this action returns false, the default behavior: enter the directory will be done.
  - setActionSaveFavors
```
public GralUserAction setActionSaveFavors(GralUserAction newAction)
```
    This action will be called on context menu for the Favor tab to save its content. It should be implemented at user level, for example save in a file. It is the opposite to addFavor(FavorPath) to fill the favor table.
  - setActionOnEnterPathNewFile
```
public GralUserAction setActionOnEnterPathNewFile(GralUserAction newAction)
```
    This action will be called on pressing enter or mouse-click on the path text field if it contains any text which can't assigned to an existing file.
  - setActionSetFileLineAttrib
```
public GralUserAction setActionSetFileLineAttrib(GralUserAction newAction)
```
    Sets the action which is called if any file is set to the table.
    
    Parameters:
    
    newAction - The action to use. The action is invoked with to do
    
    Returns:
    
    The current assigned action or null.
  - clear
```
public void clear()
```
  - addFavor
```
public GralTableLine_ifc<GralFileSelector.FavorPath> addFavor(GralFileSelector.FavorPath favorPathInfo)
```
    Adds a line to this table.
    
    Parameters:
    
    ix - Show which index is used for a local table, 0..2 for left, mid, right, than show the label in the left cell (column)
    
    favorPathInfo - The favorite info
  - addFavor
```
public void addFavor(java.util.List<GralFileSelector.FavorPath> list)
```
  - add
```
public GralTableLine_ifc<GralFileSelector.FavorPath> add(java.lang.String name,
                                                         java.lang.String path)
```
  - openDialog
```
public void openDialog(FileRemote startFile,
                       java.lang.String sTitle,
                       java.lang.String sBtnText,
                       GralUserAction actionEnter,
                       GralUserAction actionButton)
```
    Prepares the action and appearance and shows the window or the widget (get visible). The param actionSelect is called if the user presses the [Exec] Button on right top, it is #widgBtnExec. The button is marked with "select" or "write" depending on the param bForWrite. For actionSelect the method GralUserAction.exec(int, GralWidget_ifc, Object...) is called with null for the widget (a widget should not necessary for the user) but with the selected File(s) as Object parameter. If one file is selected the first Object is instanceof File. If more as one files are selected a List or File[] is provided. The user should check this type.
    
    Parameters:
    
    startDir -
    
    sTitle - shown in title bar of the window
    
    bForWrite - true then the name field is editable and "Save" is shown on button. False then the name Field is readonly and "select" is shown on button
    
    actionSelect - Action which is called on Button ok. The first Object of exec(...,object) is the selected File or a File[] or List if more as one file is selected.
  - closeDialog
```
public void closeDialog()
```
  - fillFavorPaths
```
public void fillFavorPaths(java.util.List<GralFileSelector.FavorPath> listfavorPaths)
```
    Add all favor paths from the SelectTab newly
    
    Parameters:
    
    favorTabInfo -
  - fillInOriginDir
```
public void fillInOriginDir()
```
    Fills the content with the first directory or the directory which was set with #setOriginDir(File).
  - fillInCurrentDir
```
public void fillInCurrentDir()
```
    It is the refresh operation. If #fillinPending is set yet this operation does nothing. It means it is possible to call in a short cycle more as one time after another, for example for all files of a directory without calculation effort.
  - fillIn
```
protected void fillIn(java.util.List<java.io.File> files)
```
  - forcefillIn
```
public void forcefillIn(FileRemote fileIn,
                        boolean bDonotRefrehs)
```
  - fillIn
```
public void fillIn(FileRemote fileIn,
                   boolean bDonotRefrehs)
```
    Fills the content with given directory. If the same directory was refreshed in a short time before, it is not refreshed here. That is while fast navigation in a tree.
    
    Parameters:
    
    fileIn - The directory which's files are shown or a file in this directory. If it is a file this line is marked. Elsewhere that line is marked which's file is found in #idxSelectFileInDir due to the fileIn directory.
    
    bDonotRefrehs - false then invoke an extra thread to walk through the file system, see @FileRemote#refreshPropertiesAndChildren(FileRemoteWalkerCallback) and #callbackChildren1. On any file showFile(FileRemote) is called in the file thread which fills the table lines. On done event finishShowFileTable() is called in the file thread. If true then it is presumed that the FileRemote children are refreshed in the last time already. The fill the table newly with given content in this thread.
  - showFile
```
void showFile(FileRemote file1)
```
    This routine is invoked in callback of #callbackChildren1 for fillIn(FileRemote, boolean) in the refresh thread.
    
    Parameters:
    
    file1 -
  - finishShowFileTable
```
void finishShowFileTable()
```
    Finishes a newly showed file table. Removes all lines which have the #colorBackPending yet, they are not refreshed because that files don't exist furthermore. Gets the currentFile() of this table from the #idxSelectFileInDir if the currentFile() is null, sets the current line and repaint the table.
  - completeLine
```
private void completeLine(GralTableLine_ifc<FileRemote> tline,
                          FileRemote file,
                          long timeNow)
```
  - buildKey
```
protected java.lang.String buildKey(FileRemote file,
                                    boolean bAllCompleteWithFileInfoP,
                                    java.lang.String[] retSortName)
```
  - refresh
```
public void refresh()
```
    Refreshes the content especially after change as copy, delete etc.
  - checkRefresh
```
public void checkRefresh(long since)
```
    Refreshes cyclically
    
    Parameters:
    
    since -
  - getLabelCurrFavor
```
public java.lang.String getLabelCurrFavor()
```
  - XXXgetSelectedFile
```
public java.io.File XXXgetSelectedFile()
```
    Gets the selected file from this panel.
    
    Returns:
    
    null if no line is selected, for example if the panel isn't used yet.
  - getSelectedFiles
```
public java.util.List<FileRemote> getSelectedFiles(boolean bAlsoDirs,
                                                   int mask)
```
    Gets the selected file from this panel. If the current file of this panel is marked, then all other marked files and directories of this panel are returned too. If the current file is not marked, then only this current file is returned as selected file. This behavior assures, that the one file in focus is returned and not some files which are marked outside of the own focus. That prevents an unexpected behavior from the user's view occurs. Hence, if you want to handle some marked files you should select on of these marked files. If the user selects a marked file, then one should be sure that there are other marked files in non visible areas too.
    
    Parameters:
    
    bAlsoDirs - false then returns never a directory. If the current selected file is a directory then return null.
    
    Returns:
    
    null if no line is selected, for example if the panel isn't used yet. If the current file is non-marked, then returns a list of only 1 element, that current file. If the current file is marked, return all marked files.
  - selectFile
```
public boolean selectFile(java.lang.String name)
```
    Selects the file with the given name in the table
    
    Parameters:
    
    name - name of file like it is shown in the table (given as key).
    
    Returns:
    
    true if found and selected.
  - currentFile
```
public FileRemote currentFile()
```
    Gets the current selected file. Note: If the .. is selected, the current file is the parent directory. If any directory is selected, this is the currentFile(). Check with File.isDirectory().
  - currentDir
```
public FileRemote currentDir()
```
    Gets the directory which is currently shown. Note: If the .. is selected, the current directory is the directory where the .. is located, whereby the currentFile() is the parent. Elsewhere this method returns the parent of currentFile().
  - getCurrentDir
```
public FileRemote getCurrentDir()
```
    same as currentDir().
  - setFocus
```
public void setFocus()
```
    Sets the focus of the associated table widget.
  - setFocus
```
public void setFocus(int delay,
                     int latest)
```
  - isInFocus
```
public boolean isInFocus()
```
    Description copied from interface: GralWidgetBase_ifc
    
    Returns true if this widget is the focused one.
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: GralWidgetBase_ifc
    
    Returns whether the widget is visible or not. This method can be invoked in any thread. It is an estimation because the state of the widget may be changed in the last time or a window can be covered by another one. The widget is not visible if it is a member of a card in a tabbed panel and that tab is not the selected one.
    
    Specified by:
    
    isVisible in interface GralWidgetBase_ifc
    
    Overrides:
    
    isVisible in class GralWidgetBase
    
    Returns:
    
    true if the widget seams to be visible.
  - setVisible
```
public boolean setVisible(boolean visible)
```
    Description copied from interface: GralWidgetBase_ifc
    
    Sets this widget visible on graphic or invisible. Any widget can be visible or not. More as one widgets can use the same position, only one of them may set visible. For a GralWindow, its the visibility of the whole window. Note that a window which is invisible is not shown in the task bar of the operation system. Note that an application can have more as one window. Note that a dialog window can be set to invisible if it is not need yet instead destroy and build newly.
    
    Specified by:
    
    setVisible in interface GralWidgetBase_ifc
    
    Specified by:
    
    setVisible in class GralWidgetBase
    
    Returns:
  - stop
```
void stop()
```
  - remove
```
public boolean remove()
```
    Description copied from class: GralWidgetBase
    
    Removes the widget from the lists in its panel and from the graphical representation. If the graphic implementation is given, then GralWidgImplAccess_ifc.removeWidgetImplementation() is called which is overridden in the graphic implementation sources in a specific kind (SWT: for example SwtTextFieldWrapper.removeWidgetImplementation()) It calls the protected GralWidgetBase.GralWidgComposite.removeWidget(GralWidgetBase) and also GralMng.deregisterWidgetName(GralWidgetBase).
    
    Overrides:
    
    remove in class GralWidgetBase
  - setFocusedWidget
```
public void setFocusedWidget(GralWidgetBase_ifc widg)
```
    Description copied from interface: GralWidgetBase_ifc
    
    If this widget is a comprehensive widget or a panel, it sets one of the content as focused.
    
    Parameters:
    
    widg - The sub widget which should be focused. It influences for example the current tab of a tabbed panel, or influences which widget of a comprehensive widget is first focused. On a panel it determines which widget should get the focus if the panel gets the focus.
  - getFocusedWidget
```
public GralWidgetBase_ifc getFocusedWidget()
```
    Description copied from interface: GralWidgetBase_ifc
    
    Returns the widget which is in focus of a panel or comprehensive widget. This allows quests about the status of the widget, for example the opened tab on a tabbed panel of which is in use currently from a comprehensive widget.
  - selectFileTable
```
public void selectFileTable(java.lang.String sFavor,
                            FileRemote startFile)
```
  - doFileLineSelect
```
void doFileLineSelect(GralTable.TableLineData line)
```
  - doActionGetFileName
```
protected void doActionGetFileName(int key,
                                   GralWidget_ifc widgd,
                                   java.lang.Object... params)
```
    Copies the name of the current selected file as file name into the #widgPathDir as presetting for save, rename etc.
    
    Parameters:
    
    key - unused
    
    widgd - The widget where the command was invoked from
    
    params - unused
  - doActionExec
```
protected void doActionExec(int key,
                            GralWidget_ifc widgd,
                            java.lang.Object... params)
```
  - doActionSelectFileTableFromFavor
```
public void doActionSelectFileTableFromFavor()
```
    Called from click on line in favor table to select this favor and show the adequate file table.
  - selectFileTableFromFavor
```
protected void selectFileTableFromFavor(GralFileSelector.FavorPath favor,
                                        FileRemote fileStart)
```
    Called either from tab selection or from a line in the favor table (doActionSelectFileTableFromFavor().
    
    Parameters:
    
    favor - The favor of the tab or line.
  - doActivateFavor
```
public void doActivateFavor()
```
    Activates the favor card. If a file on file card was selected before, its path is stored in the favor table as current one calling updateFavorWithCurrentDir()
  - setNewDirFile
```
void setNewDirFile(java.lang.String sPathP)
```
  - updateFavorWithCurrentDir
```
protected void updateFavorWithCurrentDir()
```
    Updates the current favor with the current file table's directory path. This is called both on activate the favor table, and also on activating another favor in the tabs via #widgFavorTabs.
  - showFileInfo
```
protected void showFileInfo(GralTable.TableLineData line)
```
    If given in ctor, opens the file property window and show file properties.
    
    Parameters:
    
    line - The line in fileTable
  - actionUserKey
```
public boolean actionUserKey(int keyCode,
                             java.lang.Object userDataOfLine,
                             GralTableLine_ifc<FileRemote> line)
```
    This method is called on any user key or mouse event while operating in the file table. It should be overwritten by a derived class. This routine is empty.
    
    Parameters:
    
    key - code or mouse code, one of constants from KeyCode.
    
    userDataOfLine - The user data stored in the line of table.
    
    line - The table line.
    
    Returns:
    
    true if is was relevant for the key.

Class GralFileSelector

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.gral.base.GralWidgetBase

Field Summary

Fields inherited from class org.vishia.gral.base.GralWidgetBase

Constructor Summary

Method Summary

Methods inherited from class org.vishia.gral.base.GralWidgetBase

Methods inherited from class java.lang.Object

Field Detail

sVersion

windSearch

contextMenuTexts

idata

gui

evSrc

fillinEv

action

Constructor Detail

GralFileSelector

Method Detail

setDateFormat

createGralFileSelectorWindow

getCurrentDirPath

setOriginDir

setSortOrder

setActionOnFileSelected

setActionOnEnterFile

setActionOnSaveButton

setActionOnFocusedFileTable

setActionOnEnterDirectory

setActionSaveFavors

setActionOnEnterPathNewFile

setActionSetFileLineAttrib

clear

addFavor

addFavor

add

openDialog

closeDialog

fillFavorPaths

fillInOriginDir

fillInCurrentDir

fillIn

forcefillIn

fillIn

showFile

finishShowFileTable

completeLine

buildKey

refresh

checkRefresh

getLabelCurrFavor

XXXgetSelectedFile

getSelectedFiles

selectFile

currentFile

currentDir

getCurrentDir

setFocus

setFocus

isInFocus

isVisible

setVisible

stop

remove

setFocusedWidget

getFocusedWidget

selectFileTable

doFileLineSelect

doActionGetFileName

doActionExec

doActionSelectFileTableFromFavor

selectFileTableFromFavor

doActivateFavor

setNewDirFile

updateFavorWithCurrentDir

showFileInfo

actionUserKey