Font Definitions

Identifier: org.eclipse.ui.fontDefinitions

Since: Release 2.1

Description: This extension point is used to register fonts with the JFace FontRegistry and with the workbench preference store for use by the Fonts preference page.

Configuration Markup:

   <!ELEMENT extension (fontDefinition*)>

   <!ATTLIST extension
     point CDATA #REQUIRED
     id    CDATA #IMPLIED
     name  CDATA #IMPLIED
   >

   <!ELEMENT fontDefinition (description?)>

   <!ATTLIST fontDefinition
     id         CDATA #REQUIRED
     label      CDATA #REQUIRED
     defaultsTo CDATA #IMPLIED
   >

   <!ELEMENT description (#CDATA)>

   a short description of the fonts usage

Examples: Following is an example of an a font definition extension:

   <extension point="org.eclipse.ui.fontDefinition"> 
      <fontDefinition 
         id="org.eclipse.examples.textFont" 
         label="Text"> 
         <description>
            The text font
         </description>
      </fontDefinition> 

      <fontDefinition 
        id="org.eclipse.examples.userFont" 
        label="User"
        defaultsTo="org.eclipse.jface.textFont"> 
        <description>
           The user font
        </description>
      </fontDefinition> 
   </extension> 

API Information: The defaultsTo tag is used as a directive by the Workbench to set the value of the font definition to the value of defaultsTo whenever the defaultsTo fontDefinition is updated. This only occurs if the fontDefinition is at its default value - once it is set by the user this updates will not occur. The workbench provides 4 fonts:

org.eclipse.jface.bannerfont. The banner font is used in wizard banners.
org.eclipse.jface.dialogfont. The dialog font is the font for widgets in dialogs.
org.eclipse.jface.headerfont. The header font is used for section headers in composite text pages.
org.eclipse.jface.textfont. The text font is used by text editors.

Supplied Implementation: The workbench provides the font definitions for the text, dialog, banner and header fonts.

Copyright (c) 2002 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html