public class

RichTextLabel

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.RichTextLabel

Class Overview

A RichTextLabel can display HTML strings.

To display plain text, use TextLabel.

Remarks about HTML parsing

Be aware that RichTextLabel is not a WebView: some complex tags and attributes may not be interpreted or ignored.
For example this is the case for style tag and attribute and font tag.

The <style> tag will be completely ignored and its content will not be displayed.
The <font> tag will be ignored but its content will be displayed.

The RichTextLabel will display its HTML text even if there are some HTML mistakes (missing ending tag, undefined tag, incomplete attribute...). However in this case the result may be slightly different between the platforms.

Hyperlink (<a> tag) can be set in a RichTextLabel. The corresponding text will be highlighted and the link can be clicked to open the page in the web browser.

Cross Platform Considerations

In Android platform, the text is truncated if it cannot entirely be displayed in the view (for example it may append in the case a setHeight(int) was done.

In iOS platform, before iOS 7.1, <a> tag links cannot be opened by tapping on them.

Summary

XML Attributes
Attribute Name	Related Method	Description
font	setFont(Font)	Font resource id: Res.font.FONT_XXXX
text	setText(int)	Res.string.XXXX or a text
textColor	setTextColor(Color)	#AARRGGBB or a color
textSize	setTextSize(int)	a size in dp

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	RichTextLabel() Builds a label with no text.
	RichTextLabel(String label) Builds a label with a given text.
	RichTextLabel(int labelResId) Builds a label with the text in the text resource file corresponding to an id.

Public Methods
void	setFont(Font font) Sets the font of the label.
void	setText(String text) Sets the text of the label.
void	setText(int resId) Sets the text of the label from the text resource file using an id.
void	setTextColor(Color color) Sets the text color of this label.
void	setTextSize(int size) Set the default text size to the given value.

[Expand]

Inherited Methods

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

XML Attributes

font

Font resource id: Res.font.FONT_XXXX

Related Methods

setFont(Font)

text

Res.string.XXXX or a text

Related Methods

setText(int)

textColor

#AARRGGBB or a color

Related Methods

setTextColor(Color)

Public Constructors

public RichTextLabel ()

Builds a label with no text.

public RichTextLabel (String label)

Builds a label with a given text. This text can be an HTML string.

Parameters

label	the new text

public RichTextLabel (int labelResId)

Builds a label with the text in the text resource file corresponding to an id. This text can be an HTML string.

Parameters

labelResId	the string id representing the text of this label

Public Methods

public void setFont (Font font)

Sets the font of the label.

If the text is from an HTML string, the typeface and the style will be applied to all HTML tags. The size will be applied to the p tag. The other tags size will be scaled automatically according to the font size.

Related XML Attributes

font

Parameters

font	the new font to set

Throws

CrossThreadException	if the method is called from outside the UI-Thread
NullPointerException	if the font parameter is null

public void setText (String text)

Sets the text of the label. This text can be an HTML string.

Related XML Attributes

text

Parameters

text	the new text

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setText (int resId)

Sets the text of the label from the text resource file using an id. This text can be an HTML string.

Related XML Attributes

text

Parameters

resId	the string id representing the text of this text label

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setTextColor (Color color)

Sets the text color of this label.

If the color is also defined in the HTML code, the behavior of this method depends on the platform.

Related XML Attributes

textColor

Parameters

color	The color to set (with the alpha channel)

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setTextSize (int size)

Set the default text size to the given value.

If the text is from an HTML string, it is the p tag that will take the given size. The other tags size will be scaled automatically according to the new size.

Related XML Attributes

textSize

Parameters

size	the default text size

Throws

CrossThreadException	if the method is called from outside the UI-Thread

Interfaces

Classes

Enums

Exceptions

RichTextLabel

Class Overview

Remarks about HTML parsing

Cross Platform Considerations

Summary

XML Attributes

font

Related Methods

text

Related Methods

textColor

Related Methods

textSize

Related Methods

Public Constructors

public RichTextLabel ()

public RichTextLabel (String label)

Parameters

public RichTextLabel (int labelResId)

Parameters

Public Methods

public void setFont (Font font)

Related XML Attributes

Parameters

Throws

public void setText (String text)

Related XML Attributes

Parameters

Throws

public void setText (int resId)

Related XML Attributes

Parameters

Throws

public void setTextColor (Color color)

Related XML Attributes

Parameters

Throws

public void setTextSize (int size)

Related XML Attributes

Parameters

Throws