org.scilab.forge.scirenderer.texture
Class TextEntity

java.lang.Object
  extended by org.scilab.forge.scirenderer.texture.TextEntity

public class TextEntity
extends java.lang.Object

Author:
Pierre Lando

Field Summary
static boolean DEFAULT_TEXT_ANTI_ALIASED
          The default text anti-aliased status.
static Color DEFAULT_TEXT_COLOR
          The default text color.
static boolean DEFAULT_TEXT_USE_FRACTIONAL_METRICS
          The default text use fractional matrix status.
 
Constructor Summary
TextEntity(java.lang.String text)
          Default constructor.
 
Method Summary
 java.awt.Font getFont()
          Return the text font.
 java.awt.Dimension getSize()
          Return the dimension in pixel of the text entity.
 java.lang.String getText()
          Return the text content.
 Color getTextColor()
          Return the text color.
 boolean isTextAntiAliased()
          Return the text anti-aliased status.
 boolean isTextUseFractionalMetrics()
          Return the text use fractional metrics status.
 boolean isValid()
          TextEntity validity getter.
 void setFont(java.awt.Font font)
          Set the text font.
 void setText(java.lang.String text)
          Set the text content.
 void setTextAntiAliased(boolean textAntiAliased)
          Set the text anti-aliased status.
 void setTextColor(Color textColor)
          Set the text color.
 void setTextUseFractionalMetrics(boolean textUseFractionalMetrics)
          Set the text use fractional metrics status.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_TEXT_COLOR

public static final Color DEFAULT_TEXT_COLOR
The default text color.


DEFAULT_TEXT_ANTI_ALIASED

public static final boolean DEFAULT_TEXT_ANTI_ALIASED
The default text anti-aliased status.

See Also:
Constant Field Values

DEFAULT_TEXT_USE_FRACTIONAL_METRICS

public static final boolean DEFAULT_TEXT_USE_FRACTIONAL_METRICS
The default text use fractional matrix status.

See Also:
Constant Field Values
Constructor Detail

TextEntity

public TextEntity(java.lang.String text)
Default constructor.

Parameters:
text - the text content.
Method Detail

getText

public java.lang.String getText()
Return the text content.

Returns:
the text content.

setText

public void setText(java.lang.String text)
Set the text content.

Parameters:
text - the new text content.

getFont

public java.awt.Font getFont()
Return the text font.

Returns:
the text font.

setFont

public void setFont(java.awt.Font font)
Set the text font.

Parameters:
font - the new text font.

getTextColor

public Color getTextColor()
Return the text color.

Returns:
the text color.

setTextColor

public void setTextColor(Color textColor)
Set the text color.

Parameters:
textColor - the new text color.

isTextAntiAliased

public boolean isTextAntiAliased()
Return the text anti-aliased status.

Returns:
the text anti-aliased status.

setTextAntiAliased

public void setTextAntiAliased(boolean textAntiAliased)
Set the text anti-aliased status.

Parameters:
textAntiAliased - the new text anti-aliased status.

isTextUseFractionalMetrics

public boolean isTextUseFractionalMetrics()
Return the text use fractional metrics status.

Returns:
the text use fractional metrics status.

setTextUseFractionalMetrics

public void setTextUseFractionalMetrics(boolean textUseFractionalMetrics)
Set the text use fractional metrics status.

Parameters:
textUseFractionalMetrics - the new text use fractional metrics status.

isValid

public boolean isValid()
TextEntity validity getter.

Returns:
true if the text entity is valid.

getSize

public java.awt.Dimension getSize()
Return the dimension in pixel of the text entity.

Returns:
the dimension in pixel of the text entity.