org.eclipse.sphinx.xtendxpand.ui.dialogs

Class EditOutletDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

org.eclipse.jface.dialogs.StatusDialog

org.eclipse.sphinx.xtendxpand.ui.dialogs.EditOutletDialog

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider

public class EditOutletDialog
extends org.eclipse.jface.dialogs.StatusDialog

This class implements dialog which allows an outlet to be created or edited

Nested Class Summary

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

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.sphinx.xtendxpand.ui.dialogs.EditOutletDialog.Listener	listener

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

Constructor Summary

Constructors

Constructor and Description
EditOutletDialog(org.eclipse.swt.widgets.Shell parent, ExtendedOutlet outlet, boolean edit, boolean editableName, OutletProvider outletProvider) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	create() Sets validation buttons state before dialog is displayed.
protected org.eclipse.swt.widgets.Control	createDialogArea(org.eclipse.swt.widgets.Composite ancestor)
ExtendedOutlet	getOutlet()
protected void	handleBrowseFileSystem() This method is called when user clicks on file system button.
protected void	handleBrowseWorkspace() This method is called when user clicks on Workspace button.
protected void	handleInsertVariable()
protected void	handleLocationChanged() This method is called when user changes outlet location.
protected void	handleNameChanged() This method is called when user changes outlet name.
protected boolean	isResizable()
protected org.eclipse.core.runtime.IStatus	validateOutletInputs() Checks that all outlet properties are valid, by checking its name and its location.
protected org.eclipse.core.runtime.IStatus	validateOutletLocation() Validates that the location is not empty and Is a valid path.
protected org.eclipse.core.runtime.IStatus	validateOutletName() Checks outlet name by checking it is not empty, or name is not already used by other ones.

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

configureShell, createButtonBar, createButtonsForButtonBar, getStatus, setImage, setStatusLineAboveButtons, setTitle, updateButtonsEnableState, updateStatus

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

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

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

applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, 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, 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

listener

protected org.eclipse.sphinx.xtendxpand.ui.dialogs.EditOutletDialog.Listener listener

Constructor Detail

EditOutletDialog

public EditOutletDialog(org.eclipse.swt.widgets.Shell parent,
                ExtendedOutlet outlet,
                boolean edit,
                boolean editableName,
                OutletProvider outletProvider)

Constructor

Parameters:

parent - the parent shell, or null to create a top-level shell

outlet - the outlet to edit

edit - set to true is outlet is being edited, false if it is a outlet creation

editableName - set to true if outlet name can be editable, false otherwise

outletProvider - the OutletProvider created for an OutletsPreference and may refers to project

Method Detail

isResizable

protected boolean isResizable()

Overrides:

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

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite ancestor)

Overrides:

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

handleNameChanged

protected void handleNameChanged()

This method is called when user changes outlet name. It checks its consistency and refreshes buttons accordingly.

handleLocationChanged

protected void handleLocationChanged()

This method is called when user changes outlet location. It checks its consistency and refreshes buttons accordingly.

See Also:

validateOutletLocation()

handleBrowseFileSystem

protected void handleBrowseFileSystem()

This method is called when user clicks on file system button. It will display a folder selection dialog.

handleBrowseWorkspace

protected void handleBrowseWorkspace()

This method is called when user clicks on Workspace button. It will display Workspace selection dialog.

handleInsertVariable

protected void handleInsertVariable()

validateOutletInputs

protected org.eclipse.core.runtime.IStatus validateOutletInputs()

Checks that all outlet properties are valid, by checking its name and its location.

Returns:

Status OK if name and location are valid

See Also:

validateOutletName(), validateOutletLocation()

validateOutletName

protected org.eclipse.core.runtime.IStatus validateOutletName()

Checks outlet name by checking it is not empty, or name is not already used by other ones.

Returns:

Returns status of outlet name validity

validateOutletLocation

protected org.eclipse.core.runtime.IStatus validateOutletLocation()

Validates that the location is not empty and Is a valid path. We don't validate the container existence, it will be created by Xpand during the generation if it does not exist.

Returns:

status of outlet location validity

getOutlet

public ExtendedOutlet getOutlet()

Returns:

Returns outlet being edited or created

create

public void create()

Sets validation buttons state before dialog is displayed.

Overrides:

create in class org.eclipse.jface.dialogs.StatusDialog

See Also:

StatusDialog.create()