Package snap.viewx

Class WebSitePane

java.lang.Object

snap.props.PropObject

snap.view.ViewOwner

snap.viewx.WebSitePane

All Implemented Interfaces:

PropChange.DoChange

Direct Known Subclasses:

RecentFilesSitePane, WebSitePaneX

public class WebSitePane
extends ViewOwner

This class is the base class for WebSite open/save browsers.

Field Summary

Fields

Modifier and Type	Field	Description
protected EventListener	_actionHandler
protected boolean	_saving
protected WebFile	_selFile
protected WebSite	_site
protected WebFile	_targFile
protected String[]	_types
static final String	SelFile_Prop
static final String	TargFile_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
WebSitePane()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	fireActionEvent(ViewEvent anEvent)	Called on FileBrowser double-click or InputText enter key.
EventListener	getActionHandler()	Returns the listener triggered when action event is fired.
protected WebFile	getDefaultSelFile()	Resets the selected file.
Predicate<WebFile>	getFileValidator()	Returns the function that determines whether file can be selected.
WebFile	getSelDir()	Returns the selected directory.
WebFile	getSelFile()	Returns the selected file.
WebSite	getSite()	Returns the site currently being browsed.
WebFile	getTargFile()	Returns the file targeted by the input text.
String[]	getTypes()	Returns the file types.
WebFile	getValidSelOrTargFile()	Returns the selected or targeted file if valid.
boolean	isOpening()	Returns whether is opening.
boolean	isSaving()	Returns whether is saving.
boolean	isValidFile(WebFile aFile)	Returns whether given file is valid.
protected void	resetFilesUI()	Called when Showing changes.
void	setActionHandler(EventListener actionListener)	Sets the listener triggered when action event is fired.
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)	Sets the selected file or directory.
protected void	setShowing(boolean aValue)	Override to reset files UI when showing.
void	setSite(WebSite aSite)	Sets the site for the panel.
protected void	setSiteFilesInUI()	Called to set the WebFiles in UI.
void	setTargFile(WebFile aFile)	Sets the file targeted by the input text.
void	setTypes(String... theExts)	Sets the file types.

Methods inherited from class snap.view.ViewOwner

addKeyActionFilter, addKeyActionHandler, addViewEventHandler, beep, cancelReset, createUI, 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, initUI, initWindow, invokeResetUI, invokeRespondUI, isEventThread, isSendEventDisabled, isShowing, isUISet, isViewDisabled, isViewEnabled, isViewVisible, isWindowSet, isWindowVisible, requestFocus, resetLater, resetUI, respondUI, runDelayed, runLater, setFirstFocus, setSendEventDisabled, 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

_site

protected WebSite _site

_selFile

protected WebFile _selFile

_targFile

protected WebFile _targFile

_saving

protected boolean _saving

_types

protected String[] _types

_actionHandler

protected EventListener _actionHandler

SelFile_Prop

public static final String SelFile_Prop

See Also:

• Constant Field Values

TargFile_Prop

public static final String TargFile_Prop

See Also:

• Constant Field Values

Constructor Details

WebSitePane

public WebSitePane()

Constructor.

Method Details

getSite

public WebSite getSite()

Returns the site currently being browsed.

setSite

public void setSite(WebSite aSite)

Sets the site for the panel.

getSelFile

public WebFile getSelFile()

Returns the selected file.

setSelFile

public void setSelFile(WebFile aFile)

Sets the selected file or directory.

getSelDir

public WebFile getSelDir()

Returns the selected directory.

getTargFile

public WebFile getTargFile()

Returns the file targeted by the input text.

setTargFile

public void setTargFile(WebFile aFile)

Sets the file targeted by the input text.

getValidSelOrTargFile

public WebFile getValidSelOrTargFile()

Returns the selected or targeted file if valid.

isOpening

public boolean isOpening()

Returns whether is opening.

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 listener triggered when action event is fired.

setActionHandler

public void setActionHandler(EventListener actionListener)

Sets the listener triggered when action event is fired.

isValidFile

public boolean isValidFile(WebFile aFile)

Returns whether given file is valid.

fireActionEvent

protected void fireActionEvent(ViewEvent anEvent)

Called on FileBrowser double-click or InputText enter key.

setShowing

protected void setShowing(boolean aValue)

Override to reset files UI when showing.

Overrides:

setShowing in class ViewOwner

resetFilesUI

protected void resetFilesUI()

Called when Showing changes.

getDefaultSelFile

protected WebFile getDefaultSelFile()

Resets the selected file.

setSiteFilesInUI

protected void setSiteFilesInUI()

Called to set the WebFiles in UI.