TextConceptMetadata Interface Reference

Metadata definitions for TextConcept. More...

Inheritance diagram for TextConceptMetadata:

Public Attributes
DynamicPropertyType< ColorRGBA >	FontColorProperty
	Sets the color of the text. More...
DynamicPropertyType< Resource >	FontMaterialProperty
	Sets the material whose shader is used to render the text. More...
DynamicPropertyType< Boolean >	HorizontalFitProperty
	Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block. More...
DynamicPropertyType< Vector2 >	HorizontalFitScaleLimitsProperty
	When the Horizontal Fit property is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width of that Text Block. More...
DynamicPropertyType< Vector2 >	HorizontalPaddingProperty
	Sets the padding spaces between the content and the left and right boundaries of the Text node. More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.TextConcept")
	Metaclass for TextConcept.
DynamicPropertyType< String >	OverflowProperty
	Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in the node. More...
DynamicPropertyType< Boolean >	RemoveSideBearingsProperty
	Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node. More...
DynamicPropertyType< Integer >	TextHorizontalAlignmentProperty
	Sets the horizontal alignment of the text. More...
DynamicPropertyType< String >	TextProperty
	Sets the text content that the text node renders. More...
DynamicPropertyType< Integer >	TextVerticalAlignmentProperty
	Sets the vertical alignment of the text. More...
DynamicPropertyType< Vector2 >	VerticalPaddingProperty
	Sets the padding spaces between the content and the top and bottom boundaries of the Text node. More...

Detailed Description

Metadata definitions for TextConcept.

Member Data Documentation

FontColorProperty

DynamicPropertyType<ColorRGBA> FontColorProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.FontColor", ColorRGBA.class)

Sets the color of the text.

FontMaterialProperty

DynamicPropertyType<Resource> FontMaterialProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.FontMaterial", Resource.class)

Sets the material whose shader is used to render the text.

The shader must use the ContentTexture uniform which is automatically filled with glyph data.

HorizontalFitProperty

DynamicPropertyType<Boolean> HorizontalFitProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.HorizontalFit", Boolean.class)

Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block.

To adjust the scale, use the Horizontal Fit Scale Limits property.

HorizontalFitScaleLimitsProperty

DynamicPropertyType<Vector2> HorizontalFitScaleLimitsProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.HorizontalFitScaleLimits", Vector2.class)

When the Horizontal Fit property is enabled, sets the minimum and maximum scale for glyphs when the width of text in a Text Block does not match the Layout Width of that Text Block.

For example:

• Min property field set to 1.0 does not squeeze the glyphs, while 0.5 squeezes the glyphs to half their size.
• Max property field set to 1.0 does not stretch the glyphs, while 2.0 stretches the glyphs to double their size.

HorizontalPaddingProperty

DynamicPropertyType<Vector2> HorizontalPaddingProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.HorizontalPadding", Vector2.class)

Sets the padding spaces between the content and the left and right boundaries of the Text node.

OverflowProperty

DynamicPropertyType<String> OverflowProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.Overflow", String.class)

Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in the node.

The default value is "...".

RemoveSideBearingsProperty

DynamicPropertyType<Boolean> RemoveSideBearingsProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.RemoveSideBearings", Boolean.class)

Whether to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.

TextHorizontalAlignmentProperty

DynamicPropertyType<Integer> TextHorizontalAlignmentProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.TextHorizontalAlignment", Integer.class)

Sets the horizontal alignment of the text.

TextProperty

DynamicPropertyType<String> TextProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.Text", String.class)

Sets the text content that the text node renders.

To create a line break press Shift+Enter.

TextVerticalAlignmentProperty

DynamicPropertyType<Integer> TextVerticalAlignmentProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.TextVerticalAlignment", Integer.class)

Sets the vertical alignment of the text.

VerticalPaddingProperty

DynamicPropertyType<Vector2> VerticalPaddingProperty

Initial value:

=
        new DynamicPropertyType<>("TextConcept.VerticalPadding", Vector2.class)

Sets the padding spaces between the content and the top and bottom boundaries of the Text node.