Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
EchoPoint API - 3.0.0b5
App Webcontainer
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

echopoint.util
Class FontKit

java.lang.Object
  extended by echopoint.util.FontKit

public class FontKit
extends Object

A utility to class to help with Font manipulation

Author:
Brad Baker

Method Summary
static void addBold(Component c)
          Adds bold to a Component's font.
static Font addBold(Font font)
          Adds the Font.BOLD attribute to an exisitng Font object and returns a new Font.
static void addItalic(Component c)
          Adds italic to a Component's font.
static Font addItalic(Font font)
          Adds the Font.ITALIC attribute to an exisitng Font object and returns a new Font.
static void addSize(Component c, int sizeDelta)
          Sets a component's font smaller or large by the specified delta amount.
static Font addSize(Font font, int sizeDelta)
          Makes a font smaller or larger by adding the specified amount to its current font size.
static void addStyle(Component c, int style)
          Adds the specified style to a Component's font.
static Font addStyle(Font font, int style)
          Adds the specified style to the Font and returns a new Font.
static void addUnderline(Component c)
          Adds underline to a Component's font.
static Font addUnderline(Font font)
          Adds the Font.UNDERLINE attribute to an exisitng Font object and returns a new Font.
static Font findFont(Component comp)
          Searchs the heirarchy tree of the component and finds the first non null Font object.
static Font font(String fontString)
          Shortcut synonym for makeFont(fontString);
static Font.Typeface getSystemTypeface(String name)
          Returns one the standard Echo Font.Typefaces if the name string matches the first Typeface in the chain.
static boolean isFont(String fontString)
          Returns true if the fontString is a valid representation of a Font value.
static Font makeAwtFont(Font echoFont, Font awtDefaultFont)
          Creates an AWT font object from a Echo font object.
static String makeCSSFont(Font font)
          Makes a W3C CSS font string in the special format fontstyle, fontsize, fontnames
static Font makeFont(String fontString)
          Returns the Font value of the given Font string representation.
static String makeFontString(Font font)
          Makes a string representation of a font in the format font(fontName, fontStyle, fontSize) where : fontName - is a font name such as 'Verdana' or 'Times New Roman'.
static Font.Typeface makeTypeface(String typeFaceNames)
          This will return a Font.Typeface object by first rtying to match the names against System provided ones and failing that it will create a font.Typeface for you.
static void setBold(Component c)
          Sets Component's font to bold.
static void setItalic(Component c)
          Sets Component's font to italic.
static Font setName(Font font, String fontName)
          Returns a new Font object, based on font, that has the specified fontName.
static Font setNames(Font font, Font.Typeface typeFace)
          Returns a new Font object, based on font, that has the specified typeFace.
static void setSize(Component c, int size)
          Sets the size of a Component's font.
static Font setSize(Font font, int size)
          Returns a new Font object, based on font, that has the specified size.
static Font setStyle(Font font, int style)
          Returns a new Font object, based on font, that has the specified style.
static void setUnderline(Component c)
          Sets Component's font to underline.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

makeAwtFont

public static Font makeAwtFont(Font echoFont,
                               Font awtDefaultFont)
Creates an AWT font object from a Echo font object. This is useful for drawing on AWT images.

Parameters:
echoFont - - the nextapp.echo2.app.Font object to convert
awtDefaultFont - - a default AWT font to use if the conversion cant be done.
Returns:
- a new java.awt.Font object base don echoFont.

makeCSSFont

public static String makeCSSFont(Font font)
Makes a W3C CSS font string in the special format

fontstyle, fontsize, fontnames

Parameters:
font - - the font to represent as a W3C CSS string
Returns:
the W3C CSS string represenation

addBold

public static void addBold(Component c)
Adds bold to a Component's font.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
addBold(Font)

addItalic

public static void addItalic(Component c)
Adds italic to a Component's font.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
addItalic(Font)

addUnderline

public static void addUnderline(Component c)
Adds underline to a Component's font.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
addUnderline(Font)

addStyle

public static void addStyle(Component c,
                            int style)
Adds the specified style to a Component's font.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
addStyle(Font, int)

addSize

public static void addSize(Component c,
                           int sizeDelta)
Sets a component's font smaller or large by the specified delta amount.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
sizeDelta - - a positive or negative delta amount
See Also:
addSize(Font, int)

setBold

public static void setBold(Component c)
Sets Component's font to bold.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
setStyle(Font, int)

setItalic

public static void setItalic(Component c)
Sets Component's font to italic.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
setStyle(Font, int)

setUnderline

public static void setUnderline(Component c)
Sets Component's font to underline.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
See Also:
setStyle(Font, int)

setSize

public static void setSize(Component c,
                           int size)
Sets the size of a Component's font.

If the component has no font, a findFont is performed and the result is set in as the font.

Parameters:
c - - the component in question
size - - the new font size
See Also:
setSize(Font, int)

findFont

public static Font findFont(Component comp)
Searchs the heirarchy tree of the component and finds the first non null Font object. It will return Font(Font.SANS_SERIF,Font.PLAIN,new Extent(10,Extent.PT) if no ancestor components have a Font set.

makeFont

public static Font makeFont(String fontString)
Returns the Font value of the given Font string representation.

The allowable forms are :

- fontName,fontStyle,fontSize
- font( fontName, fontStyle, fontSize)

where

fontName - eg. Verdana or 'Times New Roman'. If multiple font names are specified or there is white space in the font name, then it must be enclosed in single quotes and commas eg. 'Verdana, Times New Roman, Tahoma'.
fontStyle - PLAIN|BOLD|ITALIC|UNDERLINE|OVERLINE|LINETHROUGH or nothing! (this is case insenstive)
fontSize - an integer size value or an Extent value. (In the case where only an integer is specified, the default Extent units are points (pt).

Examples :

        Verdana,,9                                                                      - is a legal font string
        Verdana,PLAIN,9                                                         - is a legal font string
        Verdana,plain,9                                                         - is a legal font string
        Verdana,plain,9em                                                       - is a legal font string
        Verdana,plain,9pt                                                       - is a legal font string
        Verdana,bold|italic,9                                           - is a legal font string
        'Times New Roman',plain,9                                       - is a legal font string
        'Verdana, Times New Roman',plain,9                      - is a legal font string
 
        font(Verdana,,9)                                                        - is a legal font string
        font(Verdana,PLAIN,9pt)                                         - is a legal font string
        font(Verdana,plain,9)                                           - is a legal font string
        font(Verdana,bold|italic,9em)                           - is a legal font string
        font('Verdana, Times New Roman',plain,9)        - is a legal font string
 
        Verdana, 3, 9                                                           - is an ILLEGAL font string
        Verdana, Times New Roman,PLAIN,9                        - is an ILLEGAL font string
        font(Verdana, 3, 9)                                                     - is an ILLEGAL font string
        font(Verdana, Times New Roman,PLAIN,9)          - is an ILLEGAL font string

The results of this operations is cached in a global static cache, so that Font objects can be re-used. This is okay since Font objects are immutable once created.

Parameters:
fontString - - the font string in question
Returns:
a new Font object
Throws:
IllegalArgumentException - - if the fontString is in an invalid format

font

public static Font font(String fontString)
Shortcut synonym for makeFont(fontString);

See Also:
makeFont(String)

isFont

public static boolean isFont(String fontString)
Returns true if the fontString is a valid representation of a Font value.

The allowable forms are :

- fontName,fontStyle,fontSize
- font( fontName, fontStyle, fontSize)

where

fontName - eg. Verdana or 'Times New Roman'. If multiple font names are specified or there is white space in the font name, then it must be enclosed in single quotes and commas eg. 'Verdana, Times New Roman, Tahoma'.
fontStyle - PLAIN|BOLD|ITALIC|UNDERLINE|OVERLINE|LINETHROUGH or nothing! (this is case insenstive)
fontSize - an integer size value or an Extent value. (In the case where only an integer is specified, the default Extent units are points (pt).

Examples :

        Verdana,,9                                                                      - is a legal font string
        Verdana,PLAIN,9                                                         - is a legal font string
        Verdana,plain,9                                                         - is a legal font string
        Verdana,bold|italic,9                                           - is a legal font string
        'Times New Roman',plain,9                                       - is a legal font string
        'Verdana, Times New Roman',plain,9                      - is a legal font string
 
        font(Verdana,,9)                                                        - is a legal font string
        font(Verdana,PLAIN,9)                                           - is a legal font string
        font(Verdana,plain,9)                                           - is a legal font string
        font(Verdana,bold|italic,9)                                     - is a legal font string
        font('Verdana, Times New Roman',plain,9)        - is a legal font string
 
        Verdana, 3, 9                                                           - is an ILLEGAL font string
        Verdana, Times New Roman,PLAIN,9                        - is an ILLEGAL font string
        font(Verdana, 3, 9)                                                     - is an ILLEGAL font string
        font(Verdana, Times New Roman,PLAIN,9)          - is an ILLEGAL font string

Parameters:
fontString - - the font string representation to check
Returns:
true if the string is in the correct format

makeTypeface

public static Font.Typeface makeTypeface(String typeFaceNames)
This will return a Font.Typeface object by first rtying to match the names against System provided ones and failing that it will create a font.Typeface for you.

Multi named type faces must be encluded in spaces.

Valid typeface name forms are : 

 'Font1, Font 2, Font2'
 'Font1'
 Font1
 




Parameters:
typeFaceNames - - the name(s) of the intended typeface

makeFontString

public static String makeFontString(Font font)
Makes a string representation of a font in the format

font(fontName, fontStyle, fontSize)

where :

fontName - is a font name such as 'Verdana' or 'Times New Roman'. fontStyle - PLAIN|BOLD|ITALIC|UNDERLINE fontSize - an integer size value or an Extent value. (In the case where only an integer is specified, the default Extent units are points (pt).

Parameters:
font - - the font to make into a String representation
Returns:
the string representation of the font

getSystemTypeface

public static Font.Typeface getSystemTypeface(String name)
Returns one the standard Echo Font.Typefaces if the name string matches the first Typeface in the chain.

Parameters:
name - - the font typeface name to match.
Returns:
a TypeFace of null if a system one cannot be found

addBold

public static Font addBold(Font font)
Adds the Font.BOLD attribute to an exisitng Font object and returns a new Font.

Parameters:
font - - the font in question
Returns:
- a new Font object

addItalic

public static Font addItalic(Font font)
Adds the Font.ITALIC attribute to an exisitng Font object and returns a new Font.

Parameters:
font - - the font in question
Returns:
- a new Font object

addUnderline

public static Font addUnderline(Font font)
Adds the Font.UNDERLINE attribute to an exisitng Font object and returns a new Font.

Parameters:
font - - the font in question
Returns:
- a new Font object

addStyle

public static Font addStyle(Font font,
                            int style)
Adds the specified style to the Font and returns a new Font.

Parameters:
font - - the font in question
style - - the new font style to added to the font
Returns:
- a new Font object

addSize

public static Font addSize(Font font,
                           int sizeDelta)
Makes a font smaller or larger by adding the specified amount to its current font size. The Font is made smaller if a negative value is used.

Parameters:
font - - the font in question
sizeDelta - - the size delta to add to the current size
Returns:
- a new Font object

setSize

public static Font setSize(Font font,
                           int size)
Returns a new Font object, based on font, that has the specified size.

Parameters:
font - - the font to use as a template
size - - the new size
Returns:
a new Font object with the new size

setStyle

public static Font setStyle(Font font,
                            int style)
Returns a new Font object, based on font, that has the specified style.

Parameters:
font - - the font to use as a template
style - - the new style
Returns:
a new Font object with the new style

setNames

public static Font setNames(Font font,
                            Font.Typeface typeFace)
Returns a new Font object, based on font, that has the specified typeFace.

Parameters:
font - - the font to use as a template
typeFace - - the new TypeFace to use
Returns:
a new Font object with the new font names

setName

public static Font setName(Font font,
                           String fontName)
Returns a new Font object, based on font, that has the specified fontName.

If fontName has whitespace in it, then you need to surround it in single quotes.

Parameters:
font - - the font to use as a template
fontName - - the new font name to use
Returns:
a new Font object with the new font name
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
EchoPoint API - 3.0.0b5
App Webcontainer
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD