ilog.views.chart

Class IlvScalableFontManager

java.lang.Object

ilog.views.chart.IlvScalableFontManager

All Implemented Interfaces:

Serializable

public class IlvScalableFontManager
extends Object
implements Serializable

A class that provides support for scalable fonts to a Component. An IlvScalableFontManager instance defines an internal scale transform used to compute the new font of components associated with this font manager. This scale transform is computed as the ratio of the current size of a reference component and the reference size. Both the reference component and the reference size must be specified at construction time. Once an IlvScalableFontManager instance has been initialized (that is the scale transform has been defined), you can associate any component with this instance to add support for scalable font to a component. This association is performed by means of the setFontManager(java.awt.Component, ilog.views.chart.IlvScalableFontManager, java.awt.Font) method.

By default, an IlvScalableFontManager instance is installed on an IlvChart and can be accessed by means of the IlvChart.getFontManager() method. The scaling font mode of a chart is disabled by default. You can activate it by means of its IlvChart.setScalingFont(boolean) method.

An IlvScalableFontManager instance can also be used indirectly to get a font derived from a specified font to which the font manager scale transform has been applied (getDeriveFont(java.awt.Font)).

Since:

JViews 5.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvScalableFontManager(Component comp, Dimension refSize) Creates a new IlvScalableFontManager object associated with the specified component with the specified transform parameters and no min/max bounds ratio.
IlvScalableFontManager(Component comp, Dimension refSize, float minRatio, float maxRatio) Creates a new IlvScalableFontManager object associated with the specified component with the specified transform parameters.

Method Summary

Modifier and Type	Method and Description
protected float[]	computeScaleRatios() Returns the scale ratio as an array of float, the x-ratio being the first element of this array, the y-ratio being the second element of this array.
void	dispose() Disposes this scalable font manager.
Component	getComponent() Returns the reference component.
Font	getDeriveFont(Font font) Returns a derived font from the specified font according to the current scale transform parameters.
static IlvScalableFontManager	getFontManager(Component comp) Returns the font manager instance that handles the specified component or null if none is found.
float	getMaxRatio() Returns the maximum value of the scale ratio.
float	getMinRatio() Returns the minimum value of the scale ratio.
Dimension	getRefSize() Returns the reference size.
boolean	isEnabled() Returns whether the scalable mode is enabled.
void	setEnabled(boolean enabled) Sets whether the scalable mode is enabled.
static void	setFontManager(Component comp, IlvScalableFontManager manager, Font refFont) Associates the specified component with the specified font manager.
void	setRefSize(Dimension refSize) Sets the reference size parameter.
void	setScaleTransform(Dimension refSize, float minRatio, float maxRatio) Sets the transform parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvScalableFontManager

public IlvScalableFontManager(Component comp,
                              Dimension refSize)

Creates a new IlvScalableFontManager object associated with the specified component with the specified transform parameters and no min/max bounds ratio.

Parameters:

comp - The component to handle.

refSize - The reference size used to compute the scale ratio. If null, the reference size is equal to the component size when it is shown the first time.

IlvScalableFontManager

public IlvScalableFontManager(Component comp,
                              Dimension refSize,
                              float minRatio,
                              float maxRatio)

Creates a new IlvScalableFontManager object associated with the specified component with the specified transform parameters.

Parameters:

comp - The component to handle.

refSize - The reference size used to compute the scale ratio. If null, the reference size is equal to the component size when it is shown the first time.

minRatio - The minimum scale ratio. If not 0, the scale ratio is bounded to this minimum value.

maxRatio - The maximum scale ratio. If not 0, the scale ratio is bounded to this maximum value.

Method Detail

setScaleTransform

public void setScaleTransform(Dimension refSize,
                              float minRatio,
                              float maxRatio)

Sets the transform parameters.

Parameters:

refSize - The reference size used to compute the scale ratio. If null, the reference size is equal to the component size when it is shown the first time.

minRatio - The minimum scale ratio. If not 0, the scale ratio is bounded to this minimum value.

maxRatio - The maximum scale ratio. If not 0, the scale ratio is bounded to this maximum value.

setRefSize

public void setRefSize(Dimension refSize)

Sets the reference size parameter.

See Also:

setScaleTransform(java.awt.Dimension, float, float)

getRefSize

public Dimension getRefSize()

Returns the reference size.

getComponent

public final Component getComponent()

Returns the reference component. This component is the component used to compute the scale ratio defined as the ratio between the current size of the specified component and the reference size.

getMinRatio

public final float getMinRatio()

Returns the minimum value of the scale ratio. If not 0, the scale ratio is bounded to this minimum value.

getMaxRatio

public final float getMaxRatio()

Returns the maximum value of the scale ratio. If not 0, the scale ratio is bounded to this maximum value.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the scalable mode is enabled.

isEnabled

public final boolean isEnabled()

Returns whether the scalable mode is enabled.

getDeriveFont

public Font getDeriveFont(Font font)

Returns a derived font from the specified font according to the current scale transform parameters.

Parameters:

font - The derived font. This font is the same as the one specified as parameter if the enabled is false, or if the derived font cannot be computed.

computeScaleRatios

protected float[] computeScaleRatios()

Returns the scale ratio as an array of float, the x-ratio being the first element of this array, the y-ratio being the second element of this array. By default, the returned ratio are always equal to each other and computed as:

• The maximum value between the x and y scale factors if both factors are < 1.
• The minimum value between the x and y scale factors if both factors are > 1.
• 1 in other cases.

You may override this method to define your own rule.

getFontManager

public static IlvScalableFontManager getFontManager(Component comp)

Returns the font manager instance that handles the specified component or null if none is found.

setFontManager

public static void setFontManager(Component comp,
                                  IlvScalableFontManager manager,
                                  Font refFont)
                           throws IllegalArgumentException

Associates the specified component with the specified font manager. When a component is linked to a font manager, its font is dynamically computed through a scale transform whose scale ratio is defined according to the current size of a reference component. Note that you should not call this method to unbind the reference component of a font manager. Use the dispose() method instead.

Parameters:

comp - The component to handle.

manager - The font manager that will handle this component. A null value remove this component from its font manager.

refFont - The reference font for this component. May be null if parent font should be used.

Throws:

IllegalArgumentException - If the component is already bound to a font manager, or if it is the reference component of the specified font manager.

dispose

public final void dispose()

Disposes this scalable font manager. This method should be called when this font manager should be released. Note that a font manager instance whose the dispose method has been called should no longer be used.