ea

Class Text

java.lang.Object

ea.Raum

ea.Text

All Implemented Interfaces:

Leuchtend, java.io.Serializable, java.lang.Comparable<Raum>

Direct Known Subclasses:

TextE

public class Text
extends Raum
implements Leuchtend

Zur Darstellung von Texten im Programmbildschirm.

TODO: Review der ganzen Klasse (v.a. der Dokumentation)

Author:

Michael Andonie

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Text.Anker Ein Textanker beschreibt, wo sich der Text relativ zu seiner x-Koordinate befindet.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	farbe Die Farbe, in der der Text dargestellt wird.
protected java.awt.Font	font Der Font der Darstellung
protected int	groesse Die Schriftgröße des Textes
protected java.lang.String	inhalt Der Wert des Textes.
protected int	schriftart Die Schriftart (fett, kursiv, oder fett & kursiv). Dies wird dargestellt als int.Wert: 0: Normaler Text 1: Fett 2: Kursiv 3: Fett & Kursiv

Fields inherited from class ea.Raum

farbzyklus, position, roh

Constructor Summary

Constructors

Constructor and Description
Text(float x, float y, java.lang.String inhalt) Ein vereinfachter parallerer Konstruktor. Diesen gibt es inhaltlich genauso bereits, jedoch sind hier die Argumente vertauscht; dies dient der Praevention undgewollter falscher Konstruktorenaufrufe.
Text(int x, int y, int schriftGroesse, java.lang.String inhalt) Ein vereinfachter parallerer Konstruktor. Diesen gibt es inhaltlich genauso bereits, jedoch sind hier die Argumente vertauscht; dies dient der Praevention undgewollter falscher Konstruktorenaufrufe.
Text(java.lang.String inhalt, float x, float y) Ein vereinfachter Konstruktor. Hierbei wird eine Standartschriftart, die Farbe weiss und eine Groesse von 24 gewaehlt.
Text(java.lang.String inhalt, float x, float y, int schriftGroesse) Einfacherer Konstruktor. Hierbei wird automatisch die Schriftart auf eine Standartmaessige gesetzt
Text(java.lang.String inhalt, float x, float y, java.lang.String fontName) Ebenefalls ein vereinfachter Konstruktor.
Text(java.lang.String inhalt, float x, float y, java.lang.String fontName, int schriftGroesse) Konstruktor ohne Farb- und sonderartseingabezwang.
Text(java.lang.String inhalt, float x, float y, java.lang.String fontName, int schriftGroesse, int schriftart, java.lang.String farbe) Konstruktor für Objekte der Klasse Text Möglich ist es auch, Fonts zu laden, die im Projektordner sind.

Method Summary

Modifier and Type	Method and Description
BoundingRechteck	dimension() Methode zum Beschreiben der rechteckigen Fläche, die dieses Objekt einnimmt. Diese Methode wird zentral für die Trefferkollisionen innerhalb der Engine benutzt und gehört zu den wichtigsten Methoden der Klasse und der Engine.
Collider	erzeugeCollider() Erzeugt einen neuen Collider für dieses Objekt.
void	farbeSetzen(Farbe f) Setzt die Fuellfarbe
void	farbeSetzen(java.lang.String farbe) Setzt die Fuellfarbe Parallele Methode zu setzeFarbe()
void	fontSetzen(java.lang.String name) Setzt einen neuen Font fuer den Text. Parallele Methode zu setzeFont()
static void	geladeneSchriftartenAusgeben() Sehr wichtige Methode! Diese Methode liefert als Protokoll an die Konsole alle Namen, mit denen die aus dem Projektordner geladenen ".ttf"-Fontdateien gewaehlt werden koennen. Diese Namen werden als String-Argument erwartet, wenn die eigens eingebauten Fontarten verwendet werden sollen. Der Aufruf dieser Methode wird UMGEHEND empfohlen, nach dem alle zu verwendenden Arten im Projektordner liegen, denn nur unter dem an die Konsole projezierten Namen koennen diese ueberhaupt verwendet werden!! Daher dient diese Methode der Praevention von Verwirrung, wegen "nicht darstellbarer" Fonts.
Text.Anker	getAnker() Gibt den aktuellen Anker zurück.
java.lang.String	gibInhalt() Gibt den aktuellen Textinhalt zurück.
int	groesse() Diese Methode gibt die aktuelle Groesse des Textes aus
void	groesseSetzen(int groesse) Setzt die Schriftgroesse. Wrappt hierbei die Methode setzeGroesse.
static java.awt.Font	holeFont(java.lang.String fontName) TODO: Dokumentation
void	inhaltSetzen(java.lang.String inhalt) Setzt den Inhalt des Textes. Parallele Methode zu setzeInhalt()
boolean	leuchtet() Gibt wieder, ob das Leuchtet-Objekt gerade leuchtet oder nicht.
void	leuchtetSetzen(boolean leuchtet) Setzt, ob dieses Leuchtend-Objekt leuchten soll. Ist dies der Fall, so werden immer wieder schnell dessen Farben geaendert; so entsteht ein Leuchteffekt.
void	leuchtSchritt() Fuehrt einen Leuchtschritt aus. Dies heisst, dass in dieser Methode die Farbe einfach gewechselt wird.
void	loeschen() Diese Methode loescht alle eventuell vorhandenen Referenzen innerhalb der Engine auf dieses Objekt, damit es problemlos geloescht werden kann. Achtung: zwar werden hierdurch alle Referenzen geloescht, die nur innerhalb der Engine liegen (dies betrifft vor allem Animationen etc), jedoch nicht die innerhalb eines Knoten-Objektes!!!!!!!!! Das heisst, wenn das Objekt an einem Knoten liegt (was immer der Fall ist, wenn es auch gezeichnet wird (siehe die Wurzel des Fensters)), muss es trotzdem selbst geloescht werden, dies erledigt diese Methode nicht!!. Diese Klasse ueberschreibt die Methode wegen des Leuchtens.
void	schriftartSetzen(int art) Setzt die Schriftart.
void	setAnker(Text.Anker anker) Setzt den Textanker.
void	setzeFarbe(java.awt.Color c) Setzt die Fuellfarbe
void	setzeFarbe(java.lang.String farbe) Setzt die Fuellfarbe
void	setzeFont(java.lang.String fontName) Setzt einen neuen Font fuer den Text
void	setzeGroesse(int groesse) Setzt die Schriftgroesse
void	setzeInhalt(java.lang.String inhalt) Setzt den Inhalt des Textes.
void	setzeSchriftart(int art) Setzt die Schriftart.
void	zeichnen(java.awt.Graphics2D g, BoundingRechteck r) Zeichnet das Objekt.

Methods inherited from class ea.Raum

afterRender, aktivMachen, aktuellerCollider, beeinflussbarSetzen, beforeRender, beinhaltet, bewegen, bewegen, boundsUebernehmen, colliderSetzen, compareTo, drehenAbsolut, drehenRelativ, einfluesseZuruecksetzen, erzeugeLazyCollider, fallReagierbarAnmelden, flaechen, geschwindigkeitHinzunehmen, geschwindigkeitSetzen, getBreite, getForce, getHoehe, getMasse, getOpacity, getX, getY, gibDrehung, halbesAlpha, heavyComputingSetzen, hoehenUnterschied, impulsHinzunehmen, inFlaeche, istBeeinflussbar, konstanteKraftSetzen, kraftAnwenden, kritischeTiefeSetzen, leuchterAbmelden, leuchterAnmelden, luftwiderstandskoeffizient, luftwiderstandskoeffizientSetzen, masseSetzen, mittelPunkt, mittelpunktSetzen, mittelpunktSetzen, neutralMachen, newtonschMachen, passivMachen, position, positionSetzen, positionSetzen, positionX, positionY, problem, schneidet, schwerkraftAktivSetzen, schwerkraftSetzen, setOpacity, setX, setY, setzeMeterProPixel, sichtbar, sichtbarSetzen, sprung, stehReagierbarAnmelden, steht, stehtAuf, verschieben, verschieben, zeichnenBasic, zentrum, zIndex, zuFarbeKonvertieren

Methods inherited from class java.lang.Object

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

Field Detail

groesse

protected int groesse

Die Schriftgröße des Textes

schriftart

protected int schriftart

Die Schriftart (fett, kursiv, oder fett & kursiv).
Dies wird dargestellt als int.Wert:
0: Normaler Text
1: Fett
2: Kursiv
3: Fett & Kursiv

inhalt

protected java.lang.String inhalt

Der Wert des Textes.

font

protected java.awt.Font font

Der Font der Darstellung

farbe

protected java.awt.Color farbe

Die Farbe, in der der Text dargestellt wird.

Constructor Detail

Text

public Text(java.lang.String inhalt,
            float x,
            float y,
            java.lang.String fontName)

Ebenefalls ein vereinfachter Konstruktor. Hierbei ist die Farbe "Weiss" und der Text weder kursiv noch fett; weiterhin ist die Schriftgroesse automatisch 24.

Parameters:

inhalt - Die Zeichenkette, die dargestellt werden soll

x - Die X-Koordinate des Anfangs

y - Die Y-Koordinate des Anfangs

fontName - Der Name des zu verwendenden Fonts.
Wird hierfuer ein Font verwendet, der in dem Projektordner vorhanden sein soll, und dies ist immer und in jedem Fall zu empfehlen, muss der Name der Schriftart hier ebenfalls einfach nur eingegeben werden, nicht der Name der schriftart-Datei!!!!!!!!!!!!!!!!!!!!!!!!

Text

public Text(java.lang.String inhalt,
            float x,
            float y,
            java.lang.String fontName,
            int schriftGroesse)

Konstruktor ohne Farb- und sonderartseingabezwang. In diesem Fall ist die Farbe "Weiss" und der Text weder kursiv noch fett.

Parameters:

inhalt - Die Zeichenkette, die dargestellt werden soll

x - Die X-Koordinate des Anfangs

y - Die Y-Koordinate des Anfangs

fontName - Der Name des zu verwendenden Fonts.
Wird hierfuer ein Font verwendet, der in dem Projektordner vorhanden sein soll, und dies ist immer und in jedem Fall zu empfehlen, muss der Name der Schriftart hier ebenfalls einfach nur eingegeben werden.

schriftGroesse - Die Groesse, in der die Schrift dargestellt werden soll

Text

public Text(java.lang.String inhalt,
            float x,
            float y,
            java.lang.String fontName,
            int schriftGroesse,
            int schriftart,
            java.lang.String farbe)

Konstruktor für Objekte der Klasse Text
Möglich ist es auch, Fonts zu laden, die im Projektordner sind. Diese werden zu Anfang einmalig geladen und stehen dauerhaft zur Verfügung.

Parameters:

inhalt - Die Zeichenkette, die dargestellt werden soll

x - Die X-Koordinate des Anfangs

y - Die Y-Koordinate des Anfangs

fontName - Der Name des zu verwendenden Fonts.
Wird hierfuer ein Font verwendet, der in dem Projektordner vorhanden sein soll, und dies ist immer und in jedem Fall zu empfehlen, muss der Name der Schriftart hier ebenfalls einfach nur eingegeben werden, nicht der Name der schriftart-Datei!

schriftGroesse - Die Groesse, in der die Schrift dargestellt werden soll

schriftart - Die Schriftart dieses Textes. Folgende Werte entsprechen folgendem:
0: Normaler Text
1: Fett
2: Kursiv
3: Fett & Kursiv

Alles andere sorgt nur fuer einen normalen Text.

farbe - Die Farbe, die für den Text benutzt werden soll.

Text

public Text(java.lang.String inhalt,
            float x,
            float y,
            int schriftGroesse)

Einfacherer Konstruktor.
Hierbei wird automatisch die Schriftart auf eine Standartmaessige gesetzt

Parameters:

inhalt - Die Zeichenkette, die dargestellt werden soll

x - Die X-Koordinate des Anfangs

y - Die Y-Koordinate des Anfangs

schriftGroesse - Die Groesse, in der die Schrift dargestellt werden soll

Text

public Text(java.lang.String inhalt,
            float x,
            float y)

Ein vereinfachter Konstruktor.
Hierbei wird eine Standartschriftart, die Farbe weiss und eine Groesse von 24 gewaehlt.

Parameters:

inhalt - Der Inhalt des Textes

x - X-Koordinate

y - Y-Koordinate

Text

public Text(float x,
            float y,
            java.lang.String inhalt)

Ein vereinfachter parallerer Konstruktor.
Diesen gibt es inhaltlich genauso bereits, jedoch sind hier die Argumente vertauscht; dies dient der Praevention undgewollter falscher Konstruktorenaufrufe. Hierbei wird eine Standartschriftart, die Farbe weiss und eine Groesse von 24 gewaehlt.

Parameters:

inhalt - Der Inhalt des Textes

x - X-Koordinate

y - Y-Koordinate

Text

public Text(int x,
            int y,
            int schriftGroesse,
            java.lang.String inhalt)

Ein vereinfachter parallerer Konstruktor.
Diesen gibt es inhaltlich genauso bereits, jedoch sind hier die Argumente vertauscht; dies dient der Praevention undgewollter falscher Konstruktorenaufrufe. Hierbei wird eine Standartschriftart und die Farbe weiss gewaehlt.

Parameters:

inhalt - Der Inhalt des Textes

x - X-Koordinate

y - Y-Koordinate

schriftGroesse - Die Schriftgroesse, die der Text haben soll

Method Detail

setzeFont

public void setzeFont(java.lang.String fontName)

Setzt einen neuen Font fuer den Text

Parameters:

fontName - Der Name des neuen Fonts fuer den Text

holeFont

public static java.awt.Font holeFont(java.lang.String fontName)

TODO: Dokumentation

geladeneSchriftartenAusgeben

public static void geladeneSchriftartenAusgeben()

Sehr wichtige Methode!
Diese Methode liefert als Protokoll an die Konsole alle Namen, mit denen die aus dem Projektordner geladenen ".ttf"-Fontdateien gewaehlt werden koennen.
Diese Namen werden als String-Argument erwartet, wenn die eigens eingebauten Fontarten verwendet werden sollen.
Der Aufruf dieser Methode wird UMGEHEND empfohlen, nach dem alle zu verwendenden Arten im Projektordner liegen, denn nur unter dem an die Konsole projezierten Namen koennen diese ueberhaupt verwendet werden!!
Daher dient diese Methode der Praevention von Verwirrung, wegen "nicht darstellbarer" Fonts.

inhaltSetzen

public void inhaltSetzen(java.lang.String inhalt)

Setzt den Inhalt des Textes.
Parallele Methode zu setzeInhalt()

Parameters:

inhalt - Der neue Inhalt des Textes

See Also:

setzeInhalt(String)

setzeInhalt

public void setzeInhalt(java.lang.String inhalt)

Setzt den Inhalt des Textes.

Parameters:

inhalt - Der neue Inhalt des Textes

schriftartSetzen

public void schriftartSetzen(int art)

Setzt die Schriftart.

Parameters:

art - Die Repraesentation der Schriftart als Zahl:
0: Normaler Text
1: Fett
2: Kursiv
3: Fett & Kursiv

Ist die Eingabe nicht eine dieser 4 Zahlen, so wird nichts geaendert.
Parallele Methode zu setzeSchriftart()

See Also:

setzeSchriftart(int)

setzeSchriftart

public void setzeSchriftart(int art)

Setzt die Schriftart.

Parameters:

art - Die Repraesentation der Schriftart als Zahl:
0: Normaler Text
1: Fett
2: Kursiv
3: Fett & Kursiv

Ist die Eingabe nicht eine dieser 4 Zahlen, so wird nichts geaendert.

farbeSetzen

public void farbeSetzen(java.lang.String farbe)

Setzt die Fuellfarbe
Parallele Methode zu setzeFarbe()

Parameters:

farbe - Der Name der neuen Fuellfarbe

See Also:

setzeFarbe(String), farbeSetzen(Farbe)

setzeFarbe

public void setzeFarbe(java.lang.String farbe)

Setzt die Fuellfarbe

Parameters:

farbe - Der Name der neuen Fuellfarbe

setzeFarbe

public void setzeFarbe(java.awt.Color c)

Setzt die Fuellfarbe

Parameters:

c - Die neue Fuellfarbe

farbeSetzen

public void farbeSetzen(Farbe f)

Setzt die Fuellfarbe

Parameters:

f - Das Farbe-Objekt, das die neue Fuellfarbe beschreibt

See Also:

farbeSetzen(String)

groesseSetzen

public void groesseSetzen(int groesse)

Setzt die Schriftgroesse.
Wrappt hierbei die Methode setzeGroesse.

Parameters:

groesse - Die neue Schriftgroesse

See Also:

setzeGroesse(int)

setzeGroesse

public void setzeGroesse(int groesse)

Setzt die Schriftgroesse

Parameters:

groesse - Die neue Schriftgroesse

groesse

public int groesse()

Diese Methode gibt die aktuelle Groesse des Textes aus

Returns:

Die aktuelle Schriftgroesse des Textes

See Also:

groesseSetzen(int)

fontSetzen

public void fontSetzen(java.lang.String name)

Setzt einen neuen Font fuer den Text.
Parallele Methode zu setzeFont()

Parameters:

name - Der Name des neuen Fonts fuer den Text

See Also:

setzeFont(String)

zeichnen

public void zeichnen(java.awt.Graphics2D g,
                     BoundingRechteck r)

Zeichnet das Objekt.

Specified by:

zeichnen in class Raum

Parameters:

g - Das zeichnende Graphics-Objekt

r - Das BoundingRechteck, dass die Kameraperspektive Repraesentiert.
Hierbei soll zunaechst getestet werden, ob das Objekt innerhalb der Kamera liegt, und erst dann gezeichnet werden.

dimension

public BoundingRechteck dimension()

Description copied from class: Raum

Methode zum Beschreiben der rechteckigen Fläche, die dieses Objekt einnimmt.
Diese Methode wird zentral für die Trefferkollisionen innerhalb der Engine benutzt und gehört zu den wichtigsten Methoden der Klasse und der Engine.

Specified by:

dimension in class Raum

Returns:

Ein BoundingRechteck mit dem minimal noetigen Umfang, um das Objekt voll einzuschliessen.

erzeugeCollider

public Collider erzeugeCollider()

Erzeugt einen neuen Collider für dieses Objekt. Diese Methode approximiert für das Objekt der jeweils implementierenden Raum-Klasse einen möglichst "guten" Collider; also einen solchen, der das tatsächliche Objekt möglichst genau umfängt, aber auch möglichst wenig Rechenarbeit beansprucht. Collider wird direkt aus dem das Raum-Objekt umfassenden BoundingRechteck erzeugt, dass über die dimension()-Methode berechnet wird.

Specified by:

erzeugeCollider in class Raum

Returns:

Ein möglichst optimaler Collider für dieses Raum-Objekt.

See Also:

Raum.colliderSetzen(Collider)

loeschen

public void loeschen()

Diese Methode loescht alle eventuell vorhandenen Referenzen innerhalb der Engine auf dieses Objekt, damit es problemlos geloescht werden kann.
Achtung: zwar werden hierdurch alle Referenzen geloescht, die nur innerhalb der Engine liegen (dies betrifft vor allem Animationen etc), jedoch nicht die innerhalb eines Knoten-Objektes!!!!!!!!!
Das heisst, wenn das Objekt an einem Knoten liegt (was immer der Fall ist, wenn es auch gezeichnet wird (siehe die Wurzel des Fensters)), muss es trotzdem selbst geloescht werden, dies erledigt diese Methode nicht!!.
Diese Klasse ueberschreibt die Methode wegen des Leuchtens.

Overrides:

loeschen in class Raum

leuchtetSetzen

public void leuchtetSetzen(boolean leuchtet)

Setzt, ob dieses Leuchtend-Objekt leuchten soll.
Ist dies der Fall, so werden immer wieder schnell dessen Farben geaendert; so entsteht ein Leuchteffekt.

Specified by:

leuchtetSetzen in interface Leuchtend

Parameters:

leuchtet - Ob dieses Objekt nun leuchten soll oder nicht (mehr).
Achtung: Die Leuchtfunktion kann bei bestimmten Klassen sehr psychadelisch und aufreizend wirken! Daher sollte sie immer mit Bedacht und in Nuancen verwendet werden!

leuchtSchritt

public void leuchtSchritt()

Fuehrt einen Leuchtschritt aus.
Dies heisst, dass in dieser Methode die Farbe einfach gewechselt wird. Da diese Methode schnell und oft hintereinander ausgefuehrt wird, soll so der Leuchteffekt entstehen.
Diese Methode sollte nur innerhalb der Engine ausgefuehrt werden! Also nicht fuer den Entwickler gedacht.

Specified by:

leuchtSchritt in interface Leuchtend

leuchtet

public boolean leuchtet()

Gibt wieder, ob das Leuchtet-Objekt gerade leuchtet oder nicht.

Specified by:

leuchtet in interface Leuchtend

Returns:

true, wenn das Objekt gerade leuchtet, wenn nicht, dann ist die Rueckgabe false

gibInhalt

public java.lang.String gibInhalt()

Gibt den aktuellen Textinhalt zurück.

Returns:

aktueller Textinhalt

getAnker

public Text.Anker getAnker()

Gibt den aktuellen Anker zurück.

Returns:

aktueller Anker

See Also:

Text.Anker, setAnker(ea.Text.Anker)

setAnker

public void setAnker(Text.Anker anker)

Setzt den Textanker. Dies beschreibt, wo sich der Text relativ zur x-Koordinate befindet. Möglich sind:

Text.Anker.LINKS, Text.Anker.MITTE, Text.Anker.RECHTS.
Hinweis: null wird wie Anker.LINKS behandelt!

Parameters:

anker - neuer Anker

See Also:

Text.Anker, getAnker()