PamUtils
Class SelectFolder

java.lang.Object
  PamUtils.SelectFolder

public class SelectFolder
extends java.lang.Object

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

Author:

Doug Gillespie

Nested Class Summary

private class

SelectFolder.FolderPanel

Field Summary

private java.lang.String	borderLabel
private javax.swing.JButton	browseButton
private java.util.ArrayList<FolderChangeListener>	folderChangeListeners
private javax.swing.JTextField	folderName
private SelectFolder.FolderPanel	folderPanel
private javax.swing.JCheckBox	includeSubFoldersCheckBox
private boolean	showSubFolderOption
private int	textLength

Constructor Summary

SelectFolder(int textLength)

SelectFolder(java.lang.String borderLabel, int textLength)

SelectFolder(java.lang.String borderLabel, int textLength, boolean showSubFolderOption)

Method Summary

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(java.lang.String borderLabel, int textLength)
java.lang.String	getFolderName(boolean checkPath)
SelectFolder.FolderPanel	getFolderPanel()
boolean	isIncludeSubFolders() Get the state of the sub folder check box.
boolean	isShowSubFolderOption()
private void	notifyChangeListeners()
void	removeFolderChangeListener(FolderChangeListener folderChangeListener) Remove a folder change listener
void	setEnabled(boolean enable)
void	setFolderName(java.lang.String folderName)
void	setIncludeSubFolders(boolean includeSubfolders) Set the state of the sub folder check box.
void	setShowSubFolderOption(boolean showSubFolderOption)
void	setTextLength(int textLength)
private void	setVisibleControls()

Methods inherited from class java.lang.Object

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

Field Detail

folderPanel

private SelectFolder.FolderPanel folderPanel

textLength

private int textLength

borderLabel

private java.lang.String borderLabel

browseButton

private javax.swing.JButton browseButton

folderName

private javax.swing.JTextField folderName

includeSubFoldersCheckBox

private javax.swing.JCheckBox includeSubFoldersCheckBox

showSubFolderOption

private boolean showSubFolderOption

folderChangeListeners

private java.util.ArrayList<FolderChangeListener> folderChangeListeners

Constructor Detail

SelectFolder

public SelectFolder(java.lang.String borderLabel,
                    int textLength,
                    boolean showSubFolderOption)

SelectFolder

public SelectFolder(java.lang.String borderLabel,
                    int textLength)

SelectFolder

public SelectFolder(int textLength)

Method Detail

createPanel

public void createPanel(java.lang.String borderLabel,
                        int textLength)

setEnabled

public void setEnabled(boolean enable)

notifyChangeListeners

private void notifyChangeListeners()

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 java.lang.String getFolderName(boolean checkPath)

setFolderName

public void setFolderName(java.lang.String folderName)

getFolderPanel

public SelectFolder.FolderPanel getFolderPanel()

setTextLength

public void setTextLength(int textLength)

isShowSubFolderOption

public boolean isShowSubFolderOption()

setShowSubFolderOption

public void setShowSubFolderOption(boolean showSubFolderOption)

setVisibleControls

private void setVisibleControls()