com.github.brunothg.game.engine.d2.object.text

Class LabelSceneObject

java.lang.Object

com.github.brunothg.game.engine.d2.object.SceneObject

com.github.brunothg.game.engine.d2.object.text.LabelSceneObject

Direct Known Subclasses:

CachedLabelSceneObject

public class LabelSceneObject
extends SceneObject

A SceneObject that represents a label for displaying text.

Author:

Marvin Bruns

Field Summary

Fields inherited from class com.github.brunothg.game.engine.d2.object.SceneObject

ORIGIN_TOP_LEFT

Constructor Summary

Constructors

Constructor and Description
LabelSceneObject()
LabelSceneObject(String text)

Method Summary

Modifier and Type	Method and Description
Font	getFont() Set the font used to draw the text.
int	getFontFlags()
Orientation.HorizontalOrientation	getHorizontalTextOrientation()
Paint	getOutlinePaint()
Paint	getPaint()
FontScaleStrategy	getScaleStrategy()
Stroke	getStroke()
String	getText() Get the text, this label will draw
Orientation.VerticalOrientation	getVerticalTextOrientation()
protected void	paint(Graphics2D g, long elapsedTime) Paint this SceneObject.
void	setColor(Color color)
void	setFont(Font font) Set the font used to draw the text.
void	setFontFlags(int fontFlags) Set the font flags as specified by Font.layoutGlyphVector(java.awt.font.FontRenderContext, char[], int, int, int)
void	setHorizontalTextOrientation(Orientation.HorizontalOrientation horizontalTextOrientation) Set the horizontal orientation of the drawn text
void	setOutlineColor(Color outlineColor) Set the color for outline painting
void	setOutlinePaint(Paint outlinePaint) Set the Paint, that is used for drawing outlines
void	setPaint(Paint paint) Set the Paint, that is used for drawing
void	setScaleStrategy(FontScaleStrategy scaleStrategy) Set the used FontScaleStrategy.
void	setStroke(Stroke stroke) Set the Stroke, that is used for text drawing
void	setText(String text) Set the text, this label will draw
void	setVerticalTextOrientation(Orientation.VerticalOrientation verticalTextOrientation) Set the vertical orientation of the drawn text

Methods inherited from class com.github.brunothg.game.engine.d2.object.SceneObject

collides, collidesBoundingBox, collidesExactly, consumes, consumesBoundingBox, consumesExactly, getHeight, getOrigin, getPosition, getPreciseHeight, getPreciseWidth, getPreciseX, getPreciseY, getRectangle, getRenderingOptions, getSize, getTopLeftPosition, getWidth, getX, getY, isDrawBoundingBox, paintAbsoluteOnScene, paintOnScene, paintOnScene, paintOnScene, paintOnScene, setDrawBoundingBox, setPosition, setPosition, setRenderingOptions, setSize, setSize, setTopLeftPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelSceneObject

public LabelSceneObject()

LabelSceneObject

public LabelSceneObject(String text)

Method Detail

paint

protected void paint(Graphics2D g,
                     long elapsedTime)

Description copied from class: SceneObject

Paint this SceneObject. This method maybe called for collision testing with an elapsed time of zero. For correct collision the SceneObject it is important, that the object is drawn in it's actual state.

Specified by:

paint in class SceneObject

Parameters:

g - Graphics Object for painting

elapsedTime - Elapsed time since the last call to this method

getFont

public Font getFont()

Set the font used to draw the text. May return null if default will be used.

Returns:

The font used for drawing.

setFont

public void setFont(Font font)

Set the font used to draw the text. If set to null default will be used.

Parameters:

font - Used font for drawing

getVerticalTextOrientation

public Orientation.VerticalOrientation getVerticalTextOrientation()

setVerticalTextOrientation

public void setVerticalTextOrientation(Orientation.VerticalOrientation verticalTextOrientation)

Set the vertical orientation of the drawn text

Parameters:

verticalTextOrientation - Vertical orientation of the drawn text

getHorizontalTextOrientation

public Orientation.HorizontalOrientation getHorizontalTextOrientation()

setHorizontalTextOrientation

public void setHorizontalTextOrientation(Orientation.HorizontalOrientation horizontalTextOrientation)

Set the horizontal orientation of the drawn text

Parameters:

horizontalTextOrientation - Horizontal orientation of the drawn text

getText

public String getText()

Get the text, this label will draw

Returns:

The text that will be drawn

setText

public void setText(String text)

Set the text, this label will draw

Parameters:

text - The text that will be drawn

getPaint

public Paint getPaint()

setPaint

public void setPaint(Paint paint)

Set the Paint, that is used for drawing

Parameters:

paint - The paint used for drawing

setColor

public void setColor(Color color)

Parameters:

color - The color for drawing the string

See Also:

setPaint(Paint)

getOutlinePaint

public Paint getOutlinePaint()

setOutlinePaint

public void setOutlinePaint(Paint outlinePaint)

Set the Paint, that is used for drawing outlines

Parameters:

outlinePaint - The paint used for drawing outlines

setOutlineColor

public void setOutlineColor(Color outlineColor)

Set the color for outline painting

Parameters:

outlineColor - Color for outline painting

See Also:

setOutlinePaint(Paint)

getStroke

public Stroke getStroke()

setStroke

public void setStroke(Stroke stroke)

Set the Stroke, that is used for text drawing

Parameters:

stroke - The stroke used for text drawing

getScaleStrategy

public FontScaleStrategy getScaleStrategy()

setScaleStrategy

public void setScaleStrategy(FontScaleStrategy scaleStrategy)

Set the used FontScaleStrategy. If the scale strategy is not FontScaleStrategy.NoScale the size of the Font is ignored.

Parameters:

scaleStrategy - The strategy, that will be used fore scaling the text

getFontFlags

public int getFontFlags()

setFontFlags

public void setFontFlags(int fontFlags)

Set the font flags as specified by Font.layoutGlyphVector(java.awt.font.FontRenderContext, char[], int, int, int)

Parameters:

fontFlags - The flags used for creating the GlyphVector