Java Doc for DialogPage.java in » IDE-Eclipse » jface » org » eclipse » jface » dialogs » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » jface » org.eclipse.jface.dialogs

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.jface.dialogs .DialogPage

All known Subclasses:   org.eclipse.jface.preference .PreferencePage,  org.eclipse.jface.wizard .WizardPage,
DialogPage
abstract public class DialogPage implements IDialogPage,IMessageProvider(Code)
Abstract base implementation of a dialog page. All dialog pages are subclasses of this one.

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.
public void dispose()
     The DialogPage implementation of an IDialogPage method does nothing.
public Control getControl()
     Returns the top level control for this dialog page.
public String getDescription()

protected String getDialogFontName()
     Returns the symbolic font name used by dialog pages.
public String getErrorMessage()

protected Font getFont()
     Returns the default font to use for this dialog page.
public Image getImage()

public String getMessage()

public int getMessageType()

public Shell getShell()
     Returns this dialog page's shell.
public String getTitle()

final protected String getToolTipText(int widgetId)
     Returns the tool tip text for the widget with the given id.
The default implementation of this framework method does nothing and returns null.
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.
public 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.
public void setDescription(String description)

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

public void setMessage(String newMessage)
     Sets or clears the message for this page.
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).
public void setTitle(String title)
     The DialogPage implementation of this IDialogPage method remembers the title in an internal state variable.
public void setVisible(boolean visible)
     The DialogPage implementation of this IDialogPage method sets the control to the given visibility state.

Constructor Detail
DialogPage
protected DialogPage()(Code)
Creates a new empty dialog page.

DialogPage
protected DialogPage(String title)(Code)
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)(Code)
Creates a new dialog page with the given title and image.
Parameters:
  title - the title of this dialog page, or null if none
Parameters:
  image - the image for this dialog page, or null if none

Method Detail
convertHeightInCharsToPixels
protected int convertHeightInCharsToPixels(int chars)(Code)
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 the number of pixels

convertHorizontalDLUsToPixels
protected int convertHorizontalDLUsToPixels(int dlus)(Code)
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 the number of pixels

convertVerticalDLUsToPixels
protected int convertVerticalDLUsToPixels(int dlus)(Code)
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 the number of pixels

convertWidthInCharsToPixels
protected int convertWidthInCharsToPixels(int chars)(Code)
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 the number of pixels

dispose
public void dispose()(Code)
The DialogPage implementation of an IDialogPage method does nothing. Subclasses may extend.

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

getDescription
public String getDescription()(Code)

getDialogFontName
protected String getDialogFontName()(Code)
Returns the symbolic font name used by dialog pages. the symbolic font name

getErrorMessage
public String getErrorMessage()(Code)

getFont
protected Font getFont()(Code)
Returns the default font to use for this dialog page. the font

getImage
public Image getImage()(Code)

getMessage
public String getMessage()(Code)

getMessageType
public int getMessageType()(Code)

getShell
public Shell getShell()(Code)
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. the shell

getTitle
public String getTitle()(Code)

getToolTipText
final protected String getToolTipText(int widgetId)(Code)
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 the tool tip text, or null if none

initializeDialogUnits
protected void initializeDialogUnits(Control testControl)(Code)
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

isControlCreated
protected boolean isControlCreated()(Code)
Tests whether this page's UI content has already been created. true if the control has been created, andfalse if not

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

setButtonLayoutData
protected GridData setButtonLayoutData(Button button)(Code)
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 the GridData set on the specified button

setControl
protected void setControl(Control newControl)(Code)
Set the control for the receiver.
Parameters:
  newControl -

setDescription
public void setDescription(String description)(Code)

setErrorMessage
public void setErrorMessage(String newMessage)(Code)
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)(Code)

setMessage
public void setMessage(String newMessage)(Code)
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)(Code)
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
Parameters:
  newType - the message type
since:
   2.0

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

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

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.