guiSET.core

Class TextBased

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

Direct Known Subclasses:

Button, Checkbox, Container, Label, ListItem, MenuItem

public abstract class TextBased
extends Control

Abstract base class for all components that display text. Implements the text drawing facilities.

Author:

Mc-Zen

Nested Class Summary

Nested classes/interfaces inherited from class guiSET.core.Control

Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary

Fields

Modifier and Type	Field and Description
static long	FONT_SIZE
static long	LINE_HEIGHT
static long	TEXT_ALIGN
static long	TEXT_ALIGN_Y
static long	TEXT_COLOR

Fields inherited from class guiSET.core.Control

ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors

Constructor and Description
TextBased()

Method Summary

Modifier and Type	Method and Description
void	copyStyle(Control source, long attribs) Enable user of the library to adopt a set of visual style properties from another element.
PFont	getFont()
float	getFontSize()
int	getLineHeight()
java.lang.String	getText()
int	getTextAlign()
int	getTextAlignY()
int	getTextColor()
boolean	isBold()
boolean	isItalic()
boolean	isStrikethrough()
boolean	isUnderlined()
void	setBold(boolean bold) Set the text bold attribute.
void	setFont(PFont font) Set the text font.
void	setFontSize(float fontSize) Set the font size for the displayed text.
void	setForegroundColor(int clr) Set the foreground color (usually the text color).
void	setItalic(boolean italic) Set the text italic attribute.
void	setLineHeight(int lineHeight) For multiline text, set the line height in pixel.
void	setLineHeightPercent(int lineHeight) For multiline text, set the line height in literal percent: for 100% pass 100 and not 1.
void	setStrikethrough(boolean strike) Set the text strike-through attribute.
void	setText(java.lang.String text) Set the text content.
void	setText(java.lang.String text, boolean noautosize) If the second parameter is true, then the element will not be resized to fit the text.
void	setTextAlign(int align) Set the text align (works for most classes).
void	setTextAlignY(int align) Vertical align (not implemented in all classes).
void	setTextColor(int clr) Set the text color.
void	setUnderlined(boolean underline) Set the text underline attribute.

Methods inherited from class guiSET.core.Control

addAutoAnchors, animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableHeight, getAvailableWidth, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_COLOR

public static final long TEXT_COLOR

See Also:

Constant Field Values

FONT_SIZE

public static final long FONT_SIZE

See Also:

Constant Field Values

TEXT_ALIGN

public static final long TEXT_ALIGN

See Also:

Constant Field Values

TEXT_ALIGN_Y

public static final long TEXT_ALIGN_Y

See Also:

Constant Field Values

LINE_HEIGHT

public static final long LINE_HEIGHT

See Also:

Constant Field Values

Constructor Detail

TextBased

public TextBased()

Method Detail

setForegroundColor

public void setForegroundColor(int clr)

Set the foreground color (usually the text color).

Overrides:

setForegroundColor in class Control

Parameters:

clr - integer rgb color

setTextColor

public void setTextColor(int clr)

Set the text color.

Parameters:

clr - text color

setText

public void setText(java.lang.String text)

Set the text content. Some elements do not display any text (i.e. most containers).

Parameters:

text - text

setText

public void setText(java.lang.String text,
                    boolean noautosize)

If the second parameter is true, then the element will not be resized to fit the text.

Parameters:

text - text

noautosize - noautosize

setFontSize

public void setFontSize(float fontSize)

Set the font size for the displayed text.

Parameters:

fontSize - font size

setTextAlign

public void setTextAlign(int align)

Set the text align (works for most classes).

Parameters:

align - LEFT, CENTER, RIGHT

setTextAlignY

public void setTextAlignY(int align)

Vertical align (not implemented in all classes).

Parameters:

align - TOP, MIDDLE, BOTTOM

setLineHeight

public void setLineHeight(int lineHeight)

For multiline text, set the line height in pixel.

Parameters:

lineHeight - line height in pixel

setLineHeightPercent

public void setLineHeightPercent(int lineHeight)

For multiline text, set the line height in literal percent: for 100% pass 100 and not 1.

Parameters:

lineHeight - line height in percent

getText

public java.lang.String getText()

getFontSize

public float getFontSize()

getTextColor

public int getTextColor()

getTextAlign

public int getTextAlign()

getTextAlignY

public int getTextAlignY()

getLineHeight

public int getLineHeight()

setBold

public void setBold(boolean bold)

Set the text bold attribute. Changes the internal textRenderer to ExtendedTextRenderer.

Parameters:

bold - bold

setItalic

public void setItalic(boolean italic)

Set the text italic attribute. Changes the internal textRenderer to ExtendedTextRenderer.

Parameters:

italic - italic

setUnderlined

public void setUnderlined(boolean underline)

Set the text underline attribute. Changes the internal textRenderer to ExtendedTextRenderer.

Parameters:

underline - underline

setStrikethrough

public void setStrikethrough(boolean strike)

Set the text strike-through attribute. Changes the internal textRenderer to ExtendedTextRenderer.

Parameters:

strike - strike

setFont

public void setFont(PFont font)

Set the text font. Changes the internal textRenderer to ExtendedTextRenderer.

Parameters:

font - a PFont

isBold

public boolean isBold()

isItalic

public boolean isItalic()

isUnderlined

public boolean isUnderlined()

isStrikethrough

public boolean isStrikethrough()

getFont

public PFont getFont()

copyStyle

public void copyStyle(Control source,
                      long attribs)

Description copied from class: Control

Enable user of the library to adopt a set of visual style properties from another element. Call copyStyle(Control, attribs) to read given attributes (separated by bitwise OR) from given element c: myElement.copyStyle(otherElement, PADDING_LEFT | MARGIN_BOTTOM, FOREGROUND_COLOR);

Options are: Control.PADDING_LEFT, Control.PADDING_RIGHT, Control.PADDING_TOP, Control.PADDING_BOTTOM, Control.MARGIN_LEFT, Control.MARGIN_RIGHT, Control.MARGIN_TOP, Control.MARGIN_BOTTOM, Control.BACKGROUND_COLOR, Control.HOVER_COLOR, Control.PRESSED_COLOR, Control.FOREGROUND_COLOR, Control.BORDER_WIDTH, Control.BORDER_RADIUS, Control.BORDER_COLOR, Control.OPACITY,

Only if source and target have text properties: Control.TEXT_COLOR, Control.TEXT_ALIGN, Control.TEXT_ALIGN_Y, Control.FONT_SIZE, Control.LINE_HEIGHT.

There some shortcuts to include several properties, like Control.ALL, Control.COLORS, Control.MARGIN (all margins), Control.PADDING (all paddings), Control.SPACING (all margins and paddings), Control.BACKGROUND_COLORS (background-, hover-, and pressedColor), Control.BORDER (border-width, -color and -radius), Control.TEXT_PROPERTIES (all text properties).

Overrides:

copyStyle in class Control

Parameters:

source - element to adopt properties from.

attribs - bitwise OR added attributes