Top Description Fields Constructors Methods
org.eclipse.swt.widgets

public Class FontDialog

extends Dialog
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.graphics.*, org.eclipse.swt.internal.*, org.eclipse.swt.internal.gtk.*, org.eclipse.swt.internal.gtk3.*, org.eclipse.swt.internal.gtk4.*
Instances of this class allow the user to select a font from all available fonts in the system.
Styles:
(none)
Events:
(none)

Important Note

This class is not intended to be subclassed.

See Also
SWT Example: ControlExample, Dialog tab, Sample code and further information

Field Summary

Modifier and TypeField and Description
pack-priv FontData
fontData

pack-priv RGB
rgb

Inherited from org.eclipse.swt.widgets.Dialog:
parentstyletitle

Constructor Summary

AccessConstructor and Description
public
FontDialog(Shell
a shell which will be the parent of the new instance
parent)

Constructs a new instance of this class given only its parent.

public
FontDialog(Shell
a shell which will be the parent of the new instance
parent, int
the style of dialog to construct
style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the dialog's effects selection controls are visible and false otherwise
getEffectsVisible()

Returns true if the dialog's effects selection controls are visible, and false otherwise.

public FontData

Returns:

the FontData for the selected font, or null
getFontData()

Deprecated use #getFontList ()
Returns a FontData object describing the font that was selected in the dialog, or null if none is available.
public FontData[]

Returns:

the FontData for the selected font, or null
getFontList()

Returns a FontData set describing the font that was selected in the dialog, or null if none is available.

public RGB

Returns:

the RGB value for the selected color, or null
getRGB()

Returns an RGB describing the color that was selected in the dialog, or null if none is available.

public FontData

Returns:

a FontData object describing the font that was selected, or null if the dialog was cancelled or an error occurred
open()

Makes the dialog visible and brings it to the front of the display.

public void
setEffectsVisible(boolean
whether or not the dialog will show the effects selection controls
visible)

Sets the effects selection controls in the dialog visible if the argument is true, and invisible otherwise.

public void
setFontData(FontData
the FontData to use initially, or null
fontData)

Deprecated use #setFontList (FontData [])
Sets a FontData object describing the font to be selected by default in the dialog, or null to let the platform choose one.
public void
setFontList(FontData[]
the set of FontData objects to use initially, or null to let the platform select a default when open() is called
fontData)

Sets the set of FontData objects describing the font to be selected by default in the dialog, or null to let the platform choose one.

public void
setRGB(RGB
the RGB value to use initially, or null to let the platform select a default when open() is called
rgb)

Sets the RGB describing the color to be selected by default in the dialog, or null to let the platform choose one.

Inherited from org.eclipse.swt.widgets.Dialog:
checkParentcheckStylecheckSubclasserrorgetParentgetStylegetTextsetText

Field Detail

fontDataback to summary
pack-priv FontData fontData
rgbback to summary
pack-priv RGB rgb

Constructor Detail

FontDialogback to summary
public FontDialog(Shell parent)

Constructs a new instance of this class given only its parent.

Parameters
parent:Shell

a shell which will be the parent of the new instance

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException:
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
FontDialogback to summary
public FontDialog(Shell parent, int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters
parent:Shell

a shell which will be the parent of the new instance

style:int

the style of dialog to construct

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException:
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

Method Detail

getEffectsVisibleback to summary
public boolean getEffectsVisible()

Returns true if the dialog's effects selection controls are visible, and false otherwise.

If the platform's font dialog does not have any effects selection controls, then this method always returns false.

Returns:boolean

true if the dialog's effects selection controls are visible and false otherwise

Since
3.8
getFontDataback to summary
public FontData getFontData()

Deprecated

use #getFontList ()

Returns a FontData object describing the font that was selected in the dialog, or null if none is available.

Returns:FontData

the FontData for the selected font, or null

Annotations
@Deprecated
getFontListback to summary
public FontData[] getFontList()

Returns a FontData set describing the font that was selected in the dialog, or null if none is available.

Returns:FontData[]

the FontData for the selected font, or null

Since
2.1.1
getRGBback to summary
public RGB getRGB()

Returns an RGB describing the color that was selected in the dialog, or null if none is available.

Returns:RGB

the RGB value for the selected color, or null

Since
2.1
See Also
PaletteData#getRGBs
openback to summary
public FontData open()

Makes the dialog visible and brings it to the front of the display.

Returns:FontData

a FontData object describing the font that was selected, or null if the dialog was cancelled or an error occurred

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the dialog has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog
setEffectsVisibleback to summary
public void setEffectsVisible(boolean visible)

Sets the effects selection controls in the dialog visible if the argument is true, and invisible otherwise.

By default the effects selection controls are displayed if the platform font dialog supports effects selection.

Parameters
visible:boolean

whether or not the dialog will show the effects selection controls

Since
3.8
setFontDataback to summary
public void setFontData(FontData fontData)

Deprecated

use #setFontList (FontData [])

Sets a FontData object describing the font to be selected by default in the dialog, or null to let the platform choose one.

Parameters
fontData:FontData

the FontData to use initially, or null

Annotations
@Deprecated
setFontListback to summary
public void setFontList(FontData[] fontData)

Sets the set of FontData objects describing the font to be selected by default in the dialog, or null to let the platform choose one.

Parameters
fontData:FontData[]

the set of FontData objects to use initially, or null to let the platform select a default when open() is called

Since
2.1.1
See Also
Font#getFontData
setRGBback to summary
public void setRGB(RGB rgb)

Sets the RGB describing the color to be selected by default in the dialog, or null to let the platform choose one.

Parameters
rgb:RGB

the RGB value to use initially, or null to let the platform select a default when open() is called

Since
2.1
See Also
PaletteData#getRGBs