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

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.WatchSettingsEntryInputDialog

All Implemented Interfaces:

IInputValidator, IShellProvider

public class WatchSettingsEntryInputDialog

extends TitleAreaDialog

implements IInputValidator

User Dialog to create/edit a WatchSettingsEntry.

Author:

Sebastian Machhausen

Nested Class Summary

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

Window.IExceptionHandler

Field Summary

private Button	caseSensitiveButton The Button to toggle the case sensitive setting
private LanguageResource	defaultResource Default language resource used in this dialog
private String	dialogTitle The dialog title
private WatchSettingsEntry	entry The WatchSettingsEntry created/edited
private Text	keywordField The Text carrying the keyword input
private Button	wholeWordButton The Button to toggle the whole word setting

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

WatchSettingsEntryInputDialog(Shell parentShell, String dialogTitle)
Creates a new WatchSettingsEntryInputDialog instance.

WatchSettingsEntryInputDialog(Shell parentShell, WatchSettingsEntry entry, String dialogTitle)
Creates a new WatchSettingsEntryInputDialog instance.

Method Summary

protected void	buttonPressed(int buttonId) Called whenever a button is pressed in this WatchSettingsEntryInputDialog.
protected void	configureShell(Shell shell) Configures the Shell representing this WatchSettingsEntryInputDialog.
protected void	createButtonsForButtonBar(Composite parent) Creates the buttons used in this WatchSettingsEntryInputDialog and sets up their default enabled state.
protected Control	createDialogArea(Composite parent) Creates the dialog area of this WatchSettingsEntryInputDialog.
private void	createLegend(Composite parent) Creates a legend that describes the wildcards that can be used within a keyword.
WatchSettingsEntry	getEntry() Gets the created/edited WatchSettingsEntry instance.
String	isValid(String newText) Verifies if the given input is valid.

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

close, 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

dialogTitle

private String dialogTitle

The dialog title

entry

private WatchSettingsEntry entry

The WatchSettingsEntry created/edited

keywordField

private Text keywordField

The Text carrying the keyword input

caseSensitiveButton

private Button caseSensitiveButton

The Button to toggle the case sensitive setting

wholeWordButton

private Button wholeWordButton

The Button to toggle the whole word setting

defaultResource

private LanguageResource defaultResource

Default language resource used in this dialog

Constructor Detail

WatchSettingsEntryInputDialog

public WatchSettingsEntryInputDialog(Shell parentShell,
                                     String dialogTitle)

Creates a new WatchSettingsEntryInputDialog instance.

Parameters:

parentShell - the parent Shell of this WatchSettingsEntryInputDialog

dialogTitle - the dialog title

WatchSettingsEntryInputDialog

public WatchSettingsEntryInputDialog(Shell parentShell,
                                     WatchSettingsEntry entry,
                                     String dialogTitle)

Creates a new WatchSettingsEntryInputDialog instance.

Parameters:

parentShell - the parent Shell of this WatchSettingsEntryInputDialog

entry - the edited WatchSettingsEntry

dialogTitle - the dialog title

Method Detail

getEntry

public WatchSettingsEntry getEntry()

Gets the created/edited WatchSettingsEntry instance.

Returns:

the created/edited WatchSettingsEntry instance

isValid

public String isValid(String newText)

Verifies if the given input is valid. Currently only an empty input is being declined.

Specified by:

isValid in interface IInputValidator

Parameters:

newText - the text to verify

Returns:

an error message if the given input is invalid; null otherwise

configureShell

protected void configureShell(Shell shell)

Configures the Shell representing this WatchSettingsEntryInputDialog.

Parameters:

shell - the Shell to configure

createButtonsForButtonBar

protected void createButtonsForButtonBar(Composite parent)

Creates the buttons used in this WatchSettingsEntryInputDialog 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 WatchSettingsEntryInputDialog.

Parameters:

buttonId - the id of the button that was pressed

See Also:

for the button ids defined in the JFace framework

createDialogArea

protected Control createDialogArea(Composite parent)

Creates the dialog area of this WatchSettingsEntryInputDialog.

Parameters:

parent - the parent Composite to embed the dialog area into

Returns:

the created dialog area

createLegend

private void createLegend(Composite parent)

Creates a legend that describes the wildcards that can be used within a keyword.

Parameters:

parent - the parent Composite to embed the legend into