jhelp.util.gui

Class JHelpFont

java.lang.Object

jhelp.util.gui.JHelpFont

All Implemented Interfaces:

ConstantsGUI

public final class JHelpFont
extends java.lang.Object
implements ConstantsGUI

Represents a font with underline information

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.Font	font Embeded font
private java.awt.FontMetrics	fontMetrics Metrics for measure strings
static char	SMILEY_HAPPY Character unicode for the smiley :)
static char	SMILEY_SAD Character unicode for the smiley :(
private boolean	underline Underline information

Fields inherited from interface jhelp.util.gui.ConstantsGUI

AFFINE_TRANSFORM, FLATNESS, FONT_RENDER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
JHelpFont(java.lang.String familly, int size) Create a new instance of JHelpFont not bold, not italic, not underline
JHelpFont(java.lang.String familly, int size, boolean bold) Create a new instance of JHelpFont not italic, not underline
JHelpFont(java.lang.String familly, int size, boolean bold, boolean italic) Create a new instance of JHelpFont not underline
JHelpFont(java.lang.String familly, int size, boolean bold, boolean italic, boolean underline) Create a new instance of JHelpFont

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Shape	computeShape(java.lang.String string, int x, int y) Compute shape of a string
Pair<java.util.List<JHelpTextLine>,java.awt.Dimension>	computeTextLines(java.lang.String text, JHelpTextAlign textAlign) Compute text lines representation with this font
Pair<java.util.List<JHelpTextLine>,java.awt.Dimension>	computeTextLines(java.lang.String text, JHelpTextAlign textAlign, int limitWidth) Compute text lines representation with this font
Pair<java.util.List<JHelpTextLine>,java.awt.Dimension>	computeTextLines(java.lang.String text, JHelpTextAlign textAlign, int limitWidth, int limitHeight) Compute text lines representation with this font
JHelpMask	createMask(java.lang.String string) Create a mask from a string
java.lang.String	getFamily() Font family
int	getHeight() Font height
int	getSize() Font size
boolean	isBold() Indicates if font is bold
boolean	isItalic() Indicates if font is italic
boolean	isUnderline() Underline status
java.awt.Dimension	stringSize(java.lang.String string) Compute size of a string
int	stringWidth(java.lang.String string) Compute string width
int	underlinePosition(java.lang.String string, int y) Compute underline position

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SMILEY_HAPPY

public static final char SMILEY_HAPPY

Character unicode for the smiley :)

See Also:

Constant Field Values

SMILEY_SAD

public static final char SMILEY_SAD

Character unicode for the smiley :(

See Also:

Constant Field Values

font

private final java.awt.Font font

Embeded font

fontMetrics

private final java.awt.FontMetrics fontMetrics

Metrics for measure strings

underline

private final boolean underline

Underline information

Constructor Detail

JHelpFont

public JHelpFont(java.lang.String familly,
         int size)

Create a new instance of JHelpFont not bold, not italic, not underline

Parameters:

familly - Font family name

size - Font size

JHelpFont

public JHelpFont(java.lang.String familly,
         int size,
         boolean bold)

Create a new instance of JHelpFont not italic, not underline

Parameters:

familly - Font family name

size - Font size

bold - Indicates if bold or not

JHelpFont

public JHelpFont(java.lang.String familly,
         int size,
         boolean bold,
         boolean italic)

Create a new instance of JHelpFont not underline

Parameters:

familly - Font family name

size - Font size

bold - Bold enable/disable

italic - Italic enable/disable

JHelpFont

public JHelpFont(java.lang.String familly,
         int size,
         boolean bold,
         boolean italic,
         boolean underline)

Create a new instance of JHelpFont

Parameters:

familly - Font family name

size - Font size

bold - Bold enable/disable

italic - Italic enable/disable

underline - Underline enable/disable

Method Detail

computeShape

public java.awt.Shape computeShape(java.lang.String string,
                          int x,
                          int y)

Compute shape of a string

Parameters:

string - String

x - X position of top-left

y - Y position of top-left

Returns:

Computed shape

computeTextLines

public Pair<java.util.List<JHelpTextLine>,java.awt.Dimension> computeTextLines(java.lang.String text,
                                                                      JHelpTextAlign textAlign)

Compute text lines representation with this font

Parameters:

text - Text to use

textAlign - Align to use

Returns:

The couple of the list of each computed lines and the total size of all lines together

computeTextLines

public Pair<java.util.List<JHelpTextLine>,java.awt.Dimension> computeTextLines(java.lang.String text,
                                                                      JHelpTextAlign textAlign,
                                                                      int limitWidth)

Compute text lines representation with this font

Parameters:

text - Text to use

textAlign - Align to use

limitWidth - Number maximum of pixels in width

Returns:

The couple of the list of each computed lines and the total size of all lines together

computeTextLines

public Pair<java.util.List<JHelpTextLine>,java.awt.Dimension> computeTextLines(java.lang.String text,
                                                                      JHelpTextAlign textAlign,
                                                                      int limitWidth,
                                                                      int limitHeight)

Compute text lines representation with this font

Parameters:

text - Text to use

textAlign - Align to use

limitWidth - Number maximum of pixels in width

limitHeight - Limit height in pixels

Returns:

The couple of the list of each computed lines and the total size of all lines together

createMask

public JHelpMask createMask(java.lang.String string)

Create a mask from a string

Parameters:

string - String to convert in mask

Returns:

Created mask

getFamily

public java.lang.String getFamily()

Font family

Returns:

Font family

getHeight

public int getHeight()

Font height

Returns:

Font height

getSize

public int getSize()

Font size

Returns:

Font size

isBold

public boolean isBold()

Indicates if font is bold

Returns:

true if font is bold

isItalic

public boolean isItalic()

Indicates if font is italic

Returns:

true if font is italic

isUnderline

public boolean isUnderline()

Underline status

Returns:

Underline status

stringSize

public java.awt.Dimension stringSize(java.lang.String string)

Compute size of a string

Parameters:

string - String to measure

Returns:

String size

stringWidth

public int stringWidth(java.lang.String string)

Compute string width

Parameters:

string - String to measure

Returns:

String width

underlinePosition

public int underlinePosition(java.lang.String string,
                    int y)

Compute underline position

Parameters:

string - String

y - Y of top

Returns:

Y result