net.sourceforge.rssowl.controller.dialog
Class BlogrollDialog

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.jface.dialogs.TitleAreaDialog
              net.sourceforge.rssowl.controller.dialog.BlogrollDialog

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider

public class BlogrollDialog
extends org.eclipse.jface.dialogs.TitleAreaDialog

Dialog prompts for a OPML file to import favorites to RSSOwl from a Blogroll. The list of newsfeeds from the Blogroll will synchronize with RSSOwl on startup.

Version:

1.2.4

Author:

Benjamin Pasero

Nested Class Summary

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

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

(package private) Category	blogrollCategory
(package private) java.lang.String	dialogMessage
private static int	dialogMinWidth Min. width of the dialog in DLUs
private java.lang.String	dialogTitle
private Text	inputTitle
private Text	inputUrl
private boolean	isEdit
(package private) Button	okButton
private GUI	rssOwlGui

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

blockedHandler, buttonBar, dialogArea, DLG_IMG_ERROR, 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

BlogrollDialog(GUI rssOwlGui, Shell parentShell, java.lang.String dialogTitle, java.lang.String dialogMessage)
Dialog is in "New Blogroll" Mode.

BlogrollDialog(GUI rssOwlGui, Shell parentShell, java.lang.String dialogTitle, java.lang.String dialogMessage, Category blogrollCategory)
Dialog is in "Edit Blogroll" Mode.

Method Summary

protected void	buttonPressed(int buttonId)
boolean	close()
protected void	configureShell(Shell shell)
protected void	createButtonsForButtonBar(Composite parent)
protected Control	createDialogArea(Composite parent)
protected int	getShellStyle()
private boolean	importBlogroll() Try to import the OPML file.
protected void	initializeBounds()
protected void	setButtonLayoutData(Button button) Set the layout data of the button to a GridData with appropriate widths This method was slightly modified so that it is not setting a heightHint.
protected void	validateInput() Validates the input.

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

applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutFormData, shortenText

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

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getInitialLocation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, 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

dialogMinWidth

private static final int dialogMinWidth

Min. width of the dialog in DLUs

See Also:

Constant Field Values

dialogTitle

private java.lang.String dialogTitle

inputTitle

private Text inputTitle

inputUrl

private Text inputUrl

isEdit

private boolean isEdit

rssOwlGui

private GUI rssOwlGui

blogrollCategory

Category blogrollCategory

dialogMessage

java.lang.String dialogMessage

okButton

Button okButton

Constructor Detail

BlogrollDialog

public BlogrollDialog(GUI rssOwlGui,
                      Shell parentShell,
                      java.lang.String dialogTitle,
                      java.lang.String dialogMessage)

Dialog is in "New Blogroll" Mode. Creates an input dialog with OK and Cancel buttons. Prompts for a url / path and a title for a new blogroll. Note that the dialog will have no visual representation (no widgets) until it is told to open.

Note that the open method blocks for input dialogs.

Parameters:

rssOwlGui - The Main Controller

parentShell - the parent shell

dialogTitle - the dialog title

dialogMessage - the dialog dialogMessage

BlogrollDialog

public BlogrollDialog(GUI rssOwlGui,
                      Shell parentShell,
                      java.lang.String dialogTitle,
                      java.lang.String dialogMessage,
                      Category blogrollCategory)

Dialog is in "Edit Blogroll" Mode. Creates an input dialog with OK and Cancel buttons. Prompts for a url / path and a title for a new blogroll. Note that the dialog will have no visual representation (no widgets) until it is told to open.

Note that the open method blocks for input dialogs.

Parameters:

rssOwlGui - The Main Controller

parentShell - the parent shell

dialogTitle - the dialog title

dialogMessage - the dialog dialogMessage

blogrollCategory - The existing blogroll to edit

Method Detail

close

public boolean close()

Overrides:

close in class org.eclipse.jface.dialogs.Dialog

See Also:

Dialog.close()

importBlogroll

private boolean importBlogroll()

Try to import the OPML file. Shows an error in the Dialog if any exception occurs.

Returns:

boolean TRUE on success, FALSE on fail

buttonPressed

protected void buttonPressed(int buttonId)

Overrides:

buttonPressed in class org.eclipse.jface.dialogs.Dialog

See Also:

Dialog.buttonPressed(int)

configureShell

protected void configureShell(Shell shell)

Overrides:

configureShell in class org.eclipse.jface.window.Window

See Also:

Window.configureShell(org.eclipse.swt.widgets.Shell)

createButtonsForButtonBar

protected void createButtonsForButtonBar(Composite parent)

Overrides:

createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog

See Also:

Dialog.createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)

createDialogArea

protected Control createDialogArea(Composite parent)

Overrides:

createDialogArea in class org.eclipse.jface.dialogs.TitleAreaDialog

See Also:

Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)

getShellStyle

protected int getShellStyle()

Overrides:

getShellStyle in class org.eclipse.jface.window.Window

See Also:

Window.getShellStyle()

initializeBounds

protected void initializeBounds()

Overrides:

initializeBounds in class org.eclipse.jface.dialogs.Dialog

See Also:

Dialog.initializeBounds()

setButtonLayoutData

protected void setButtonLayoutData(Button button)

Set the layout data of the button to a GridData with appropriate widths This method was slightly modified so that it is not setting a heightHint.

Overrides:

setButtonLayoutData in class org.eclipse.jface.dialogs.Dialog

Parameters:

button - The button to layout

validateInput

protected void validateInput()

Validates the input.

The default implementation of this framework method delegates the request to the supplied input validator object; if it finds the input invalid, the warning dialogMessage is displayed in the dialog's dialogMessage line. This hook method is called whenever the text changes in the input field.