Kanzi 3.9.10
Public Attributes | List of all members
TextConceptMetadata Interface Reference

Metadata definitions for TextConcept. More...

Inheritance diagram for TextConceptMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBA > FontColorProperty
 Sets the color of the text in a 3D text node.
 
DynamicPropertyType< Resource > FontMaterialProperty
 Sets the material whose shader is used to render the text.
 
DynamicPropertyType< Boolean > HorizontalFitProperty
 Whether to horizontally scale the glyphs to make them fit into the Layout Width of the Text Block.
 
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.
 
DynamicPropertyType< Vector2 > HorizontalPaddingProperty
 Sets the padding spaces between the content and the left and right boundaries of the Text node.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextConcept")
 Metaclass for TextConcept.
 
DynamicPropertyType< String > OverflowProperty
 Sets the characters that represent the truncated text when the text does not fit in this node.
 
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.
 
DynamicPropertyType< TextFormatEnums.TextHorizontalAlignment > TextHorizontalAlignmentProperty
 Sets the horizontal alignment of the text.
 
DynamicPropertyType< String > TextProperty
 Sets the text content that the text node renders.
 
DynamicPropertyType< TextFormatEnums.TextVerticalAlignment > TextVerticalAlignmentProperty
 Sets the vertical alignment of the text.
 
DynamicPropertyType< TextFormatEnums.TruncationDirection > TruncationDirectionProperty
 Sets which part Kanzi truncates when either the Truncation or Overflow property is set and the text does not fit in this node:
 
DynamicPropertyType< TextFormatEnums.Truncation > TruncationProperty
 Sets how Kanzi truncates text when either Truncation or Overflow property is set and the text does not fit in this node:
 
DynamicPropertyType< Vector2 > VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of the Text node.
 

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 in a 3D text node.

◆ 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 does not fit in this node.

The default value is '...'. By default, Kanzi truncates the text at the end. Use the Truncation Direction property to set the part of the text that you want to truncate.

◆ 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<TextFormatEnums.TextHorizontalAlignment> TextHorizontalAlignmentProperty
Initial value:
=
new DynamicPropertyType<>(
"TextConcept.TextHorizontalAlignment", TextFormatEnums.TextHorizontalAlignment.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<TextFormatEnums.TextVerticalAlignment> TextVerticalAlignmentProperty
Initial value:
=
new DynamicPropertyType<>(
"TextConcept.TextVerticalAlignment", TextFormatEnums.TextVerticalAlignment.class)

Sets the vertical alignment of the text.

◆ TruncationDirectionProperty

DynamicPropertyType<TextFormatEnums.TruncationDirection> TruncationDirectionProperty
Initial value:
=
new DynamicPropertyType<>(
"TextConcept.TruncationDirection", TextFormatEnums.TruncationDirection.class)

Sets which part Kanzi truncates when either the Truncation or Overflow property is set and the text does not fit in this node:

  • Trailing truncates single- and multiline text at the end. Default value.
  • Center truncates single-line text in the middle. For multiline text, truncates entire lines from the middle, if the text does not fit in the height of this node, and clips text that does not fit in the width of this node.
  • Leading truncates single-line text in the beginning. For multiline text, truncates entire lines from the beginning, if the text does not fit in the height of this node, and clips text that does not fit in the width of this node.

◆ TruncationProperty

DynamicPropertyType<TextFormatEnums.Truncation> TruncationProperty
Initial value:
=
new DynamicPropertyType<>("TextConcept.Truncation", TextFormatEnums.Truncation.class)

Sets how Kanzi truncates text when either Truncation or Overflow property is set and the text does not fit in this node:

  • None disables text truncation.
  • At character truncates text character by character. Default value.
  • At word truncates text by entire words.

◆ 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.