Libraries.Interface.Controls.TextStyles.TextHighlight Documentation

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action returns the priority value on this highlight.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDrawable(number width, number height)This action returns a Drawable representing the visual content of a text highlight of a given width and heigh
GetHashCode()This action gets the hash code for an object.
GetRenderPriority()This action returns the priority value on this highlight.
IsError()This action returns a value indicating whether or not this highlight represents an error in the text, most commonly a spelling error.
IsLineHighlight()This action returns whether or not this highlight is applied to an entire line of tex
IsVisibleWhileSelected()This action returns whether or not this highlight will be visible on selected text.
SetErrorFlag(boolean error)The SetErrorFlag action is used to designate this highlight as representing an error in the text, most commonly a spelling error.
SetLineHighlight(boolean isLineHighlight)This action sets whether or not this highlight should be applied to an entire line of text.
SetRenderPriority(number priority)This action sets a priority value on this highlight.
SetVisibleWhileSelected(boolean visible)This action sets whether or not this highlight will be rendered on top of the selection highlight for selected text.

Actions Documentation

Compare(Libraries.Language.Object object)

This action returns the priority value on this highlight. If multiple highlights overlap in the TextBox, highlights with a higher priority will be rendered on top of highlights with a lower priorit

Parameters

Return

integer:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetDrawable(number width, number height)

This action returns a Drawable representing the visual content of a text highlight of a given width and heigh

Parameters

Return

Libraries.Game.Graphics.Drawable:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

GetRenderPriority()

This action returns the priority value on this highlight. If multiple highlights overlap in the TextBox, highlights with a higher priority will be rendered on top of highlights with a lower priorit

Return

number:

IsError()

This action returns a value indicating whether or not this highlight represents an error in the text, most commonly a spelling error. This is used by the accessibility platform to inform screen readers if they interact with a spelling error. By default, this value returns fals

Return

boolean:

IsLineHighlight()

This action returns whether or not this highlight is applied to an entire line of tex

Return

boolean:

IsVisibleWhileSelected()

This action returns whether or not this highlight will be visible on selected text. If this value is false and text is selected, the selection highlight will be rendered on top of this highlight. Note that if the selection highlight uses transparency, this highlight will be partially visible underneath the selection highligh

Return

boolean:

SetErrorFlag(boolean error)

The SetErrorFlag action is used to designate this highlight as representing an error in the text, most commonly a spelling error. This is used by the accessibility platform to inform screen readers if they interact with a spelling erro

Parameters

SetLineHighlight(boolean isLineHighlight)

This action sets whether or not this highlight should be applied to an entire line of text. The highlight will be applied to whatever line contains the start index of the TextStyle that is using this highlight.

Parameters

SetRenderPriority(number priority)

This action sets a priority value on this highlight. If multiple highlights overlap in the TextBox, highlights with a higher priority will be rendered on top of highlights with a lower priorit

Parameters

SetVisibleWhileSelected(boolean visible)

This action sets whether or not this highlight will be rendered on top of the selection highlight for selected text. If the provided value is false, then the highlight will appear normally on unselected text, but will be hidden on selected text. If the text's selection color uses transparency, this highlight will be partially visible underneath the selection highligh

Parameters