net.stemkoski.bagel

Class Label

java.lang.Object

net.stemkoski.bagel.Entity

net.stemkoski.bagel.Label

public class Label
extends Entity

A structure to store and display text. Most properties are public and should be set directly.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	alignment text alignment ("LEFT", "CENTER", "RIGHT") with respect to anchor point (x,y)
javafx.scene.paint.Color	borderColor color used to draw font border
boolean	borderDraw determines if font border will be drawn
int	borderSize size of font border
(package private) javafx.scene.text.Font	font Automatically set by load methods.
javafx.scene.paint.Color	fontColor color used to draw font
(package private) java.lang.String	fontName Name of the current font.
(package private) int	fontSize Size of the current font.
java.lang.String	text text to display in label
boolean	visible determines if label will be visible
double	x x-coordinate of anchor of label; see setPosition(double, double)
double	y y-coordinate of anchor of label; see setPosition(double, double)

Fields inherited from class net.stemkoski.bagel.Entity

container

Constructor Summary

Constructors

Constructor and Description
Label() Initialize label to default settings.

Method Summary

Modifier and Type	Method and Description
void	draw(javafx.scene.canvas.GraphicsContext context) Render this text to a canvas used specified parameters.
void	loadFontFromFile(java.lang.String fontFileName, int fontSize) Configure this label to use a font from a specified file.
void	loadFontFromSystem(java.lang.String fontName, int fontSize) Configure this label to use a font already installed on this system.
void	setPosition(double x, double y) Set the coordinates of the anchor position of this label; this may be to the left, center, or right of the text according to the value of alignment.

Methods inherited from class net.stemkoski.bagel.Entity

act, remove

Methods inherited from class java.lang.Object

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

Field Detail

fontName

java.lang.String fontName

Name of the current font. Set in loadFontFromSystem(String, int) or set by file in loadFontFromFile(String, int).

fontSize

int fontSize

Size of the current font. Set in loadFontFromSystem(String, int) or loadFontFromFile(String, int).

font

javafx.scene.text.Font font

Automatically set by load methods.

fontColor

public javafx.scene.paint.Color fontColor

color used to draw font

text

public java.lang.String text

text to display in label

x

public double x

x-coordinate of anchor of label; see setPosition(double, double)

y

public double y

y-coordinate of anchor of label; see setPosition(double, double)

alignment

public java.lang.String alignment

text alignment ("LEFT", "CENTER", "RIGHT") with respect to anchor point (x,y)

borderDraw

public boolean borderDraw

determines if font border will be drawn

borderSize

public int borderSize

size of font border

borderColor

public javafx.scene.paint.Color borderColor

color used to draw font border

visible

public boolean visible

determines if label will be visible

Constructor Detail

Label

public Label()

Initialize label to default settings.

Method Detail

loadFontFromSystem

public void loadFontFromSystem(java.lang.String fontName,
                               int fontSize)

Configure this label to use a font already installed on this system.

Parameters:

fontName - name of font (e.g. "Arial", "Times New Roman", "Courier New"); must be installed on system

fontSize - size of font

loadFontFromFile

public void loadFontFromFile(java.lang.String fontFileName,
                             int fontSize)

Configure this label to use a font from a specified file.

Parameters:

fontFileName - name of font file

fontSize - size of font

setPosition

public void setPosition(double x,
                        double y)

Set the coordinates of the anchor position of this label; this may be to the left, center, or right of the text according to the value of alignment.

Parameters:

x - x-coordinate of anchor of label

y - y-coordinate of anchor of label

draw

public void draw(javafx.scene.canvas.GraphicsContext context)

Render this text to a canvas used specified parameters.

Overrides:

draw in class Entity

Parameters:

context - GraphicsContext object that handles drawing to the canvas