jhelp.util.gui

Class JHelpRichText

java.lang.Object

jhelp.util.gui.JHelpRichText

public final class JHelpRichText
extends java.lang.Object

Text with the possibility to insert some image in it.
For example it can replace every :) by a picture like

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JHelpRichText.CacheImageElement Cache element of image.
private static class	JHelpRichText.Symbol Represents an association between a symbol (For example :) ) and an image

Field Summary

Fields

Modifier and Type	Field and Description
private Cache<JHelpImage>	CACHE_IMAGES Images cache
private Resources	resources Resources set
private SortedArray<JHelpRichText.Symbol>	symbols Registered associations

Constructor Summary

Constructors

Constructor and Description
JHelpRichText(Resources resources) Create a new instance of JHelpRichText

Method Summary

Methods

Modifier and Type	Method and Description
void	associate(java.lang.String symbol, java.lang.String resource) Add/modify an association for a symbol to an image
JHelpImage	createImage(java.lang.String text, JHelpFont font, int colorText) Create an image for draw the text with symbols replaced by corresponding image
private JHelpImage	createImage(java.lang.String text, JHelpFont font, int colorText, JHelpPaint paintText, JHelpImage textureText) Compute image that draw the text with symbols replaced by corresponding images
JHelpImage	createImage(java.lang.String text, JHelpFont font, JHelpImage textureText) Create an image for draw the text with symbols replaced by corresponding image
JHelpImage	createImage(java.lang.String text, JHelpFont font, JHelpPaint paintText) Create an image for draw the text with symbols replaced by corresponding image
java.lang.String	obtainAssociation(java.lang.String symbol) Obtain the image resource name for a symbol
private JHelpImage	obtainImage(java.lang.String resource, int size) Obtain an image from cache

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_IMAGES

private final Cache<JHelpImage> CACHE_IMAGES

Images cache

resources

private final Resources resources

Resources set

symbols

private final SortedArray<JHelpRichText.Symbol> symbols

Registered associations

Constructor Detail

JHelpRichText

public JHelpRichText(Resources resources)

Create a new instance of JHelpRichText

Parameters:

resources - Resources set where find images

Method Detail

createImage

private JHelpImage createImage(java.lang.String text,
                     JHelpFont font,
                     int colorText,
                     JHelpPaint paintText,
                     JHelpImage textureText)

Compute image that draw the text with symbols replaced by corresponding images

Parameters:

text - Text to draw

font - Font to use for text

colorText - Color for text (Used if paintText and texturePaint are null)

paintText - Paint for text (Used if not null and texturePaint is null)

textureText - Texture for text (Used if not null)

Returns:

Created image

obtainImage

private JHelpImage obtainImage(java.lang.String resource,
                     int size)

Obtain an image from cache

Parameters:

resource - Image resource name

size - Image size

Returns:

The image

associate

public void associate(java.lang.String symbol,
             java.lang.String resource)

Add/modify an association for a symbol to an image

Parameters:

symbol - Symbol to associate

resource - Image resource name

createImage

public JHelpImage createImage(java.lang.String text,
                     JHelpFont font,
                     int colorText)

Create an image for draw the text with symbols replaced by corresponding image

Parameters:

text - Text to convert

font - Font to use for text

colorText - Text color

Returns:

Created image

createImage

public JHelpImage createImage(java.lang.String text,
                     JHelpFont font,
                     JHelpImage textureText)

Create an image for draw the text with symbols replaced by corresponding image

Parameters:

text - Text to convert

font - Font to use for text

textureText - Text texture

Returns:

Created image

createImage

public JHelpImage createImage(java.lang.String text,
                     JHelpFont font,
                     JHelpPaint paintText)

Create an image for draw the text with symbols replaced by corresponding image

Parameters:

text - Text to convert

font - Font to use for text

paintText - Text paint

Returns:

Created image

obtainAssociation

public java.lang.String obtainAssociation(java.lang.String symbol)

Obtain the image resource name for a symbol

Parameters:

symbol - Symbol search

Returns:

Image resource name or null if symbol not registered