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

---

org.eclipse.jface.dialogs
Interface IDialogPage  

All Known Implementing Classes:

DialogPage

---

public interface IDialogPage

Interface for a page in a multi-page dialog.

---

Method Summary
void	createControl(org.eclipse.swt.widgets.Composite parent)           Creates the top level control for this dialog page under the given parent composite.
void	dispose()           Disposes the SWT resources allocated by this dialog page.
org.eclipse.swt.widgets.Control	getControl()           Returns the top level control for this dialog page.
java.lang.String	getDescription()           Returns this dialog page's description text.
java.lang.String	getErrorMessage()           Returns the current error message for this dialog page.
org.eclipse.swt.graphics.Image	getImage()           Returns this dialog page's image.
java.lang.String	getMessage()           Returns the current message for this wizard page.
java.lang.String	getTitle()           Returns this dialog page's title.
void	performHelp()           Notifies that help has been requested for this dialog page.
void	setDescription(java.lang.String description)           Sets this dialog page's description text.
void	setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)           Sets this dialog page's image.
void	setTitle(java.lang.String title)           Set this dialog page's title.
void	setVisible(boolean visible)           Sets the visibility of this dialog page.

 

Method Detail

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Creates the top level control for this dialog page under the given parent composite.

Implementors are responsible for ensuring that the created control can be accessed via getControl

---

dispose

public void dispose()

Disposes the SWT resources allocated by this dialog page.

---

getControl

public org.eclipse.swt.widgets.Control getControl()

Returns the top level control for this dialog page.

May return null if the control has not been created yet.

---

getDescription

public java.lang.String getDescription()

Returns this dialog page's description text.

---

getErrorMessage

public java.lang.String getErrorMessage()

Returns the current error message for this dialog page. May be null to indicate no error message.

An error message should describe some error state, as opposed to a message which may simply provide instruction or information to the user.

---

getImage

public org.eclipse.swt.graphics.Image getImage()

Returns this dialog page's image.

---

getMessage

public java.lang.String getMessage()

Returns the current message for this wizard page.

A message provides instruction or information to the user, as opposed to an error message which should describe some error state.

---

getTitle

public java.lang.String getTitle()

Returns this dialog page's title.

---

performHelp

public void performHelp()

Notifies that help has been requested for this dialog page.

---

setDescription

public void setDescription(java.lang.String description)

Sets this dialog page's description text.

---

setImageDescriptor

public void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)

Sets this dialog page's image.

---

setTitle

public void setTitle(java.lang.String title)

Set this dialog page's title.

---

setVisible

public void setVisible(boolean visible)

Sets the visibility of this dialog page.

---

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

---