org.jsfml.graphics

Class Text

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Text

All Implemented Interfaces:

Drawable, TextStyle, Transformable

public class Text
extends SFMLNativeObject
implements Drawable, TextStyle

Represents a graphical text that can be transformed and drawn to a render target.

This class implements the TextStyle interface for quick access to the constants provided by it.

Field Summary

Fields inherited from interface org.jsfml.graphics.TextStyle

BOLD, ITALIC, REGULAR, UNDERLINED

Constructor Summary

Constructors

Constructor and Description
Text() Creates a new empty text.
Text(String string, ConstFont font) Creates a new text.
Text(String string, ConstFont font, int characterSize) Creates a new text.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(RenderTarget target, RenderStates states) Draws the object to a render target.
Vector2f	findCharacterPos(int i) Returns the position of a character inside the string.
int	getCharacterSize() Gets the text's current font size.
Color	getColor() Gets the text's current font color.
ConstFont	getFont() Gets the text's current font.
FloatRect	getGlobalBounds() Gets the text's global bounding rectangle in the scene, taking the text's transformation into account.
Transform	getInverseTransform() Gets the inverse of the current transformation matrix.
FloatRect	getLocalBounds() Gets the text's local bounding rectangle, not taking the text's transformation into account.
Vector2f	getOrigin() Gets the origin of this object.
Vector2f	getPosition() Gets the position of this object.
float	getRotation() Gets the rotation angle of this object.
Vector2f	getScale() Gets the scaling of this object.
String	getString() Gets the text's string.
int	getStyle() Gets the text's current font style.
Transform	getTransform() Gets the current transformation matrix.
void	move(float x, float y) Moves this object.
void	move(Vector2f v) Moves the object.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	rotate(float angle) Rotates this object around its origin.
void	scale(float x, float y) Scales the object, using its origin as the scaling center.
void	scale(Vector2f factors) Scales the object, using its origin as the scaling center.
void	setCharacterSize(int characterSize) Sets the font size for this text.
void	setColor(Color color) Sets the font color for this text.
void	setFont(ConstFont font) Sets the text's font.
void	setOrigin(float x, float y) Sets the rotation, scaling and drawing origin of this object.
void	setOrigin(Vector2f v) Sets the rotation, scaling and drawing origin of this object.
void	setPosition(float x, float y) Sets the position of this object in the scene so that its origin will be exactly on it.
void	setPosition(Vector2f v) Sets the position of this object in the scene so that its origin will be exactly on it.
void	setRotation(float angle) Sets the rotation of this object around its origin.
void	setScale(float x, float y) Sets the scaling of this object, using its origin as the scaling center.
void	setScale(Vector2f v) Sets the scaling of this object, using its origin as the scaling center.
void	setString(String string) Sets the string to display.
void	setStyle(int style) Sets the font drawing style.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

Text

public Text()

Creates a new empty text.

Text

public Text(String string,
    ConstFont font)

Creates a new text.

Parameters:

string - The text string.

font - The font to use.

Text

public Text(String string,
    ConstFont font,
    int characterSize)

Creates a new text.

Parameters:

string - The text string.

font - The font to use.

characterSize - The font size.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

setString

public void setString(String string)

Sets the string to display.

Parameters:

string - The string to display.

setFont

public void setFont(ConstFont font)

Sets the text's font.

Parameters:

font - The text's font.

setCharacterSize

public void setCharacterSize(int characterSize)

Sets the font size for this text.

Parameters:

characterSize - The font size for this text.

setStyle

public void setStyle(int style)

Sets the font drawing style.

Parameters:

style - The font drawing style. This should be an combination (OR) of the style flags TextStyle.BOLD, TextStyle.ITALIC and TextStyle.UNDERLINED, or TextStyle.REGULAR for the regular style.

setColor

public void setColor(Color color)

Sets the font color for this text.

Parameters:

color - The font color for this text.

getString

public String getString()

Gets the text's string.

Returns:

The text strng.

getFont

public ConstFont getFont()

Gets the text's current font.

Returns:

The text's current font. This may be null if no font has been set yet.

getCharacterSize

public int getCharacterSize()

Gets the text's current font size.

Returns:

The text's current font size.

getStyle

public int getStyle()

Gets the text's current font style.

Returns:

The text's current font style.

See Also:

setStyle(int)

getColor

public Color getColor()

Gets the text's current font color.

Returns:

The text's current font color.

findCharacterPos

public Vector2f findCharacterPos(int i)

Returns the position of a character inside the string.

Parameters:

i - The index of the character to return the position for.

Returns:

The position of the character at the given index.

getLocalBounds

public FloatRect getLocalBounds()

Gets the text's local bounding rectangle, not taking the text's transformation into account.

Returns:

the text's local bounding rectangle.

See Also:

Sprite.getGlobalBounds()

getGlobalBounds

public FloatRect getGlobalBounds()

Gets the text's global bounding rectangle in the scene, taking the text's transformation into account.

Returns:

the text's global bounding rectangle.

See Also:

getLocalBounds()

setPosition

public void setPosition(Vector2f v)

Description copied from interface: Transformable

Sets the position of this object in the scene so that its origin will be exactly on it.

Specified by:

setPosition in interface Transformable

Parameters:

v - the new position.

setRotation

public void setRotation(float angle)

Description copied from interface: Transformable

Sets the rotation of this object around its origin.

Specified by:

setRotation in interface Transformable

Parameters:

angle - the new rotation angle in degrees.

setScale

public void setScale(Vector2f v)

Description copied from interface: Transformable

Sets the scaling of this object, using its origin as the scaling center.

Specified by:

setScale in interface Transformable

Parameters:

v - the new scaling factors.

setOrigin

public void setOrigin(Vector2f v)

Description copied from interface: Transformable

Sets the rotation, scaling and drawing origin of this object.

Specified by:

setOrigin in interface Transformable

Parameters:

v - the new origin.

draw

public void draw(RenderTarget target,
        RenderStates states)

Description copied from interface: Drawable

Draws the object to a render target.

Specified by:

draw in interface Drawable

Parameters:

target - the target to draw this object on.

states - the current render states.

setPosition

public final void setPosition(float x,
               float y)

Description copied from interface: Transformable

Sets the position of this object in the scene so that its origin will be exactly on it.

Specified by:

setPosition in interface Transformable

Parameters:

x - the new X coordinate.

y - the new Y coordinate.

setScale

public final void setScale(float x,
            float y)

Description copied from interface: Transformable

Sets the scaling of this object, using its origin as the scaling center.

Specified by:

setScale in interface Transformable

Parameters:

x - the new X scaling factor.

y - the new Y scaling factor.

setOrigin

public final void setOrigin(float x,
             float y)

Description copied from interface: Transformable

Sets the rotation, scaling and drawing origin of this object.

Specified by:

setOrigin in interface Transformable

Parameters:

x - the new X coordinate of the origin.

y - the new Y coordinate of the origin.

getPosition

public Vector2f getPosition()

Description copied from interface: Transformable

Gets the position of this object.

Specified by:

getPosition in interface Transformable

Returns:

the current position.

getRotation

public float getRotation()

Description copied from interface: Transformable

Gets the rotation angle of this object.

Specified by:

getRotation in interface Transformable

Returns:

the current rotation angle in degrees.

getScale

public Vector2f getScale()

Description copied from interface: Transformable

Gets the scaling of this object.

Specified by:

getScale in interface Transformable

Returns:

the current scaling factors.

getOrigin

public Vector2f getOrigin()

Description copied from interface: Transformable

Gets the origin of this object.

Specified by:

getOrigin in interface Transformable

Returns:

the current origin.

move

public final void move(float x,
        float y)

Description copied from interface: Transformable

Moves this object.

Specified by:

move in interface Transformable

Parameters:

x - the X offset added to the current position.

y - the Y offset added to the current position.

move

public final void move(Vector2f v)

Description copied from interface: Transformable

Moves the object.

Specified by:

move in interface Transformable

Parameters:

v - the offset vector added to the current position.

rotate

public final void rotate(float angle)

Description copied from interface: Transformable

Rotates this object around its origin.

Specified by:

rotate in interface Transformable

Parameters:

angle - the rotation angle in degrees.

scale

public final void scale(float x,
         float y)

Description copied from interface: Transformable

Scales the object, using its origin as the scaling center.

Specified by:

scale in interface Transformable

Parameters:

x - the X scaling factor.

y - the Y scaling factor.

scale

public final void scale(Vector2f factors)

Description copied from interface: Transformable

Scales the object, using its origin as the scaling center.

Specified by:

scale in interface Transformable

Parameters:

factors - the scaling factors.

getTransform

public Transform getTransform()

Description copied from interface: Transformable

Gets the current transformation matrix.

Specified by:

getTransform in interface Transformable

Returns:

the current transformation.

getInverseTransform

public Transform getInverseTransform()

Description copied from interface: Transformable

Gets the inverse of the current transformation matrix.

Specified by:

getInverseTransform in interface Transformable

Returns:

the inverse of the current transform.