Kanzi  3.9.2
Java API
TextBox3DMetadata Interface Reference

Metadata definitions for TextBox3D. More...

Inheritance diagram for TextBox3DMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBACompositionBackgroundColorProperty
 Sets the color that highlights the text that the user composes using an input method editor (IME). More...
 
DynamicPropertyType< ColorRGBACompositionFontColorProperty
 Sets the color of the text that the user composes using an input method editor (IME). More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextBox3D")
 Metaclass for TextBox3D.
 
DynamicPropertyType< ColorRGBASelectionBackgroundColorProperty
 Sets the color that highlights the selected text. More...
 
DynamicPropertyType< ColorRGBASelectionFontColorProperty
 Sets the color of the selected text. More...
 
- Public Attributes inherited from TextConceptMetadata
DynamicPropertyType< ColorRGBAFontColorProperty
 Sets the color of the text. More...
 
DynamicPropertyType< ResourceFontMaterialProperty
 Sets the material whose shader is used to render the text. More...
 
DynamicPropertyType< Vector2HorizontalPaddingProperty
 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< Vector2VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of the Text node. More...
 
- Public Attributes inherited from TextBoxConceptMetadata
AbstractMessageType BackspaceAtCursorMessage
 In a Text Box node deletes a character using backspace. More...
 
AbstractMessageType BackspaceWordAtCursorMessage
 In a Text Box node deletes the characters until the next word boundary using backspace. More...
 
AbstractMessageType CancelTextCompositionMessage
 Discards the text composed in an Input Method Editor. More...
 
DynamicPropertyType< Integer > CharacterCountProperty
 
AbstractMessageType ClearSelectionMessage
 In a Text Box node clears the current text selection. More...
 
AbstractMessageType CommitCompositionTextMessage
 Commits to a Text Box node the text composed in an Input Method Editor. More...
 
DynamicPropertyType< ResourceCompositionTextBackgroundBrushProperty
 Sets the brush that highlights the text that the user composes using an input method editor (IME). More...
 
AbstractMessageType CompositionTextChangedMessage
 Occurs when the text produced in an Input Method Editor is updated in a Text Box node. More...
 
AbstractMessageType CompositionTextCommittedMessage
 Occurs: More...
 
DynamicPropertyType< ResourceCompositionTextForegroundBrushProperty
 Sets the brush for the text that the user composes using an input method editor (IME). More...
 
DynamicPropertyType< String > CompositionTextProperty
 Reports the text that the user composes in the Text Box using an input method editor (IME). More...
 
AbstractMessageType CursorMovedMessage
 Occurs when the user moves the cursor in a Text Box node. More...
 
DynamicPropertyType< Integer > CursorPositionProperty
 Sets the position of the cursor in the text shown in the Text Box node. More...
 
DynamicPropertyType< ResourceCursorPrefabProperty
 Sets the prefab template that defines the appearance of the cursor instead of the default cursor. More...
 
AbstractMessageType DeleteAtCursorMessage
 In a Text Box node deletes a character using delete. More...
 
AbstractMessageType DeleteSelectionMessage
 In a Text Box node, erases any currently selected text. More...
 
AbstractMessageType DeleteTextMessage
 In a Text Box node, deletes the text between given start and end character indexes. More...
 
AbstractMessageType DeleteWordAtCursorMessage
 In a Text Box node deletes the characters until the next word boundary using delete. More...
 
DynamicPropertyType< String > DisplayTextProperty
 Reports the text that the Text Box displays. More...
 
DynamicPropertyType< Integer > EchoModeProperty
 Sets how the Text Box node shows text: More...
 
AbstractMessageType EditingFinishedMessage
 Occurs when a Text Box node leaves the editing state after the user modified the text content. More...
 
AbstractMessageType EditingStartedMessage
 Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state. More...
 
DynamicPropertyType< Integer > EditModeProperty
 Sets how the Text Box node enters the editing state: More...
 
AbstractMessageType EnteredEditingStateMessage
 Occurs when a Text Box node enters the editing state. More...
 
AbstractMessageType EnterEditingMessage
 Makes a Text Box node enter the editing state. More...
 
AbstractMessageType ExitEditingMessage
 Makes a Text Box node leave the editing state. More...
 
DynamicPropertyType< Boolean > HasSelectionProperty
 Indicates whether any of the text in the Text Box node is selected. More...
 
DynamicPropertyType< Boolean > HideTextHintWhenEditingProperty
 Sets whether to hide the placeholder content, which you set using the Text Hint Prefab property, when the Text Box node is in the editing state. More...
 
AbstractMessageType InputMethodActionMessage
 Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node. More...
 
DynamicPropertyType< Integer > InputMethodActionProperty
 Sets the label of the user action button on the on-screen keyboard for this Text Box. More...
 
AbstractMessageType InputMethodAvailableMessage
 Occurs when an input method becomes available to a Text Box node. More...
 
AbstractMessageType InputMethodUnavailableMessage
 Occurs when the input method that is composing text in a Text Box node becomes unavailable. More...
 
DynamicPropertyType< Integer > InputTypeProperty
 Sets the input type of the input methods that provide the input layout to let the user enter and edit text of specific type in the Text Box node: More...
 
AbstractMessageType InsertTextAtCursorMessage
 In a Text Box node adds text at the cursor position. More...
 
AbstractMessageType InsertTextMessage
 In a Text Box node, inserts text at a specified character index. More...
 
DynamicPropertyType< Boolean > IsComposingTextProperty
 Reports the text composition state of the Text Box node. More...
 
DynamicPropertyType< Boolean > IsEditingProperty
 Reports the editing state of the Text Box node. More...
 
AbstractMessageType LeftEditingStateMessage
 Occurs when a Text Box node leaves the editing state. More...
 
DynamicPropertyType< Integer > MaximumTextLengthProperty
 Sets the maximum length of text that the user can insert in the Text Box node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextBoxConcept")
 Metaclass for TextBoxConcept.
 
AbstractMessageType MoveCursorBackwardMessage
 In a Text Box node moves the cursor backward by one character. More...
 
AbstractMessageType MoveCursorForwardMessage
 In a Text Box node moves the cursor forward by one character. More...
 
AbstractMessageType MoveCursorHomeMessage
 In a Text Box node moves the cursor ahead of the first character of the text content. More...
 
AbstractMessageType MoveCursorToEndMessage
 In a Text Box node moves the cursor after the last character of the text content. More...
 
AbstractMessageType MoveCursorToNextWordMessage
 In a Text Box node moves the cursor forward to the next word boundary. More...
 
AbstractMessageType MoveCursorToPreviousWordMessage
 In a Text Box node moves the cursor backward to the previous word boundary. More...
 
AbstractMessageType MoveSelectionEndBackwardMessage
 In a Text Box node moves the handle at the end of text selection backward by one character. More...
 
AbstractMessageType MoveSelectionEndForwardMessage
 In a Text Box node moves the handle at the end of text selection forward by one character. More...
 
AbstractMessageType MoveSelectionEndToNextWordMessage
 In a Text Box node moves the handle at the end of text selection forward to the start of the next word. More...
 
AbstractMessageType MoveSelectionEndToPreviousWordMessage
 In a Text Box node moves the handle at the end of text selection backward to the start of the previous word. More...
 
AbstractMessageType MoveSelectionStartBackwardMessage
 In a Text Box node moves the handle at the beginning of text selection backward by one character. More...
 
AbstractMessageType MoveSelectionStartForwardMessage
 In a Text Box node moves the handle at the beginning of text selection forward by one character. More...
 
AbstractMessageType MoveSelectionStartToNextWordMessage
 In a Text Box node moves the handle at the beginning of text selection forward to the start of the next word. More...
 
AbstractMessageType MoveSelectionStartToPreviousWordMessage
 In a Text Box node moves the handle at the beginning of text selection backward to the start of the previous word. More...
 
DynamicPropertyType< Integer > PasswordEchoTimeoutProperty
 Sets the time in milliseconds that an inserted character is visible before being masked when using the password echo mode. More...
 
DynamicPropertyType< String > PasswordMaskingCharacterProperty
 Sets the character that masks each character that the application user enters when using the password echo mode. More...
 
DynamicPropertyType< Boolean > ReadOnlyProperty
 Sets whether the Text Box node is editable. More...
 
AbstractMessageType SelectAllMessage
 In a Text Box node selects all text. More...
 
DynamicPropertyType< ResourceSelectionBackgroundBrushProperty
 Sets the brush that highlights the selected text. More...
 
AbstractMessageType SelectionChangedMessage
 Occurs when the user changes the text selection in a Text Box node. More...
 
AbstractMessageType SelectionClearedMessage
 Occurs when the user clears or resets the text selection in a Text Box node. More...
 
DynamicPropertyType< Integer > SelectionEndCursorPositionProperty
 The position of the cursor that marks the end of text selection in the Text Box node. More...
 
DynamicPropertyType< ResourceSelectionEndPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the end of text selection instead of the default handle. More...
 
DynamicPropertyType< ResourceSelectionForegroundBrushProperty
 Sets the brush for the selected text. More...
 
DynamicPropertyType< Integer > SelectionStartCursorPositionProperty
 The position of the cursor that marks the beginning of text selection in the Text Box node. More...
 
AbstractMessageType SelectionStartedMessage
 Occurs when the user starts selecting text in a Text Box node. More...
 
DynamicPropertyType< ResourceSelectionStartPrefabProperty
 Sets the prefab template that defines the appearance of the selection handle at the beginning of text selection instead of the default handle. More...
 
AbstractMessageType SelectTextMessage
 In a Text Box node, selects the text between given start and end character indexes. More...
 
AbstractMessageType SelectToEndMessage
 In a Text Box node selects the text from the cursor position to the end of the text. More...
 
AbstractMessageType SelectToHomeMessage
 In a Text Box node selects the text from the start of the text to the cursor position. More...
 
AbstractMessageType SelectWordAtCursorMessage
 In a Text Box node selects the word at the cursor position. More...
 
AbstractMessageType TextChangedMessage
 Occurs when the user changes the text in a Text Box node. More...
 
AbstractMessageType TextCompositionCanceledMessage
 Occurs: More...
 
DynamicPropertyType< ResourceTextHintPrefabProperty
 Sets the prefab template for showing placeholder content when the Text Box node is empty. More...
 
DynamicPropertyType< Integer > TextKeyNavigationDirectionProperty
 Sets the text key navigation direction. More...
 
DynamicPropertyType< Integer > WordCountProperty
 
- Public Attributes inherited from FontStyleConceptMetadata
DynamicPropertyType< Float > CharacterSpacingProperty
 Sets the character spacing in pixels. More...
 
DynamicPropertyType< Float > FixedCharacterWidthProperty
 When set, overrides the font advance widths to make each character take a fixed amount of space specified in pixels. More...
 
DynamicPropertyType< Integer > FontHintingPreferenceProperty
 Sets the hinting preference of the font. More...
 
DynamicPropertyType< Boolean > FractionalCharacterWidthProperty
 Sets whether Kanzi uses fractional or rounded character widths to lay out text. More...
 
DynamicPropertyType< Float > LineSpacingProperty
 Sets the line spacing in multiples of the normal line height of the selected FontStyleConcept. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.FontStyleConcept")
 Metaclass for FontStyleConcept.
 
DynamicPropertyType< Float > SizeProperty
 Sets the size of the font in pixels. More...
 
DynamicPropertyType< Boolean > SnapCharacterToPixelPropertyProperty
 Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: More...
 
DynamicPropertyType< Integer > StyleProperty
 Sets the style of the FontStyleConcept. More...
 
DynamicPropertyType< Integer > WeightProperty
 Sets the weight of the FontStyleConcept. More...
 

Detailed Description

Metadata definitions for TextBox3D.

Member Data Documentation

◆ CompositionBackgroundColorProperty

DynamicPropertyType<ColorRGBA> CompositionBackgroundColorProperty
Initial value:
=
new DynamicPropertyType<>("TextBox3D.CompositionBackgroundColor", ColorRGBA.class)

Sets the color that highlights the text that the user composes using an input method editor (IME).

◆ CompositionFontColorProperty

DynamicPropertyType<ColorRGBA> CompositionFontColorProperty
Initial value:
=
new DynamicPropertyType<>("TextBox3D.CompositionFontColor", ColorRGBA.class)

Sets the color of the text that the user composes using an input method editor (IME).

◆ SelectionBackgroundColorProperty

DynamicPropertyType<ColorRGBA> SelectionBackgroundColorProperty
Initial value:
=
new DynamicPropertyType<>("TextBox3D.SelectionBackgroundColor", ColorRGBA.class)

Sets the color that highlights the selected text.

◆ SelectionFontColorProperty

DynamicPropertyType<ColorRGBA> SelectionFontColorProperty
Initial value:
=
new DynamicPropertyType<>("TextBox3D.SelectionFontColor", ColorRGBA.class)

Sets the color of the selected text.