Package PamUtils

Class SelectFolder

java.lang.Object

PamUtils.SelectFolder

public class SelectFolder
extends Object

Makes a dialog panel for selecting a folder typically for file output.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
SelectFolder(int textLength)
SelectFolder(String borderLabel, int textLength)
SelectFolder(String borderLabel, int textLength, boolean showSubFolderOption)

Method Summary

Modifier and Type	Method	Description
void	addFolderChangeListener(FolderChangeListener folderChangeListener)	Add a folder change listener to receive notification if the browse button was used to select a new folder.
void	createPanel(String borderLabel, int textLength)
String	getFolderName(boolean checkPath)	Get the folder name and optionally check and create the path for data storage.
PamUtils.SelectFolder.FolderPanel	getFolderPanel()
boolean	isCreateIfNeeded()
boolean	isIncludeSubFolders()	Get the state of the sub folder check box.
boolean	isMustExist()
boolean	isShowSubFolderOption()
void	removeFolderChangeListener(FolderChangeListener folderChangeListener)	Remove a folder change listener
void	setCreateIfNeeded(boolean createIfNeeded)
void	setEnabled(boolean enable)
void	setFolderName(String folderName)
void	setIncludeSubFolders(boolean includeSubfolders)	Set the state of the sub folder check box.
void	setMustExist(boolean mustExist)
void	setShowSubFolderOption(boolean showSubFolderOption)
void	setSubFolderButtonName(String buttonName)	Set the name for the "Include Sub folders" checkbox
void	setSubFolderButtonToolTip(String tipText)	Set the name for the "Include Sub folders" checkbox
void	setTextLength(int textLength)

Methods inherited from class java.lang.Object

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

Constructor Details

SelectFolder

public SelectFolder(String borderLabel,
 int textLength,
 boolean showSubFolderOption)

SelectFolder

public SelectFolder(String borderLabel,
 int textLength)

SelectFolder

public SelectFolder(int textLength)

Method Details

createPanel

public void createPanel(String borderLabel,
 int textLength)

setEnabled

public void setEnabled(boolean enable)

setIncludeSubFolders

public void setIncludeSubFolders(boolean includeSubfolders)

Set the state of the sub folder check box.

Parameters:

includeSubfolders - true to check the box.

isIncludeSubFolders

public boolean isIncludeSubFolders()

Get the state of the sub folder check box.

Returns:

true if selected

addFolderChangeListener

public void addFolderChangeListener(FolderChangeListener folderChangeListener)

Add a folder change listener to receive notification if the browse button was used to select a new folder.

Parameters:

folderChangeListener - change listener

removeFolderChangeListener

public void removeFolderChangeListener(FolderChangeListener folderChangeListener)

Remove a folder change listener

Parameters:

folderChangeListener -

getFolderName

public String getFolderName(boolean checkPath)

Get the folder name and optionally check and create the path for data storage.

Parameters:

checkPath - set true to check / create the storage path.

Returns:

Path string, or null if path check fails.

setFolderName

public void setFolderName(String folderName)

getFolderPanel

public PamUtils.SelectFolder.FolderPanel getFolderPanel()

setSubFolderButtonName

public void setSubFolderButtonName(String buttonName)

Set the name for the "Include Sub folders" checkbox

Parameters:

buttonName - new name for the checkbox.

setSubFolderButtonToolTip

public void setSubFolderButtonToolTip(String tipText)

Set the name for the "Include Sub folders" checkbox

Parameters:

buttonName - new name for the checkbox.

setTextLength

public void setTextLength(int textLength)

isShowSubFolderOption

public boolean isShowSubFolderOption()

setShowSubFolderOption

public void setShowSubFolderOption(boolean showSubFolderOption)

isMustExist

public boolean isMustExist()

Returns:

the mustExist

setMustExist

public void setMustExist(boolean mustExist)

Parameters:

mustExist - the mustExist to set

isCreateIfNeeded

public boolean isCreateIfNeeded()

Returns:

the createIfNeeded

setCreateIfNeeded

public void setCreateIfNeeded(boolean createIfNeeded)

Parameters:

createIfNeeded - the createIfNeeded to set