net.sourceforge.java.feednread.frontend.dialog
Class WatchFolderSelectionDialog

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.jface.dialogs.TrayDialog
              org.eclipse.jface.dialogs.TitleAreaDialog
                  net.sourceforge.java.feednread.frontend.dialog.WatchFolderSelectionDialog

All Implemented Interfaces:

IShellProvider

public class WatchFolderSelectionDialog

extends TitleAreaDialog

Dialog to select a WatchFolder from the NewsFeedWatchesTree.

Author:

Sebastian Machhausen

Nested Class Summary

Nested classes inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

private NewsFeedWatchesTreeContentProvider	contentProvider The NewsFeedWatchesTreeViewerContentProvider to act as model bridge
private LanguageResource	defaultResource Default language resource used in this dialog
private String	dialogTitle The dialog title
private WatchFolder	dummyRoot A dummy root WatchFolder to achive that the actual root WatchFolder which is normally invisible is displayed.
private WatchFolder	excluedFolder The WatchFolder to exclude from potential selections
private MainApplicationWindow	mainWindow The Feed'n Read main window
private WatchFolder	selectedFolder The selected WatchFolder<
private TreeViewer	viewer The TreeViewer to use for selection

Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE

Fields inherited from class org.eclipse.jface.dialogs.TrayDialog

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

WatchFolderSelectionDialog(MainApplicationWindow mainWindow, String dialogTitle, WatchFolder selectedFolder, WatchFolder excludedFolder)
Creates a new WatchFolderSelectionDialog instance.

Method Summary

protected void	buttonPressed(int buttonId) Called whenever a button is pressed in this WatchFolderSelectionDialog.
boolean	close() Closes this WatchFolderSelectionDialog.
protected void	configureShell(Shell shell) Configures the Shell representing this WatchFolderSelectionDialog
protected void	createButtonsForButtonBar(Composite parent) Creates the buttons used in this WatchFolderSelectionDialog and sets up their default enabled state.
private void	createColumns(Tree tree) Creates the TreeColumns for the specified Tree.
protected Control	createDialogArea(Composite parent) Creates the dialog area of this WatchFolderSelectionDialog.
private void	createTree(Composite parent) Creates the TreeViewer and Tree instance used to select a single WatchFolder from the NewsFeedWatchesTree.
void	dispose() Disposes this WatchFolderSelectionDialog.
WatchFolder	getSelection() Gets the selected WatchFolder.

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

createContents, getInitialSize, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

closeTray, createButtonBar, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

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

Field Detail

mainWindow

private MainApplicationWindow mainWindow

The Feed'n Read main window

dialogTitle

private String dialogTitle

The dialog title

contentProvider

private NewsFeedWatchesTreeContentProvider contentProvider

The NewsFeedWatchesTreeViewerContentProvider to act as model bridge

viewer

private TreeViewer viewer

The TreeViewer to use for selection

selectedFolder

private WatchFolder selectedFolder

The selected WatchFolder<

excluedFolder

private WatchFolder excluedFolder

The WatchFolder to exclude from potential selections

dummyRoot

private WatchFolder dummyRoot

A dummy root WatchFolder to achive that the actual root WatchFolder which is normally invisible is displayed.

defaultResource

private LanguageResource defaultResource

Default language resource used in this dialog

Constructor Detail

WatchFolderSelectionDialog

public WatchFolderSelectionDialog(MainApplicationWindow mainWindow,
                                  String dialogTitle,
                                  WatchFolder selectedFolder,
                                  WatchFolder excludedFolder)

Creates a new WatchFolderSelectionDialog instance.

Parameters:

mainWindow - the Feed'n Read main window

dialogTitle - the title of this dialog

selectedFolder - the WatchFolder to preselect

excludedFolder - the WatchFolder to exclude from potential selections

Method Detail

dispose

public void dispose()

Disposes this WatchFolderSelectionDialog.

close

public boolean close()

Closes this WatchFolderSelectionDialog.

Returns:

true if this WatchFolderSelectionDialog is (or was already) closed, and false if it is still open

getSelection

public WatchFolder getSelection()

Gets the selected WatchFolder.

Returns:

the selected WatchFolder

configureShell

protected void configureShell(Shell shell)

Configures the Shell representing this WatchFolderSelectionDialog

Parameters:

shell - the Shell to configure

createDialogArea

protected Control createDialogArea(Composite parent)

Creates the dialog area of this WatchFolderSelectionDialog.

Parameters:

parent - the parent component to embed the dialog area into

Returns:

the created dialog area

createButtonsForButtonBar

protected void createButtonsForButtonBar(Composite parent)

Creates the buttons used in this WatchFolderSelectionDialog and sets up their default enabled state.

Parameters:

parent - the parent component to embed the buttons into

buttonPressed

protected void buttonPressed(int buttonId)

Called whenever a button is pressed in this WatchFolderSelectionDialog.

Parameters:

buttonId - the id of the button that was pressed

See Also:

for the button ids defined in the JFace framework

createTree

private void createTree(Composite parent)

Creates the TreeViewer and Tree instance used to select a single WatchFolder from the NewsFeedWatchesTree.

Parameters:

parent - the parent Composite to embed the created Tree into

createColumns

private void createColumns(Tree tree)

Creates the TreeColumns for the specified Tree.

Parameters:

tree - the Tree to create the TreeColumns for