projectviewer.config

Class ProjectViewerConfig

java.lang.Object

projectviewer.config.ProjectViewerConfig

public final class ProjectViewerConfig
extends java.lang.Object

Class to hold configuration information for the plugin.

Note about property changing events: currently, these events are only generated for the properties regarding the ProjectViewer GUI (that is, SHOW_FOLDERS_OPT, SHOW_FILES_OPT, SHOW_WFILES_OPT, USER_CONTEXT_MENU and USER_MENU_FIRST).If the change of another property needs to be notified to someone, please include the call to the appropriate "firePropertyChanged" method is the setter methods of the property.

Also of note is that these events are for internal ProjectViewer use and are not meant to be used by other plugins interfacing with PV.

Author:

Marcelo Vanzin

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_HIDDEN
static int	ASK_ALWAYS
static java.lang.String	ASK_IMPORT_OPT
static int	ASK_NEVER
static int	ASK_ONCE
static int	AUTO_IMPORT
static java.lang.String	BROWSER_PATH_OPT
static java.lang.String	BROWSER_USE_INFOVIEWER
static java.lang.String	CASE_INSENSITIVE_SORT_OPT
static java.lang.String	CLOSE_FILES_OPT
static java.lang.String	CONFIG_FILE
static java.lang.String	DELETE_NOT_FOUND_FILES_OPT
static java.lang.String	DIR_FILTER_KEY
static java.lang.String	DIR_GLOB
static java.lang.String	ERRORLIST_PLUGIN
static java.lang.String	EXCLUDE_DIRS_OPT
static java.lang.String	EXTENSIONS_PREFIX
static java.lang.String	FILE_FILTER_KEY
static java.lang.String	FILE_GLOB
static java.lang.String	FILE_NAME_KEY
static java.lang.String	FILTER_ID
static java.lang.String	FLATTEN
static java.lang.String	FOLLOW_BUFFER_OPT
static java.lang.String	IMPORT_EXTS_OPT
static java.lang.String	IMPORT_GLOBS_OPT
static java.lang.String	INCLUDE_FILES_OPT
static java.lang.String	INFOVIEWER_PLUGIN
static java.lang.String	KEEP_TREE
static java.lang.String	LAST_INIT_VERSION_OPT
static java.lang.String	LAST_NODE_OPT
static java.lang.String	LAST_PROJECT_OPT
static java.lang.String	REMEBER_OPEN_FILES_OPT
static java.lang.String	SHOW_ALLWFILES_OPT
static java.lang.String	SHOW_COMPACT_OPT
static java.lang.String	SHOW_FILES_OPT
static java.lang.String	SHOW_FILTERED_OPT
static java.lang.String	SHOW_FOLDERS_OPT
static java.lang.String	SHOW_PROJECT_TITLE_OPT
static java.lang.String	SHOW_WFILES_OPT
static java.lang.String	TRAVERSE_DIRS
static java.lang.String	USE_EXTERNAL_APPS_OPT
static java.lang.String	USE_SYSTEM_ICONS_OPT
static java.lang.String	USE_VARIABLE_PATHS_OPT
static java.lang.String	USER_CONTEXT_MENU
static java.lang.String	USER_MENU_FIRST

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a new property change listener to the list.
void	clearLastNodes() Clears last nodes list.
void	disableExtension(java.lang.String type, java.lang.String ext)
void	enableExtension(java.lang.String type, java.lang.String ext)
int	getAskImport()
java.lang.String	getBrowserPath()
boolean	getCaseInsensitiveSort()
boolean	getCloseFiles()
boolean	getDeleteNotFoundFiles()
java.lang.String	getExcludeDirs()
boolean	getFollowCurrentBuffer()
java.lang.String	getImportGlobs()
static ProjectViewerConfig	getInstance() Returns the config.
VPTNode	getLastNode() Returns the path to the last active node as a list.
boolean	getRememberOpen()
boolean	getShowAllWorkingFiles()
boolean	getShowCompactTree()
boolean	getShowFilesTree()
boolean	getShowFilteredTree()
boolean	getShowFoldersTree()
boolean	getShowProjectInTitle()
boolean	getShowWorkingFilesTree()
boolean	getUseExternalApps()
boolean	getUseInfoViewer()
java.lang.String	getUserContextMenu()
boolean	getUserMenuFirst()
boolean	getUseSystemIcons()
boolean	getUseVariablePaths()
void	handlePluginUpdate(org.gjt.sp.jedit.msg.PluginUpdate pluginUpdate)
boolean	isEarlyStartupRequired() Early startup is required if all of the following is fulfilled: User specified "Remember open project files" There was a project open last time
boolean	isErrorListAvailable()
boolean	isExtensionEnabled(java.lang.String type, java.lang.String ext)
boolean	isInfoViewerAvailable()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a property change listener to the list.
void	save() Save the configuration to the plugin's config file on disk.
void	setAskImport(int newAskImport)
void	setBrowserpath(java.lang.String newBrowserPath)
void	setCaseInsensitiveSort(boolean flag)
void	setCloseFiles(boolean closeFiles)
void	setDeleteNotFoundFiles(boolean deleteNotFoundFiles)
void	setExcludeDirs(java.lang.String newExcludeDirs)
void	setFollowCurrentBuffer(boolean flag)
void	setImportGlobs(java.lang.String importGlobs)
void	setLastNode(VPTNode node) Sets the path to the given node as the "last active path" used by the user.
void	setRememberOpen(boolean newRememberOpen)
void	setShowAllWorkingFiles(boolean newShowAllWorkingFiles)
void	setShowCompactTree(boolean newValue)
void	setShowFilesTree(boolean newShowFilesTree)
void	setShowFilteredTree(boolean newValue)
void	setShowFoldersTree(boolean newShowFoldersTree)
void	setShowProjectInTitle(boolean flag)
void	setShowWorkingFilesTree(boolean newShowWorkingFilesTree)
void	setUseExternalApps(boolean useExternalApps)
void	setUseInfoViewer(boolean useInfoViewer)
void	setUserContextMenu(java.lang.String userContextMenu)
void	setUserMenuFirst(boolean userMenuFirst)
void	setUseSystemIcons(boolean useSystemIcons)
void	setUseVariablePaths(boolean uvp)
void	update(java.util.Properties props) Updates the properties in the properties object passed to reflect the current state of the config.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE

public static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

ERRORLIST_PLUGIN

public static final java.lang.String ERRORLIST_PLUGIN

See Also:

Constant Field Values

INFOVIEWER_PLUGIN

public static final java.lang.String INFOVIEWER_PLUGIN

See Also:

Constant Field Values

ASK_IMPORT_OPT

public static final java.lang.String ASK_IMPORT_OPT

See Also:

Constant Field Values

BROWSER_PATH_OPT

public static final java.lang.String BROWSER_PATH_OPT

See Also:

Constant Field Values

BROWSER_USE_INFOVIEWER

public static final java.lang.String BROWSER_USE_INFOVIEWER

See Also:

Constant Field Values

CASE_INSENSITIVE_SORT_OPT

public static final java.lang.String CASE_INSENSITIVE_SORT_OPT

See Also:

Constant Field Values

CLOSE_FILES_OPT

public static final java.lang.String CLOSE_FILES_OPT

See Also:

Constant Field Values

DELETE_NOT_FOUND_FILES_OPT

public static final java.lang.String DELETE_NOT_FOUND_FILES_OPT

See Also:

Constant Field Values

EXCLUDE_DIRS_OPT

public static final java.lang.String EXCLUDE_DIRS_OPT

See Also:

Constant Field Values

FOLLOW_BUFFER_OPT

public static final java.lang.String FOLLOW_BUFFER_OPT

See Also:

Constant Field Values

IMPORT_EXTS_OPT

public static final java.lang.String IMPORT_EXTS_OPT

See Also:

Constant Field Values

IMPORT_GLOBS_OPT

public static final java.lang.String IMPORT_GLOBS_OPT

See Also:

Constant Field Values

INCLUDE_FILES_OPT

public static final java.lang.String INCLUDE_FILES_OPT

See Also:

Constant Field Values

LAST_NODE_OPT

public static final java.lang.String LAST_NODE_OPT

See Also:

Constant Field Values

LAST_PROJECT_OPT

public static final java.lang.String LAST_PROJECT_OPT

See Also:

Constant Field Values

LAST_INIT_VERSION_OPT

public static final java.lang.String LAST_INIT_VERSION_OPT

See Also:

Constant Field Values

REMEBER_OPEN_FILES_OPT

public static final java.lang.String REMEBER_OPEN_FILES_OPT

See Also:

Constant Field Values

SHOW_PROJECT_TITLE_OPT

public static final java.lang.String SHOW_PROJECT_TITLE_OPT

See Also:

Constant Field Values

USE_EXTERNAL_APPS_OPT

public static final java.lang.String USE_EXTERNAL_APPS_OPT

See Also:

Constant Field Values

USE_VARIABLE_PATHS_OPT

public static final java.lang.String USE_VARIABLE_PATHS_OPT

See Also:

Constant Field Values

USE_SYSTEM_ICONS_OPT

public static final java.lang.String USE_SYSTEM_ICONS_OPT

See Also:

Constant Field Values

SHOW_COMPACT_OPT

public static final java.lang.String SHOW_COMPACT_OPT

See Also:

Constant Field Values

SHOW_FILES_OPT

public static final java.lang.String SHOW_FILES_OPT

See Also:

Constant Field Values

SHOW_FILTERED_OPT

public static final java.lang.String SHOW_FILTERED_OPT

See Also:

Constant Field Values

SHOW_FOLDERS_OPT

public static final java.lang.String SHOW_FOLDERS_OPT

See Also:

Constant Field Values

SHOW_WFILES_OPT

public static final java.lang.String SHOW_WFILES_OPT

See Also:

Constant Field Values

SHOW_ALLWFILES_OPT

public static final java.lang.String SHOW_ALLWFILES_OPT

See Also:

Constant Field Values

USER_MENU_FIRST

public static final java.lang.String USER_MENU_FIRST

See Also:

Constant Field Values

USER_CONTEXT_MENU

public static final java.lang.String USER_CONTEXT_MENU

See Also:

Constant Field Values

EXTENSIONS_PREFIX

public static final java.lang.String EXTENSIONS_PREFIX

See Also:

Constant Field Values

FILE_FILTER_KEY

public static final java.lang.String FILE_FILTER_KEY

See Also:

Constant Field Values

DIR_FILTER_KEY

public static final java.lang.String DIR_FILTER_KEY

See Also:

Constant Field Values

FILE_NAME_KEY

public static final java.lang.String FILE_NAME_KEY

See Also:

Constant Field Values

TRAVERSE_DIRS

public static final java.lang.String TRAVERSE_DIRS

See Also:

Constant Field Values

ADD_HIDDEN

public static final java.lang.String ADD_HIDDEN

See Also:

Constant Field Values

FLATTEN

public static final java.lang.String FLATTEN

See Also:

Constant Field Values

KEEP_TREE

public static final java.lang.String KEEP_TREE

See Also:

Constant Field Values

FILTER_ID

public static final java.lang.String FILTER_ID

See Also:

Constant Field Values

FILE_GLOB

public static final java.lang.String FILE_GLOB

See Also:

Constant Field Values

DIR_GLOB

public static final java.lang.String DIR_GLOB

See Also:

Constant Field Values

ASK_ALWAYS

public static final int ASK_ALWAYS

See Also:

Constant Field Values

ASK_ONCE

public static final int ASK_ONCE

See Also:

Constant Field Values

ASK_NEVER

public static final int ASK_NEVER

See Also:

Constant Field Values

AUTO_IMPORT

public static final int AUTO_IMPORT

See Also:

Constant Field Values

Method Detail

getInstance

public static ProjectViewerConfig getInstance()

Returns the config.

setCloseFiles

public void setCloseFiles(boolean closeFiles)

setDeleteNotFoundFiles

public void setDeleteNotFoundFiles(boolean deleteNotFoundFiles)

setRememberOpen

public void setRememberOpen(boolean newRememberOpen)

setAskImport

public void setAskImport(int newAskImport)

setExcludeDirs

public void setExcludeDirs(java.lang.String newExcludeDirs)

setBrowserpath

public void setBrowserpath(java.lang.String newBrowserPath)

setShowFoldersTree

public void setShowFoldersTree(boolean newShowFoldersTree)

setShowFilesTree

public void setShowFilesTree(boolean newShowFilesTree)

setShowWorkingFilesTree

public void setShowWorkingFilesTree(boolean newShowWorkingFilesTree)

setShowAllWorkingFiles

public void setShowAllWorkingFiles(boolean newShowAllWorkingFiles)

setShowCompactTree

public void setShowCompactTree(boolean newValue)

setShowFilteredTree

public void setShowFilteredTree(boolean newValue)

getCloseFiles

public boolean getCloseFiles()

getDeleteNotFoundFiles

public boolean getDeleteNotFoundFiles()

getRememberOpen

public boolean getRememberOpen()

getAskImport

public int getAskImport()

getExcludeDirs

public java.lang.String getExcludeDirs()

getBrowserPath

public java.lang.String getBrowserPath()

getShowFoldersTree

public boolean getShowFoldersTree()

getShowFilesTree

public boolean getShowFilesTree()

getShowWorkingFilesTree

public boolean getShowWorkingFilesTree()

getShowAllWorkingFiles

public boolean getShowAllWorkingFiles()

getShowCompactTree

public boolean getShowCompactTree()

getShowFilteredTree

public boolean getShowFilteredTree()

setUseVariablePaths

public void setUseVariablePaths(boolean uvp)

getUseVariablePaths

public boolean getUseVariablePaths()

setUseInfoViewer

public void setUseInfoViewer(boolean useInfoViewer)

getUseInfoViewer

public boolean getUseInfoViewer()

setUserMenuFirst

public void setUserMenuFirst(boolean userMenuFirst)

getUserMenuFirst

public boolean getUserMenuFirst()

setUserContextMenu

public void setUserContextMenu(java.lang.String userContextMenu)

getUserContextMenu

public java.lang.String getUserContextMenu()

setUseSystemIcons

public void setUseSystemIcons(boolean useSystemIcons)

getUseSystemIcons

public boolean getUseSystemIcons()

setLastNode

public void setLastNode(VPTNode node)

Sets the path to the given node as the "last active path" used by the user. This makes it possible to reload the exact node that was active before next time PV starts, be it a project or a group.

Since:

PV 2.1.0

getLastNode

public VPTNode getLastNode()

Returns the path to the last active node as a list. Each item is the name of a node in the path, starting with the first child of the root node at index 0. This method will never return null; at least the root of the tree will be returned.

Note: DON'T CALL THIS METHOD; it's for internal PV use ONLY, and having other callers might mess some things up.

Since:

PV 2.1.0

clearLastNodes

public void clearLastNodes()

Clears last nodes list.

Since:

PV 3.4.3

setUseExternalApps

public void setUseExternalApps(boolean useExternalApps)

getUseExternalApps

public boolean getUseExternalApps()

setImportGlobs

public void setImportGlobs(java.lang.String importGlobs)

getImportGlobs

public java.lang.String getImportGlobs()

setShowProjectInTitle

public void setShowProjectInTitle(boolean flag)

getShowProjectInTitle

public boolean getShowProjectInTitle()

setCaseInsensitiveSort

public void setCaseInsensitiveSort(boolean flag)

getCaseInsensitiveSort

public boolean getCaseInsensitiveSort()

setFollowCurrentBuffer

public void setFollowCurrentBuffer(boolean flag)

getFollowCurrentBuffer

public boolean getFollowCurrentBuffer()

isExtensionEnabled

public boolean isExtensionEnabled(java.lang.String type,
                         java.lang.String ext)

enableExtension

public void enableExtension(java.lang.String type,
                   java.lang.String ext)

disableExtension

public void disableExtension(java.lang.String type,
                    java.lang.String ext)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a new property change listener to the list.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a property change listener to the list.

update

public void update(java.util.Properties props)

Updates the properties in the properties object passed to reflect the current state of the config.

save

public void save()

Save the configuration to the plugin's config file on disk.

isInfoViewerAvailable

public boolean isInfoViewerAvailable()

isErrorListAvailable

public boolean isErrorListAvailable()

isEarlyStartupRequired

public boolean isEarlyStartupRequired()

Early startup is required if all of the following is fulfilled:

1. User specified "Remember open project files"
2. There was a project open last time

handlePluginUpdate

public void handlePluginUpdate(org.gjt.sp.jedit.msg.PluginUpdate pluginUpdate)