Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.dialogs
Class DialogPage

java.lang.Object
  extended by 
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
protected DialogPage ()
          Creates a new empty dialog page.
protected DialogPage ( String title)
          Creates a new dialog page with the given title.
protected DialogPage ( String title, ImageDescriptor image)
          Creates a new dialog page with the given title and image.
 
Method Summary
protected  int convertHeightInCharsToPixels (int chars)
          Returns the number of pixels corresponding to the height of the given number of characters.
protected  int convertHorizontalDLUsToPixels (int dlus)
          Returns the number of pixels corresponding to the given number of horizontal dialog units.
protected  int convertVerticalDLUsToPixels (int dlus)
          Returns the number of pixels corresponding to the given number of vertical dialog units.
protected  int convertWidthInCharsToPixels (int chars)
          Returns the number of pixels corresponding to the width of the given number of characters.
 void dispose ()
          The DialogPage implementation of this IDialogPage method disposes of the page image if it has one.
  Control getControl ()
          Returns the top level control for this dialog page.
  String getDescription ()
          Returns this dialog page's description text.
protected   String getDialogFontName ()
          Returns the symbolic font name used by dialog pages.
  String getErrorMessage ()
          Returns the current error message for this dialog page.
protected   Font getFont ()
          Returns the default font to use for this dialog page.
  Image getImage ()
          Returns this dialog page's image.
  String getMessage ()
          Returns the current message for this wizard page.
 int getMessageType ()
          Returns a value indicating if the message is a an information message, a warning message, or an error message.
  Shell getShell ()
          Returns this dialog page's shell.
  String getTitle ()
          Returns this dialog page's title.
protected   String getToolTipText (int widgetId)
          Deprecated.   
protected  void initializeDialogUnits ( Control testControl)
          Initializes the computation of horizontal and vertical dialog units based on the size of current font.
protected  boolean isControlCreated ()
          Tests whether this page's UI content has already been created.
 void performHelp ()
          This default implementation of an IDialogPage method does nothing.
protected   GridData setButtonLayoutData ( Button button)
          Sets the GridData on the specified button to be one that is spaced for the current dialog page units.
protected  void setControl ( Control newControl)
          Set the control for the receiver.
 void setDescription ( String description)
          Sets this dialog page's description text.
 void setErrorMessage ( String newMessage)
          Sets or clears the error message for this page.
 void setImageDescriptor ( ImageDescriptor desc)
          Sets this dialog page's image.
 void setMessage ( String newMessage)
          Sets or clears the message for this page.
 void setMessage ( String newMessage, int newType)
          Sets the message for this page with an indication of what type of message it is.
 void setTitle ( String title)
          The DialogPage implementation of this IDialogPage method remembers the title in an internal state variable.
 void setVisible (boolean visible)
          The DialogPage implementation of this IDialogPage method 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, or null if 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, or null if none
image - the image for this dialog page, or null if 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 initializeDialogUnits has 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 initializeDialogUnits has 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 initializeDialogUnits has 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 initializeDialogUnits has 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()
The DialogPage implementation of this IDialogPage method disposes of the page image if it has one. Subclasses may extend.

Specified by:
dispose in interface IDialogPage

getControl

public 
Control getControl()
Returns the top level control for this dialog page.

Specified by:
getControl in interface IDialogPage
Returns:
the top level control

getDescription

public 
String getDescription()
Description copied from interface: IDialogPage
Returns this dialog page's description text.

Specified by:
getDescription in interface IDialogPage
Returns:
the description text for this dialog page, or null if 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: IDialogPage
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.

Specified by:
getErrorMessage in interface IDialogPage
Returns:
the error message, or null if 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: IDialogPage
Returns this dialog page's image.

Specified by:
getImage in interface IDialogPage
Returns:
the image for this dialog page, or null if none

getMessage

public 
String getMessage()
Description copied from interface: IDialogPage
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.

Specified by:
getMessage in interface IDialogPage
Specified by:
getMessage in interface IMessageProvider
Returns:
the message, or null if none

getMessageType

public int getMessageType()
Description copied from interface: IMessageProvider
Returns a value indicating if the message is a an information message, a warning message, or an error message.

Returns one of NONE,INFORMATION, WARNING, or ERROR.

Specified by:
getMessageType in interface IMessageProvider
Returns:
the message type

getShell

public 
Shell getShell()
Returns this dialog page's shell. Convenience method for getControl().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: IDialogPage
Returns this dialog page's title.

Specified by:
getTitle in interface IDialogPage
Returns:
the title of this dialog page, or null if none

getToolTipText

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 null if 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 the GridData on the specified button to be one that is spaced for the current dialog page units. The method initializeDialogUnits must be called once before calling this method for the first time.

Parameters:
button - the button to set the GridData
Returns:
the GridData set on the specified button

isControlCreated

protected boolean isControlCreated()
Tests whether this page's UI content has already been created.

Returns:
true if the control has been created, and false if not

performHelp

public void performHelp()
This default implementation of an IDialogPage method does nothing. Subclasses should override to take some action in response to a help request.

Specified by:
performHelp in interface IDialogPage

setControl

protected void setControl(
Control newControl)
Set the control for the receiver.

Parameters:
newControl -

setDescription

public void setDescription(
String description)
Description copied from interface: IDialogPage
Sets this dialog page's description text.

Specified by:
setDescription in interface IDialogPage
Parameters:
description - the description text for this dialog page, or null if none

setErrorMessage

public void setErrorMessage(
String newMessage)
Sets or clears the error message for this page.

Parameters:
newMessage - the message, or null to clear the error message

setImageDescriptor

public void setImageDescriptor(
ImageDescriptor desc)
Description copied from interface: IDialogPage
Sets this dialog page's image.

Specified by:
setImageDescriptor in interface IDialogPage
Parameters:
desc - the image for this dialog page, or null if 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, or null to 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, or ERROR.

Note that for backward compatibility, a message of type ERROR is different than an error message (set using setErrorMessage). 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, or null to clear the message
newType - the message type
Since:
2.0

setTitle

public void setTitle(
String title)
The DialogPage implementation of this IDialogPage method remembers the title in an internal state variable. Subclasses may extend.

Specified by:
setTitle in interface IDialogPage
Parameters:
title - the title of this dialog page, or null if none

setVisible

public void setVisible(boolean visible)
The DialogPage implementation of this IDialogPage method sets the control to the given visibility state. Subclasses may extend.

Specified by:
setVisible in interface IDialogPage
Parameters:
visible - true to make this page visible, and false to hide it

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire