Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ant >> internal >> ui >> [ preferences overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.ant.internal.ui.preferences
Class StatusDialog  

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.ant.internal.ui.preferences.StatusDialog

Direct Known Subclasses:

AddCustomDialog

---

public abstract class StatusDialog

extends org.eclipse.jface.dialogs.Dialog

An abstract base class for dialogs with a status bar and ok/cancel buttons. The status message must be passed over as StatusInfo object and can be an error, warning or ok. The OK button is enabled or disabled depending on the status.

---

Nested Class Summary

 

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

org.eclipse.jface.window.Window.IExceptionHandler

 

Field Summary
private  org.eclipse.swt.graphics.Image	fImage
private  org.eclipse.core.runtime.IStatus	fLastStatus
private  org.eclipse.swt.widgets.Button	fOkButton
private  MessageLine	fStatusLine
private  java.lang.String	fTitle

 

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

StatusDialog(org.eclipse.swt.widgets.Shell parent)           Creates an instane of a status dialog.

 

Method Summary
protected  void	configureShell(org.eclipse.swt.widgets.Shell shell)           Configures the given shell in preparation for opening this window in it.
void	create()           Creates this window's widgetry in a new top-level shell.
protected  org.eclipse.swt.widgets.Control	createButtonBar(org.eclipse.swt.widgets.Composite parent)           Creates and returns the contents of this dialog's button bar.
protected  void	createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)           Adds buttons to this dialog's button bar.
org.eclipse.core.runtime.IStatus	getStatus()           Returns the last status.
void	setImage(org.eclipse.swt.graphics.Image image)           Sets the image for this dialog.
void	setTitle(java.lang.String title)           Sets the title for this dialog.
protected  void	updateButtonsEnableState(org.eclipse.core.runtime.IStatus status)           Updates the status of the ok button to reflect the given status.
protected  void	updateStatus(org.eclipse.core.runtime.IStatus status)           Update the dialog's status line to reflect the given status.

 

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

applyDialogFont, buttonPressed, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, createDialogArea, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

 

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

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getInitialSize, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager

 

Methods inherited from class java.lang.Object

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

 

Field Detail

fOkButton

private org.eclipse.swt.widgets.Button fOkButton

---

fStatusLine

private MessageLine fStatusLine

---

fLastStatus

private org.eclipse.core.runtime.IStatus fLastStatus

---

fTitle

private java.lang.String fTitle

---

fImage

private org.eclipse.swt.graphics.Image fImage

Constructor Detail

StatusDialog

public StatusDialog(org.eclipse.swt.widgets.Shell parent)

Creates an instane of a status dialog.

Method Detail

updateStatus

protected void updateStatus(org.eclipse.core.runtime.IStatus status)

Update the dialog's status line to reflect the given status. It is save to call this method before the dialog has been opened.

---

getStatus

public org.eclipse.core.runtime.IStatus getStatus()

Returns the last status.

---

updateButtonsEnableState

protected void updateButtonsEnableState(org.eclipse.core.runtime.IStatus status)

Updates the status of the ok button to reflect the given status. Subclasses may override this method to update additional buttons.

---

configureShell

protected void configureShell(org.eclipse.swt.widgets.Shell shell)

Description copied from class: org.eclipse.jface.window.Window

Configures the given shell in preparation for opening this window in it.

The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.

---

create

public void create()

Description copied from class: org.eclipse.jface.window.Window

Creates this window's widgetry in a new top-level shell.

The default implementation of this framework method creates this window's shell (by calling createShell), and its controls (by calling createContents), then initializes this window's shell bounds (by calling initializeBounds).

---

createButtonsForButtonBar

protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)

Description copied from class: org.eclipse.jface.dialogs.Dialog

Adds buttons to this dialog's button bar.

The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

---

createButtonBar

protected org.eclipse.swt.widgets.Control createButtonBar(org.eclipse.swt.widgets.Composite parent)

Description copied from class: org.eclipse.jface.dialogs.Dialog

Creates and returns the contents of this dialog's button bar.

The Dialog implementation of this framework method lays out a button bar and calls the createButtonsForButtonBar framework method to populate it. Subclasses may override.

The returned control's layout data must be an instance of GridData.

---

setTitle

public void setTitle(java.lang.String title)

Sets the title for this dialog.

---

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

Sets the image for this dialog.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ant >> internal >> ui >> [ preferences overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---