Package snap.viewx

Class FilePanel

java.lang.Object

snap.props.PropObject

snap.view.ViewOwner

snap.viewx.FilePanel

All Implemented Interfaces:

PropChange.DoChange

public class FilePanel
extends ViewOwner

A class to select a file to open or save.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SelFile_Prop
static final String	SelSite_Prop

Fields inherited from class snap.view.ViewOwner

Action, DragDrop, DragEnter, DragEvents, DragExit, DragGesture, DragOver, KeyEvents, KeyPress, KeyRelease, KeyType, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Showing_Prop, WinClose

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
FilePanel()	Constructor.

Method Summary

Modifier and Type	Method	Description
static void	addDefaultSite(WebSite aSite)	Adds a site.
protected void	addNewFolderButton()	Adds a new Folder button.
void	addSite(WebSite aSite)	Adds a site available to open/save files.
protected View	createUI()	Override to return FileBrowser UI.
protected void	fireActionEvent(ViewEvent anEvent)	Called on FileBrowser double-click or InputText enter key.
EventListener	getActionHandler()	Returns the action event listener.
static WebSite[]	getDefaultSites()	Returns the sites.
Predicate<WebFile>	getFileValidator()	Returns the function that determines whether file can be selected.
WebFile	getSelFile()	Returns the selected file.
WebFile	getSelFileAndAddToRecentFiles()	Returns the selected file and adds it to recent files.
WebSite	getSelSite()	Returns the site currently being browsed.
WebSitePane	getSelSitePane()	Returns the current selected site pane.
WebSite[]	getSites()	Return sites available to open/save files.
String[]	getTypes()	Returns the file types.
protected void	initUI()	Initialize UI.
boolean	isSaving()	Returns whether is saving.
static void	removeDefaultSite(WebSite aSite)	Removes a site.
void	removeSite(WebSite aSite)	Removes a site available to open/save files.
protected void	respondUI(ViewEvent anEvent)	Respond UI.
void	setActionHandler(EventListener actionHandler)	Sets the action event listener.
void	setDesc(String aValue)	Sets the description.
void	setFileValidator(Predicate<WebFile> fileValidator)	Sets the function that determines whether file can be selected.
void	setSaving(boolean aValue)	Sets whether is saving.
void	setSelFile(WebFile aFile)	Returns the selected file.
void	setSelSite(WebSite aSite)	Sets the site currently being browsed.
void	setTypes(String... theExts)	Sets the file types.
WebFile	showFilePanel(View aView)	Runs a file chooser that remembers last open file and size.
static WebFile	showOpenFilePanel(View aView, String aDesc, String... theTypes)	Shows an Open panel for given description and types.
static String	showOpenPanel(View aView, String aDesc, String... theTypes)	Shows an Open panel for given description and types.
static WebFile	showSaveFilePanel(View aView, String aDesc, String... theTypes)	Shows a Save panel for given description and types.
static String	showSavePanel(View aView, String aDesc, String... theTypes)	Shows a Save panel for given description and types.

Methods inherited from class snap.view.ViewOwner

addKeyActionFilter, addKeyActionHandler, addViewEventHandler, beep, cancelReset, createUIForClass, dispatchEventToOwner, enableEvents, fireActionEventForObject, getEnv, getFirstFocus, getImage, getNative, getToggleGroup, getUI, getUI, getUISource, getView, getView, getViewBoolValue, getViewFloatValue, getViewIntValue, getViewItems, getViewSelIndex, getViewSelItem, getViewStringValue, getViewText, getViewValue, getWindow, initShowing, initWindow, invokeResetUI, invokeRespondUI, isEventThread, isSendEventDisabled, isShowing, isUISet, isViewDisabled, isViewEnabled, isViewVisible, isWindowSet, isWindowVisible, requestFocus, resetLater, resetUI, runDelayed, runLater, setFirstFocus, setSendEventDisabled, setShowing, setViewDisabled, setViewEnabled, setViewItems, setViewItems, setViewSelIndex, setViewSelItem, setViewText, setViewValue, setViewVisible, setWindowVisible

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, clone, firePropChange, firePropChange, firePropChange, getPropDefault, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, getPropValue, initProps, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropsString, setPropValue, setPropValues, toString, toStringProps

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SelFile_Prop

public static final String SelFile_Prop

See Also:

• Constant Field Values

SelSite_Prop

public static final String SelSite_Prop

See Also:

• Constant Field Values

Constructor Details

FilePanel

public FilePanel()

Constructor.

Method Details

isSaving

public boolean isSaving()

Returns whether is saving.

setSaving

public void setSaving(boolean aValue)

Sets whether is saving.

getFileValidator

public Predicate<WebFile> getFileValidator()

Returns the function that determines whether file can be selected.

setFileValidator

public void setFileValidator(Predicate<WebFile> fileValidator)

Sets the function that determines whether file can be selected.

getTypes

public String[] getTypes()

Returns the file types.

setTypes

public void setTypes(String... theExts)

Sets the file types.

getActionHandler

public EventListener getActionHandler()

Returns the action event listener.

setActionHandler

public void setActionHandler(EventListener actionHandler)

Sets the action event listener.

setDesc

public void setDesc(String aValue)

Sets the description.

getSites

public WebSite[] getSites()

Return sites available to open/save files.

addSite

public void addSite(WebSite aSite)

Adds a site available to open/save files.

removeSite

public void removeSite(WebSite aSite)

Removes a site available to open/save files.

getSelSite

public WebSite getSelSite()

Returns the site currently being browsed.

setSelSite

public void setSelSite(WebSite aSite)

Sets the site currently being browsed.

getSelFile

public WebFile getSelFile()

Returns the selected file.

setSelFile

public void setSelFile(WebFile aFile)

Returns the selected file.

getSelFileAndAddToRecentFiles

public WebFile getSelFileAndAddToRecentFiles()

Returns the selected file and adds it to recent files.

showFilePanel

public WebFile showFilePanel(View aView)

Runs a file chooser that remembers last open file and size.

createUI

protected View createUI()

Override to return FileBrowser UI.

Overrides:

createUI in class ViewOwner

initUI

protected void initUI()

Initialize UI.

Overrides:

initUI in class ViewOwner

respondUI

protected void respondUI(ViewEvent anEvent)

Respond UI.

Overrides:

respondUI in class ViewOwner

fireActionEvent

protected void fireActionEvent(ViewEvent anEvent)

Called on FileBrowser double-click or InputText enter key.

getSelSitePane

public WebSitePane getSelSitePane()

Returns the current selected site pane.

addNewFolderButton

protected void addNewFolderButton()

Adds a new Folder button.

showOpenPanel

public static String showOpenPanel(View aView,
 String aDesc,
 String... theTypes)

Shows an Open panel for given description and types.

showSavePanel

public static String showSavePanel(View aView,
 String aDesc,
 String... theTypes)

Shows a Save panel for given description and types.

showOpenFilePanel

public static WebFile showOpenFilePanel(View aView,
 String aDesc,
 String... theTypes)

Shows an Open panel for given description and types.

showSaveFilePanel

public static WebFile showSaveFilePanel(View aView,
 String aDesc,
 String... theTypes)

Shows a Save panel for given description and types.

getDefaultSites

public static WebSite[] getDefaultSites()

Returns the sites.

addDefaultSite

public static void addDefaultSite(WebSite aSite)

Adds a site.

removeDefaultSite

public static void removeDefaultSite(WebSite aSite)

Removes a site.