Package org.apache.hop.ui.core.vfs

Class HopVfsFileDialog

java.lang.Object

org.apache.hop.ui.core.vfs.HopVfsFileDialog

All Implemented Interfaces:

IDirectoryDialog, IFileDialog

@GuiPlugin(description="Allows you to browse to local or VFS locations")
public class HopVfsFileDialog
extends Object
implements IFileDialog, IDirectoryDialog

Field Summary

Fields

Modifier and Type	Field	Description
static String	BOOKMARKS_AUDIT_TYPE
static String	BOOKMARKS_TOOLBAR_PARENT_ID
static String	BROWSER_TOOLBAR_PARENT_ID
static String	DIALOG_STATE_NAME
static String	DIALOG_STATE_TYPE
static String	DIALOG_STATE_VALUE_SORT_ASCENDING
static String	DIALOG_STATE_VALUE_SORT_INDEX
static String	NAVIGATE_TOOLBAR_PARENT_ID

Constructor Summary

Constructors

Constructor	Description
HopVfsFileDialog()
HopVfsFileDialog(org.eclipse.swt.widgets.Shell parent, IVariables variables, org.apache.commons.vfs2.FileObject fileObject, boolean browsingDirectories, boolean savingFile)

Method Summary

Modifier and Type	Method	Description
void	addBookmark()
void	browseToSelectedBookmark()
void	createFolder()
void	deleteFile()
org.apache.commons.vfs2.FileObject	getActiveFileObject()	Gets activeFileObject
org.apache.commons.vfs2.FileObject	getActiveFolder()	Gets activeFolder
Map<String,String>	getBookmarks()	Gets bookmarks
String	getFileName()	Gets fileName
String[]	getFilterExtensions()	Gets filterExtensions
String[]	getFilterNames()	Gets filterNames
String	getFilterPath()	Gets filterPath
static HopVfsFileDialog	getInstance()	Gets the active instance of this dialog
String	getMessage()	Gets message
String	getSaveFilename()	Gets saveFilename
String	getText()	Gets text
IVariables	getVariables()	Gets variables
boolean	isBrowsingDirectories()	Gets browsingDirectories
boolean	isSavingFile()	Gets savingFile
boolean	isShowingHiddenFiles()	Gets showingHiddenFiles
void	navigateHistoryNext()
void	navigateHistoryPrevious()
void	navigateHome()
void	navigateTo(String filename, boolean saveHistory)
void	navigateUp()
String	open()
void	refreshAll()
void	removeBookmark()
void	renameFile()
void	setActiveFileObject(org.apache.commons.vfs2.FileObject activeFileObject)
void	setActiveFolder(org.apache.commons.vfs2.FileObject activeFolder)
void	setBookmarks(Map<String,String> bookmarks)
void	setBrowsingDirectories(boolean browsingDirectories)
void	setFileName(String fileName)
void	setFilterExtensions(String[] filterExtensions)
void	setFilterNames(String[] filterNames)
void	setFilterPath(String filterPath)
void	setMessage(String message)
void	setSaveFilename(String saveFilename)
void	setSavingFile(boolean savingFile)
void	setShowingHiddenFiles(boolean showingHiddenFiles)
void	setText(String text)
void	setVariables(IVariables variables)
void	showHideHidden()
void	updateSelection()

Methods inherited from class java.lang.Object

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

Field Detail

BOOKMARKS_AUDIT_TYPE

public static final String BOOKMARKS_AUDIT_TYPE

See Also:

Constant Field Values

DIALOG_STATE_TYPE

public static final String DIALOG_STATE_TYPE

See Also:

Constant Field Values

DIALOG_STATE_NAME

public static final String DIALOG_STATE_NAME

See Also:

Constant Field Values

DIALOG_STATE_VALUE_SORT_INDEX

public static final String DIALOG_STATE_VALUE_SORT_INDEX

See Also:

Constant Field Values

DIALOG_STATE_VALUE_SORT_ASCENDING

public static final String DIALOG_STATE_VALUE_SORT_ASCENDING

See Also:

Constant Field Values

BOOKMARKS_TOOLBAR_PARENT_ID

public static final String BOOKMARKS_TOOLBAR_PARENT_ID

See Also:

Constant Field Values

NAVIGATE_TOOLBAR_PARENT_ID

public static final String NAVIGATE_TOOLBAR_PARENT_ID

See Also:

Constant Field Values

BROWSER_TOOLBAR_PARENT_ID

public static final String BROWSER_TOOLBAR_PARENT_ID

See Also:

Constant Field Values

Constructor Detail

HopVfsFileDialog

public HopVfsFileDialog()

HopVfsFileDialog

public HopVfsFileDialog(org.eclipse.swt.widgets.Shell parent,
                        IVariables variables,
                        org.apache.commons.vfs2.FileObject fileObject,
                        boolean browsingDirectories,
                        boolean savingFile)

Method Detail

getInstance

public static HopVfsFileDialog getInstance()

Gets the active instance of this dialog

Returns:

value of instance

open

public String open()

Specified by:

open in interface IDirectoryDialog

Specified by:

open in interface IFileDialog

setMessage

public void setMessage(String message)

Specified by:

setMessage in interface IDirectoryDialog

browseToSelectedBookmark

public void browseToSelectedBookmark()

addBookmark

@GuiToolbarElement(root="HopVfsFileDialog-BookmarksToolbar",
                   id="0010-bookmark-add",
                   toolTip="i18n::HopVfsFileDialog.AddBookmark.Tooltip.Message",
                   image="ui/images/bookmark-add.svg")
public void addBookmark()

removeBookmark

@GuiToolbarElement(root="HopVfsFileDialog-BookmarksToolbar",
                   id="0030-bookmark-remove",
                   toolTip="i18n::HopVfsFileDialog.RemoveBookmark.Tooltip.Message",
                   image="ui/images/delete.svg")
public void removeBookmark()

navigateTo

public void navigateTo(String filename,
                       boolean saveHistory)

navigateHome

@GuiToolbarElement(root="HopVfsFileDialog-NavigateToolbar",
                   id="0000-navigate-home",
                   toolTip="i18n::HopVfsFileDialog.NavigateToHome.Tooltip.Message",
                   image="ui/images/home.svg")
public void navigateHome()

refreshAll

@GuiToolbarElement(root="HopVfsFileDialog-NavigateToolbar",
                   id="9999-refresh-all",
                   toolTip="i18n::HopVfsFileDialog.Refresh.Tooltip.Message",
                   image="ui/images/refresh.svg")
public void refreshAll()

navigateUp

@GuiToolbarElement(root="HopVfsFileDialog-NavigateToolbar",
                   id="0010-navigate-up",
                   toolTip="i18n::HopVfsFileDialog.NavigateToParent.Tooltip.Message",
                   image="ui/images/navigate-up.svg")
public void navigateUp()

createFolder

@GuiToolbarElement(root="HopVfsFileDialog-BrowserToolbar",
                   id="0020-create-folder",
                   toolTip="i18n::HopVfsFileDialog.CreateFolder.Tooltip.Message",
                   image="ui/images/folder-add.svg")
public void createFolder()

renameFile

@GuiToolbarElement(root="HopVfsFileDialog-BrowserToolbar",
                   id="0110-rename",
                   toolTip="i18n::HopVfsFileDialog.RenameFile.Tooltip.Message",
                   image="ui/images/rename.svg")
@GuiKeyboardShortcut(key=16777227)
@GuiOsxKeyboardShortcut(key=16777227)
public void renameFile()

deleteFile

@GuiToolbarElement(root="HopVfsFileDialog-BrowserToolbar",
                   id="0100-delete",
                   toolTip="i18n::HopVfsFileDialog.DeleteFile.Tooltip.Message",
                   image="ui/images/delete.svg")
@GuiKeyboardShortcut(key=127)
@GuiOsxKeyboardShortcut(key=127)
public void deleteFile()

navigateHistoryPrevious

@GuiToolbarElement(root="HopVfsFileDialog-NavigateToolbar",
                   id="0100-navigate-previous",
                   toolTip="i18n::HopVfsFileDialog.NavigateToPrevPath.Tooltip.Message",
                   image="ui/images/navigate-back.svg",
                   separator=true)
public void navigateHistoryPrevious()

navigateHistoryNext

@GuiToolbarElement(root="HopVfsFileDialog-NavigateToolbar",
                   id="0110-navigate-next",
                   toolTip="i18n::HopVfsFileDialog.NavigateToNextPath.Tooltip.Message",
                   image="ui/images/navigate-forward.svg")
public void navigateHistoryNext()

showHideHidden

@GuiToolbarElement(root="HopVfsFileDialog-BrowserToolbar",
                   id="0200-show-hidden",
                   toolTip="i18n::HopVfsFileDialog.ShowHiddenFiles.Tooltip.Message",
                   image="ui/images/hide.svg",
                   separator=true)
public void showHideHidden()

getText

public String getText()

Gets text

Returns:

value of text

setText

public void setText(String text)

Specified by:

setText in interface IDirectoryDialog

Specified by:

setText in interface IFileDialog

Parameters:

text - The text to set

getVariables

public IVariables getVariables()

Gets variables

Returns:

value of variables

setVariables

public void setVariables(IVariables variables)

Parameters:

variables - The variables to set

getFileName

public String getFileName()

Gets fileName

Specified by:

getFileName in interface IFileDialog

Returns:

value of fileName

setFileName

public void setFileName(String fileName)

Specified by:

setFileName in interface IFileDialog

Parameters:

fileName - The fileName to set

getFilterExtensions

public String[] getFilterExtensions()

Gets filterExtensions

Returns:

value of filterExtensions

setFilterExtensions

public void setFilterExtensions(String[] filterExtensions)

Specified by:

setFilterExtensions in interface IFileDialog

Parameters:

filterExtensions - The filterExtensions to set

getFilterNames

public String[] getFilterNames()

Gets filterNames

Returns:

value of filterNames

setFilterNames

public void setFilterNames(String[] filterNames)

Specified by:

setFilterNames in interface IFileDialog

Parameters:

filterNames - The filterNames to set

getBookmarks

public Map<String,String> getBookmarks()

Gets bookmarks

Returns:

value of bookmarks

setBookmarks

public void setBookmarks(Map<String,String> bookmarks)

Parameters:

bookmarks - The bookmarks to set

getActiveFileObject

public org.apache.commons.vfs2.FileObject getActiveFileObject()

Gets activeFileObject

Returns:

value of activeFileObject

setActiveFileObject

public void setActiveFileObject(org.apache.commons.vfs2.FileObject activeFileObject)

Parameters:

activeFileObject - The activeFileObject to set

getActiveFolder

public org.apache.commons.vfs2.FileObject getActiveFolder()

Gets activeFolder

Returns:

value of activeFolder

setActiveFolder

public void setActiveFolder(org.apache.commons.vfs2.FileObject activeFolder)

Parameters:

activeFolder - The activeFolder to set

getFilterPath

public String getFilterPath()

Gets filterPath

Specified by:

getFilterPath in interface IDirectoryDialog

Specified by:

getFilterPath in interface IFileDialog

Returns:

value of filterPath

setFilterPath

public void setFilterPath(String filterPath)

Specified by:

setFilterPath in interface IDirectoryDialog

Specified by:

setFilterPath in interface IFileDialog

Parameters:

filterPath - The filterPath to set

isShowingHiddenFiles

public boolean isShowingHiddenFiles()

Gets showingHiddenFiles

Returns:

value of showingHiddenFiles

setShowingHiddenFiles

public void setShowingHiddenFiles(boolean showingHiddenFiles)

Parameters:

showingHiddenFiles - The showingHiddenFiles to set

getMessage

public String getMessage()

Gets message

Returns:

value of message

isBrowsingDirectories

public boolean isBrowsingDirectories()

Gets browsingDirectories

Returns:

value of browsingDirectories

setBrowsingDirectories

public void setBrowsingDirectories(boolean browsingDirectories)

Parameters:

browsingDirectories - The browsingDirectories to set

isSavingFile

public boolean isSavingFile()

Gets savingFile

Returns:

value of savingFile

setSavingFile

public void setSavingFile(boolean savingFile)

Parameters:

savingFile - The savingFile to set

getSaveFilename

public String getSaveFilename()

Gets saveFilename

Returns:

value of saveFilename

setSaveFilename

public void setSaveFilename(String saveFilename)

Parameters:

saveFilename - The saveFilename to set

updateSelection

public void updateSelection()