Class DialogPage
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogPage
-
- All Implemented Interfaces:
IDialogPage,IMessageProvider
- Direct Known Subclasses:
InstallationPage,PreferencePage,WizardPage
public abstract class DialogPage extends Object implements IDialogPage, IMessageProvider
Abstract base implementation of a dialog page. All dialog pages are subclasses of this one.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedDialogPage()Creates a new empty dialog page.protectedDialogPage(String title)Creates a new dialog page with the given title.protectedDialogPage(String title, ImageDescriptor image)Creates a new dialog page with the given title and image.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected intconvertHeightInCharsToPixels(int chars)Returns the number of pixels corresponding to the height of the given number of characters.protected intconvertHorizontalDLUsToPixels(int dlus)Returns the number of pixels corresponding to the given number of horizontal dialog units.protected intconvertVerticalDLUsToPixels(int dlus)Returns the number of pixels corresponding to the given number of vertical dialog units.protected intconvertWidthInCharsToPixels(int chars)Returns the number of pixels corresponding to the width of the given number of characters.voiddispose()TheDialogPageimplementation of thisIDialogPagemethod disposes of the page image if it has one.ControlgetControl()Returns the top level control for this dialog page.StringgetDescription()Returns this dialog page's description text.protected StringgetDialogFontName()Returns the symbolic font name used by dialog pages.StringgetErrorMessage()Returns the current error message for this dialog page.protected FontgetFont()Returns the default font to use for this dialog page.ImagegetImage()Returns this dialog page's image.StringgetMessage()Returns the current message for this wizard page.intgetMessageType()Returns a value indicating if the message is a an information message, a warning message, or an error message.ShellgetShell()Returns this dialog page's shell.StringgetTitle()Returns this dialog page's title.protected StringgetToolTipText(int widgetId)Deprecated.protected voidinitializeDialogUnits(Control testControl)Initializes the computation of horizontal and vertical dialog units based on the size of current font.protected booleanisControlCreated()Tests whether this page's UI content has already been created.voidperformHelp()This default implementation of anIDialogPagemethod does nothing.protected GridDatasetButtonLayoutData(Button button)Sets theGridDataon the specified button to be one that is spaced for the current dialog page units.protected voidsetControl(Control newControl)Set the control for the receiver.voidsetDescription(String description)Sets this dialog page's description text.voidsetErrorMessage(String newMessage)Sets or clears the error message for this page.voidsetImageDescriptor(ImageDescriptor desc)Sets this dialog page's image.voidsetMessage(String newMessage)Sets or clears the message for this page.voidsetMessage(String newMessage, int newType)Sets the message for this page with an indication of what type of message it is.voidsetTitle(String title)TheDialogPageimplementation of thisIDialogPagemethod remembers the title in an internal state variable.voidsetVisible(boolean visible)TheDialogPageimplementation of thisIDialogPagemethod sets the control to the given visibility state.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl
-
-
-
-
Constructor Detail
-
DialogPage
protected DialogPage()
Creates a new empty dialog page.
-
DialogPage
protected DialogPage(String title)
Creates a new dialog page with the given title.- Parameters:
title- the title of this dialog page, ornullif none
-
DialogPage
protected DialogPage(String title, ImageDescriptor image)
Creates a new dialog page with the given title and image.- Parameters:
title- the title of this dialog page, ornullif noneimage- the image for this dialog page, ornullif none
-
-
Method Detail
-
convertHeightInCharsToPixels
protected int convertHeightInCharsToPixels(int chars)
Returns the number of pixels corresponding to the height of the given number of characters.This method may only be called after
initializeDialogUnitshas been called.Clients may call this framework method, but should not override it.
- Parameters:
chars- the number of characters- Returns:
- the number of pixels
-
convertHorizontalDLUsToPixels
protected int convertHorizontalDLUsToPixels(int dlus)
Returns the number of pixels corresponding to the given number of horizontal dialog units.This method may only be called after
initializeDialogUnitshas been called.Clients may call this framework method, but should not override it.
- Parameters:
dlus- the number of horizontal dialog units- Returns:
- the number of pixels
-
convertVerticalDLUsToPixels
protected int convertVerticalDLUsToPixels(int dlus)
Returns the number of pixels corresponding to the given number of vertical dialog units.This method may only be called after
initializeDialogUnitshas been called.Clients may call this framework method, but should not override it.
- Parameters:
dlus- the number of vertical dialog units- Returns:
- the number of pixels
-
convertWidthInCharsToPixels
protected int convertWidthInCharsToPixels(int chars)
Returns the number of pixels corresponding to the width of the given number of characters.This method may only be called after
initializeDialogUnitshas been called.Clients may call this framework method, but should not override it.
- Parameters:
chars- the number of characters- Returns:
- the number of pixels
-
dispose
public void dispose()
TheDialogPageimplementation of thisIDialogPagemethod disposes of the page image if it has one. Subclasses may extend.- Specified by:
disposein interfaceIDialogPage
-
getControl
public Control getControl()
Returns the top level control for this dialog page.- Specified by:
getControlin interfaceIDialogPage- Returns:
- the top level control
-
getDescription
public String getDescription()
Description copied from interface:IDialogPageReturns this dialog page's description text.- Specified by:
getDescriptionin interfaceIDialogPage- Returns:
- the description text for this dialog page,
or
nullif none
-
getDialogFontName
protected String getDialogFontName()
Returns the symbolic font name used by dialog pages.- Returns:
- the symbolic font name
-
getErrorMessage
public String getErrorMessage()
Description copied from interface:IDialogPageReturns the current error message for this dialog page. May benullto 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.
- Specified by:
getErrorMessagein interfaceIDialogPage- Returns:
- the error message, or
nullif none
-
getFont
protected Font getFont()
Returns the default font to use for this dialog page.- Returns:
- the font
-
getImage
public Image getImage()
Description copied from interface:IDialogPageReturns this dialog page's image.- Specified by:
getImagein interfaceIDialogPage- Returns:
- the image for this dialog page, or
nullif none
-
getMessage
public String getMessage()
Description copied from interface:IDialogPageReturns 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.
- Specified by:
getMessagein interfaceIDialogPage- Specified by:
getMessagein interfaceIMessageProvider- Returns:
- the message, or
nullif none
-
getMessageType
public int getMessageType()
Description copied from interface:IMessageProviderReturns a value indicating if the message is a an information message, a warning message, or an error message.Returns one of
NONE,INFORMATION,WARNING, orERROR.- Specified by:
getMessageTypein interfaceIMessageProvider- Returns:
- the message type
-
getShell
public Shell getShell()
Returns this dialog page's shell. Convenience method forgetControl().getShell(). This method may only be called after the page's control has been created.- Returns:
- the shell
-
getTitle
public String getTitle()
Description copied from interface:IDialogPageReturns this dialog page's title.- Specified by:
getTitlein interfaceIDialogPage- Returns:
- the title of this dialog page,
or
nullif none
-
getToolTipText
@Deprecated protected final String getToolTipText(int widgetId)
Deprecated.Returns the tool tip text for the widget with the given id.The default implementation of this framework method does nothing and returns
null. Subclasses may override.- Parameters:
widgetId- the id of the widget for which hover help is requested- Returns:
- the tool tip text, or
nullif none
-
initializeDialogUnits
protected void initializeDialogUnits(Control testControl)
Initializes the computation of horizontal and vertical dialog units based on the size of current font.This method must be called before any of the dialog unit based conversion methods are called.
- Parameters:
testControl- a control from which to obtain the current font
-
setButtonLayoutData
protected GridData setButtonLayoutData(Button button)
Sets theGridDataon the specified button to be one that is spaced for the current dialog page units. The methodinitializeDialogUnitsmust be called once before calling this method for the first time.- Parameters:
button- the button to set theGridData- Returns:
- the
GridDataset on the specified button
-
isControlCreated
protected boolean isControlCreated()
Tests whether this page's UI content has already been created.- Returns:
trueif the control has been created, andfalseif not
-
performHelp
public void performHelp()
This default implementation of anIDialogPagemethod does nothing. Subclasses should override to take some action in response to a help request.- Specified by:
performHelpin interfaceIDialogPage
-
setControl
protected void setControl(Control newControl)
Set the control for the receiver.- Parameters:
newControl- control to set
-
setDescription
public void setDescription(String description)
Description copied from interface:IDialogPageSets this dialog page's description text.- Specified by:
setDescriptionin interfaceIDialogPage- Parameters:
description- the description text for this dialog page, ornullif none
-
setErrorMessage
public void setErrorMessage(String newMessage)
Sets or clears the error message for this page.- Parameters:
newMessage- the message, ornullto clear the error message
-
setImageDescriptor
public void setImageDescriptor(ImageDescriptor desc)
Description copied from interface:IDialogPageSets this dialog page's image.- Specified by:
setImageDescriptorin interfaceIDialogPage- Parameters:
desc- the image for this dialog page, ornullif none
-
setMessage
public void setMessage(String newMessage)
Sets or clears the message for this page.This is a shortcut for
setMessage(newMesasge, NONE)- Parameters:
newMessage- the message, ornullto clear the message
-
setMessage
public void setMessage(String newMessage, int newType)
Sets the message for this page with an indication of what type of message it is.The valid message types are one of
NONE,INFORMATION,WARNING, orERROR.Note that for backward compatibility, a message of type
ERRORis different than an error message (set usingsetErrorMessage). An error message overrides the current message until the error message is cleared. This method replaces the current message and does not affect the error message.- Parameters:
newMessage- the message, ornullto clear the messagenewType- the message type- Since:
- 2.0
-
setTitle
public void setTitle(String title)
TheDialogPageimplementation of thisIDialogPagemethod remembers the title in an internal state variable. Subclasses may extend.- Specified by:
setTitlein interfaceIDialogPage- Parameters:
title- the title of this dialog page, ornullif none
-
setVisible
public void setVisible(boolean visible)
TheDialogPageimplementation of thisIDialogPagemethod sets the control to the given visibility state. Subclasses may extend.- Specified by:
setVisiblein interfaceIDialogPage- Parameters:
visible-trueto make this page visible, andfalseto hide it
-
-